AssetStrip.idl

#ifndef __ASSETMGRMODEL_ASSETSTRIP_IDL__
#define __ASSETMGRMODEL_ASSETSTRIP_IDL__

#include <AssetStripConfig.idl>
#include <UserEvent.idl>

module assetmgrmodel {
    interface AssetStrip_2_0_5 {

        constant int NO_ERROR                   = 0; 
        constant int ERR_INVALID_PARAM          = 1; 
        constant int ERR_NO_SUCH_OBJECT         = 2; 
        constant int ERR_NOT_SUPPORTED          = 3; 
        constant int ERR_OPERATION_FAILED       = 4; 

        constant int MAIN_STRIP_COLUMN          = 0;

        enumeration State {
            DISCONNECTED,       
            FIRMWARE_UPDATE,    
            UNSUPPORTED,        
            AVAILABLE           
        };

        enumeration StripType {
            SIMPLE,             
            COMPOSITE           
        };

        enumeration TagType {
            SINGLE,             
            EXTENSION,          
            NONE                
        };

        enumeration CascadeState {
            CASCADE_ACTIVE,         
            CASCADE_FIRMWARE_UPDATE 
        };

        structure DeviceInfo {
            int deviceId;                       
            int hardwareId;                     
            int protocolVersion;                
            int bootVersion;                    
            int appVersion;                     
            boolean orientationSensAvailable;   
            boolean isCascadable;               
            boolean rackUnitCountConfigurable;  
        };

        structure StripInfo {
            int maxMainTagCount;        
            int maxBladeTagCount;       
            int mainTagCount;           
            int bladeTagCount;          
            boolean bladeOverflow;      
            int rackUnitCount;          
            int componentCount;         
            CascadeState cascadeState;  
        };
        
        structure TagInfo {
            int rackUnitNumber;    
            int slotNumber;        
            string familyDesc;     
            string rawId;          
            boolean programmable;  
        };
        
        structure RackUnitInfo {
            int rackUnitNumber;         
            int rackUnitPosition;       
            TagType type;               
            int size;                   
            AssetStripConfig_1_0_1.RackUnitSettings settings;   
            int assetStripCascadePosition;        
            int rackUnitRelativePosition;         
            int assetStripNumberOfRackUnits;      
        };

        valueobject StripInfoChangedEvent extends idl.Event {
            StripInfo oldInfo;                                  
            StripInfo newInfo;                                  
        };

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

        valueobject RackUnitChangedEvent extends event.UserEvent {
            int rackUnitNumber;                                 
            RackUnitInfo rackUnit;                              
        };

        structure TagChangeInfo {
            TagInfo tag;                                        
            RackUnitInfo info;                                  
            string parentBladeTagId;                            
            int slotPosition;                                   
        };

        valueobject TagEvent extends idl.Event {
            vector<TagChangeInfo> tags;                         
            vector<TagInfo> allTags;                            
        };

        valueobject TagAddedEvent extends TagEvent { };
        valueobject TagRemovedEvent extends TagEvent { };

        enumeration FirmwareUpdateState {
            UPDATE_STARTED,                                     
            UPDATE_SUCCESSFUL,                                  
            UPDATE_FAILED                                       
        };

        valueobject FirmwareUpdateStateChangedEvent extends idl.Event {
            FirmwareUpdateState state;                          
        };

        valueobject BladeOverflowChangedEvent extends idl.Event {
            boolean overflow;                                   
        };

        valueobject OrientationChangedEvent extends idl.Event {
            AssetStripConfig_1_0_1.Orientation oldOrientation;  
            AssetStripConfig_1_0_1.Orientation newOrientation;  
        };

        valueobject CompositionChangedEvent extends idl.Event {
            int oldComponentCount;                              
            int newComponentCount;                              
        };

        State getState();

        DeviceInfo getDeviceInfo();

        StripInfo getStripInfo();

        int getRackUnitInfo(in int rackUnitNumber, out RackUnitInfo info);

        vector<RackUnitInfo> getAllRackUnitInfos();

        int getTag(in int rackUnitNumber, in int slotNumber, out TagInfo tagInfo);

        vector<TagInfo> getAllTags();

        vector<TagInfo> getMainTags();

        int getExtensionTags(in int rackUnitNumber, out vector<TagInfo> tags);

        void triggerPowercycle(in boolean hard);

        int programTagIDs(in vector<TagInfo> tagInfos);

        FirmwareUpdateState getFirmwareUpdateState();
    };
}

#endif /* __ASSETMGRMODEL_ASSETSTRIP_IDL__ */