AccessPort.idl

#ifndef __RADM_ACCESS_PORT_IDL__
#define __RADM_ACCESS_PORT_IDL__
 
#include <Event.idl>
#include <OutletPort.idl>
#include <UserEvent.idl>
 
module radm {
 
    interface AccessPort extends BasePort {
        constant int ERR_PDU_NOT_ACTIVE = 10;
 
        enumeration Availability {
            AVAILABLE,      ///< The port is idle
            OCCUPIED,       ///< The port is used, but accepts additional connections
            BUSY,           ///< The port is used and reached the maximum connection limit
            UNAVAILABLE,    ///< The port is not ready for being connected
            INACCESSIBLE    ///< The port is not allowed to be connected
        };
 
        enumeration State {
            INACTIVE,   ///< The port is inactive and can not be connected to
            ACTIVE      ///< The port is active and can be connected to
        };
 
        structure Status {
            State state;                ///< Port state
            Availability availability;  ///< Port availability
        };
 
        /**
         * Get port status
         *
         * @return Port status
         */
        Status getStatus();
 
        /**
         * Get associated outlet ports
         *
         * @return List of associated outlet instances
         */
        vector<OutletPort> getAssociatedOutletPorts();
 
        /**
         * Set associated outlet ports
         *
         * @param associations New list of associated outlets (must be unique, and at most 4 outlets are supported)
         *
         * @return 0 on success
         * @return 1 if any of the outlet references is invalid
         */
        int setAssociatedOutletPorts(in vector<OutletPort> associations);
 
        /**
         * Execute power operation on associated outlet ports
         *
         * @param op Operation to execute
         *
         * @return 0 on success
         * @return 10 if any outlet port is not ready
         */
        int doPowerOperation(in PowerOperation op);
 
        /** Event: The port status have changed */
        valueobject StatusChangedEvent extends idl.Event {
            Status oldStatus;   ///< Status before change
            Status newStatus;   ///< Status after change
        };
 
        /** Event: The outlet association has changed */
        valueobject AssociatedOutletsChangedEvent extends event.UserEvent {
            vector<OutletPort> oldAssociatedOutlets;    ///< Associated outlets before change
            vector<OutletPort> newAssociatedOutlets;    ///< Associated outlets after change
        };
    };
}
 
#endif //__RADM_ACCESS_PORT_IDL__