FaultControl.idl

Go to the documentation of this file.

#ifndef CARMA_FAULT_FAULTCONTROL_IDL
#define CARMA_FAULT_FAULTCONTROL_IDL


#include "carma/util/UserException.idl"

module carma {
module fault {

enum EffectPreference {
    // No action taken
    //
    // Data is written to the dataset without any indication of error.
    PREF_NONE,

    // This frame of data is not included in the dataset. The integration
    // time time is reduced appropriately. The appropriate MIRIAD error
    // indication bit is set.
    PREF_BLANK,

    // This frame of data is included in the dataset. The integration
    // time is not reduced. The appropriate MIRIAD error indication bit
    // is set.
    PREF_FLAG
};

const string FAULT_CONTROL_NAME = "carma.faultControl";


typedef sequence< string > SeqString;  


interface FaultControl {

    void setNoiseState( in unsigned short inSubarrayNumber, in boolean inStateIsOn )
        raises ( carma::util::UserException );

    void setDriveErrorPreference( in unsigned short inSubarrayNumber, in EffectPreference inEffect )
        raises ( carma::util::UserException );

    // @brief Set the subarray monitor data error preference
    void setMonitorErrorPreference( in unsigned short inSubarrayNumber, in EffectPreference inEffect )
        raises ( carma::util::UserException );

    // @brief Set the subarray antenna offline error preference
    void setOfflineErrorPreference( in unsigned short inSubarrayNumber, in EffectPreference inEffect )
        raises ( carma::util::UserException );

    // @brief Set the subarray receiver phaselock error preference
    void setPhaselockErrorPreference( in unsigned short inSubarrayNumber, in EffectPreference inEffect )
        raises ( carma::util::UserException );

    void disableAlarms( in SeqString inMonitorPointNames )
        raises ( carma::util::UserException );

    void restoreAlarms( in SeqString inMonitorPointNames )
        raises ( carma::util::UserException );

    void setAlarmEnable( in unsigned short inSubarrayNumber, in boolean inStateIsOn )
        raises ( carma::util::UserException );

    void setAlarmDeadmanSecs( in short inAlarmDeadmanSecs )
        raises ( carma::util::UserException );
};


};  // end carma::control
};  // end carma

#endif