PowerSupply.idl

#ifndef __RADM_POWERSUPPLY_IDL__
#define __RADM_POWERSUPPLY_IDL__
 
#include <Event.idl>
#include <UserEvent.idl>
 
module radm {
 
    interface PowerSupply {
 
        constant int ERR_AUTODETECT_NOT_SUPPORTED = 1; ///< Auto-detecion is not supported.
 
        structure MetaData {
            string label;               ///< Power Supply label
            int idx;                    ///< Power Supply Index
            boolean hasAutoDetection;   ///< If support auto-detection of Power Supply state.
        };
 
        structure Settings {
            boolean autoDetectEnabled;  ///< Enable or disable auto-detection
        };
 
        [unknown_fallback("UNKNOWN")]
        enumeration Status {
            UNKNOWN,
            NO_POWER,
            POWERED
        };
 
        /**
         * Retrieve the Power Supply's metadata.
         *
         * @return Power Supply's metadata
         */
        MetaData getMetaData();
 
        /**
         * Retrieve Power Supply status.
         *
         * @return Power Supply status
         */
        Status getStatus();
 
        /**
         * Retrieve the Power Supply settings.
         *
         * @return Settings for Power Supply
         */
        Settings getSettings();
 
        /**
         * Update Power Supply settings.
         * 
         * @param settings  New settings
         *
         * @return 0 if OK
         * @return non-zero in case of error (see error constants above)
         */
        int setSettings(in Settings settings);
 
        /** Event: PowerSupply status has changed */
        valueobject StatusChangedEvent extends idl.Event {
            Status oldStatus;       ///< Power Supply status before change
            Status newStatus;       ///< Power Supply status after change
        };
 
        /** Event: Power Supply settings has changed */
        valueobject SettingsChangedEvent extends event.UserEvent {
            Settings oldSettings;   ///< Power Supply settings before change
            Settings newSettings;   ///< Power Supply settings after change
        };
    };
}
 
#endif //__RADM_POWERSUPPLY_IDL__