LoadControl.h

Go to the documentation of this file.

#ifndef LOADCONTROL_H_
#define LOADCONTROL_H_

#include "data/Slate.h"
#include "io/DeviceIOStream.h"

class Component;

class LoadControl
{
public:
    LoadControl( const ConfigURI& loadControlCfg, bool useHardware, Logger& logger, Component* component );

    virtual ~LoadControl();

    bool powerUp();

    bool powerDown();

    bool isolateLoad();

    bool deisolateLoad();

    bool discreteOn();

    bool discreteOff();

    void requestVoltageAndCurrent();

    void requestFaults();

    void readFaults();

    /*
        //      MSB
        7: 1 (end-of-transmission indicator)
        6: spare
        5: spare
        4: Current Limiter Activated (1 if true)
        3: Software overcurrent detection (1 if true)
        2: Load power shutoff due to current limiter (1 if shutoff)
        1: Invalid command error (1 if error)
        0: WDT reset (1 if reset)
        LSB
    */
    typedef enum { OK = 0,
                   WDT_RESET = 0x01,
                   INVALID_CMD = 0x02,
                   HW_OVERCURRENT_SHUTDOWN = 0x04,
                   SW_OVERCURRENT_WARNING = 0x08,
                   CL_ACTIVATED = 0x10
                 } LCBError;

    enum PowerState       // Correspondence to Component...
    {
        POWER_UNKNOWN,
        POWER_UP,         // ::STARTING & maybe ::RESETTING
        ON,               // ::RUNNABLE
        POWER_DOWN_READY, // ?
        POWER_DOWN,       // ::PAUSING & ::SHUTTING_DOWN & maybe ::RESETTING
        OFF,              // ::SHUTDOWN & maybe PAUSED
    };

    typedef enum
    {
        REQUESTVOLTAGE, // Send request
        PARSEVOLTAGE,   // Read response
        REQUESTCURRENT, // Send request
        PARSECURRENT,   // Read response
        DONE,           // Ready to run
    } LCBData;

    PowerState getPowerState()
    {
        return powerState_;
    }


    bool setPowerStateOn()
    {
        if( powerState_ == POWER_UP )
        {
            powerState_ = ON;
            return true;
        }
        else
            return false;
    }


    bool setPowerStateOff()
    {
        if( powerState_ == POWER_DOWN )
        {
            powerState_ = OFF;
            return true;
        }
        else
        {
            return false;
        }
    }

    bool hasError()
    {
        if( errorStatus_ & 0x1F )
        {
            return true;
        }
        else
        {
            return false;
        }
    }

    Str errorString();

private:
    // Note that the copy constructor below is private and not given a body.
    // Any attempt to call it will return a compiler error.
    LoadControl( const LoadControl& old ); // disallow copy constructor};

    void initialize();

    unsigned short extractCount( char * convertCount, int pos );

    LCBData dataState_;

    DeviceIOStream io_;

    PowerState powerState_;

    bool initialized_;

    Timespan requestTimeout_;
    Timestamp startTime_;

    // The errors reported by the LCB
    int errorStatus_;

    Component* component_;



};

#endif /* LOADCONTROL_H_ */