Outlet.idl

#ifndef __PDUMODEL_OUTLET_IDL__
#define __PDUMODEL_OUTLET_IDL__

#include <Nameplate.idl>
#include <NumericSensor.idl>
#include <StateSensor.idl>
#include <Pole.idl>
#include <Inlet.idl>
#include <OverCurrentProtector.idl>
#include <Controller.idl>

module pdumodel {

    structure OutletStatistic {
        int relayCycleCnt;                      
        int relayFailCnt;                       
    };

    interface Outlet_2_1_1 extends EDevice {

        constant int ERR_OUTLET_NOT_SWITCHABLE = 1; 
        constant int ERR_LOAD_SHEDDING_ACTIVE  = 2; 
        constant int ERR_OUTLET_DISABLED       = 3; 
        constant int ERR_OUTLET_NOT_OFF        = 4; 
        
        constant int ERR_INVALID_PARAM         = 1; 
        
        structure MetaData {
            string label;                       
            string receptacleType;              
            Nameplate namePlate;                
            Rating rating;                      
            boolean isSwitchable;               
            boolean isLatching;                 
            int maxRelayCycleCnt;               
        };

        enumeration PowerState {
            PS_OFF,                             
            PS_ON                               
        };

        structure LedState {
            boolean red;                        
            boolean green;                      
            boolean blinking;                   
        };

        structure State {
            boolean available;                  
            PowerState powerState;              
            boolean switchOnInProgress;         
            boolean cycleInProgress;            
            boolean isLoadShed;                 
            LedState ledState;                  
            time lastPowerStateChange;          
        };

        enumeration StartupState {
            SS_ON,                              
            SS_OFF,                             
            SS_LASTKNOWN,                       
            SS_PDUDEF                           
        };
 
        structure Settings {
            string name;                        
            StartupState startupState;          
            boolean usePduCycleDelay;           
            int cycleDelay;                     
            boolean nonCritical;                
            int sequenceDelay;                  
        };

        structure Sensors {
            sensors.NumericSensor_4_0_2 voltage;                
            sensors.NumericSensor_4_0_2 current;                
            sensors.NumericSensor_4_0_2 peakCurrent;            
            sensors.NumericSensor_4_0_2 maximumCurrent; 
            sensors.NumericSensor_4_0_2 unbalancedCurrent;      
            sensors.NumericSensor_4_0_2 activePower;            
            sensors.NumericSensor_4_0_2 reactivePower;          
            sensors.NumericSensor_4_0_2 apparentPower;  
            sensors.NumericSensor_4_0_2 powerFactor;            
            sensors.NumericSensor_4_0_2 displacementPowerFactor;
            sensors.NumericSensor_4_0_2 activeEnergy;           
            sensors.NumericSensor_4_0_2 apparentEnergy; 
            sensors.NumericSensor_4_0_2 phaseAngle;     
            sensors.NumericSensor_4_0_2 lineFrequency;  
            sensors.StateSensor_4_0_2   outletState;            
        };

        valueobject PowerControlEvent extends event.UserEvent {
            PowerState state;                   
            boolean cycle;                      
        };

        valueobject StateChangedEvent extends idl.Event {
            State oldState;                     
            State newState;                     
        };

        valueobject SettingsChangedEvent extends event.UserEvent {
            Settings oldSettings;               
            Settings newSettings;               
        };

        MetaData getMetaData();

        Sensors getSensors();

        State getState();
        
        int setPowerState(in PowerState pstate);

        int cyclePowerState();

        Settings getSettings();

        int setSettings(in Settings settings);

        void getIOP(out Inlet_2_0_1 i, out OverCurrentProtector_3_0_1 o, out vector<Pole_4_0_1> p);

        Controller_4_0_0 getController();

        int unstick();
    };

}

#endif