Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages


Classes

interface  ACS::OffShoot
interface  ACS::ACSComponent
interface  ACS::PingableResource
interface  ACS::acsRefGen
exception  ACS::NoSuchCharacteristic
interface  ACS::CharacteristicModel
interface  ACS::Property
struct  ACS::PropertyDesc
struct  ACS::CBDescIn
struct  ACS::CBDescOut
interface  ACS::Callback
interface  ACS::Subscription
interface  ACS::Monitor
interface  ACS::Monitordouble
interface  ACS::Monitorfloat
interface  ACS::Monitorpattern
interface  ACS::Monitorstring
interface  ACS::MonitorstringSeq
interface  ACS::Monitorlong
interface  ACS::MonitorlongLong
interface  ACS::MonitoruLongLong
interface  ACS::TypelessProperty
struct  ACS::CharacteristicComponentDesc
interface  ACS::CharacteristicComponent
interface  ACS::CBvoid
interface  ACS::CBpattern
interface  ACS::CBdouble
interface  ACS::CBfloat
interface  ACS::CBstring
interface  ACS::CBstringSeq
interface  ACS::CBlong
interface  ACS::CBlongLong
interface  ACS::CBuLongLong
interface  ACS::CBdoubleSeq
interface  ACS::CBfloatSeq
interface  ACS::CBlongSeq
interface  ACS::Alarmpattern
interface  ACS::Alarmdouble
interface  ACS::Alarmfloat
interface  ACS::Alarmlong
interface  ACS::Alarmstring
interface  ACS::AlarmstringSeq
interface  ACS::Pdouble
interface  ACS::Pfloat
interface  ACS::Plong
interface  ACS::Ppattern
interface  ACS::Pstring
interface  ACS::PstringSeq
interface  ACS::PdoubleSeq
interface  ACS::PfloatSeq
interface  ACS::PlongSeq
interface  ACS::ROdouble
interface  ACS::RWdouble
interface  ACS::ROfloat
interface  ACS::RWfloat
interface  ACS::ROpattern
interface  ACS::RWpattern
interface  ACS::RWstring
interface  ACS::ROstring
interface  ACS::ROstringSeq
interface  ACS::ROdoubleSeq
interface  ACS::RWdoubleSeq
interface  ACS::ROfloatSeq
interface  ACS::RWfloatSeq
interface  ACS::ROlongSeq
interface  ACS::RWlongSeq
interface  ACS::ROlong
interface  ACS::RWlong
interface  ACS::PlongLong
interface  ACS::AlarmlongLong
interface  ACS::ROlongLong
interface  ACS::RWlongLong
interface  ACS::PuLongLong
interface  ACS::AlarmuLongLong
interface  ACS::ROuLongLong
interface  ACS::RWuLongLong
interface  ACS::MasterComponentReadOnly
interface  ACS::MasterComponent
interface  ACS::SpecialTestMasterComponent
interface  ACS::CharacteristicTask
interface  ACS::TaskComponent

Typedefs

typedef unsigned long long Time
typedef long long TimeInterval
typedef unsigned long long pattern
typedef long long longLong
typedef unsigned long long uLongLong
typedef sequence< string > stringSeq
typedef sequence< TimeTimeSeq
typedef sequence< TimeIntervalTimeIntervalSeq
typedef sequence< ConditionConditionSeq
typedef sequence< patternpatternSeq
typedef sequence< double > doubleSeq
typedef sequence< float > floatSeq
typedef sequence< long > longSeq
typedef sequence< doubleSeqdoubleSeqSeq
typedef sequence< floatSeqfloatSeqSeq
typedef sequence< longSeqlongSeqSeq
typedef sequence< stringSeqstringSeqSeq
typedef sequence< longLonglongLongSeq
typedef sequence< uLongLonguLongLongSeq
typedef unsigned long Tag
typedef sequence< PropertyDescPropertyDescSeq
typedef string StateName
typedef string ModeName
typedef sequence< string > StringSequence

Enumerations

enum  ComponentStates {
  COMPSTATE_NEW, COMPSTATE_INITIALIZING, COMPSTATE_INITIALIZED, COMPSTATE_OPERATIONAL,
  COMPSTATE_ERROR, COMPSTATE_DESTROYING, COMPSTATE_ABORTING, COMPSTATE_DEFUNCT,
  COMPSTATE_UNKNOWN
}
enum  Condition { RED, YELLOW, GREEN, GREY }
enum  Bool { acsFALSE, acsTRUE }
enum  OnOffSwitch { acsOn, acsOff }

Functions

 ACS_ENUM (Bool)
 ACS_ENUM (OnOffSwitch)

Variables

const StateName SUBSYSSTATE_AVAILABLE = "AVAILABLE"
const StateName SUBSYSSTATE_OFFLINE = "OFFLINE"
const StateName SUBSYSSTATE_ONLINE = "ONLINE"
const StateName SUBSYSSTATE_OPERATIONAL = "OPERATIONAL"
const StateName SUBSYSSTATE_ERROR = "ERROR"
const StateName SUBSYSSTATE_SHUTDOWN = "SHUTDOWN"
const StateName SUBSYSSTATE_INITIALIZING_PASS1 = "INITIALIZING_PASS1"
const StateName SUBSYSSTATE_PREINITIALIZED = "PREINITIALIZED"
const StateName SUBSYSSTATE_INITIALIZING_PASS2 = "INITIALIZING_PASS2"
const StateName SUBSYSSTATE_REINITIALIZING = "REINITIALIZING"
const StateName SUBSYSSTATE_SHUTTINGDOWN_PASS1 = "SHUTTINGDOWN_PASS1"
const StateName SUBSYSSTATE_PRESHUTDOWN = "PRESHUTDOWN"
const StateName SUBSYSSTATE_SHUTTINGDOWN_PASS2 = "SHUTTINGDOWN_PASS2"
const ModeName SUBSYSMODE_SIMULATION = "SIMULATION"
const ModeName SUBSYSMODE_STANDALONE = "STANDALONE"
const ModeName SUBSYSMODE_DEGRADED = "DEGRADED"


Detailed Description

The following used to be defined in baciidl. Because access to these typedefs is needed in modules built earilier than acserr (baciidl is dependent upon this module), they have been moved here.


Typedef Documentation

typedef sequence<Condition> ACS::ConditionSeq
 

A sequence of Condition. See stringSeq for more on sequences.

typedef sequence<double> ACS::doubleSeq
 

A sequence of double. See stringSeq for more on sequences.

typedef sequence<doubleSeq> ACS::doubleSeqSeq
 

Sequences of doubleSeq, following the same naming pattern as simple sequences.

typedef sequence<float> ACS::floatSeq
 

A sequence of float. See stringSeq for more on sequences.

typedef sequence<floatSeq> ACS::floatSeqSeq
 

Sequences of floatSeq, following the same naming pattern as simple sequences.

typedef long long ACS::longLong
 

A 64-bit signed integer

typedef sequence<longLong> ACS::longLongSeq
 

A sequence of longLong. See stringSeq for more on sequences.

typedef sequence<long> ACS::longSeq
 

A sequence of long. See stringSeq for more on sequences.

typedef sequence<longSeq> ACS::longSeqSeq
 

Sequences of longSeq, following the same naming pattern as simple sequences.

typedef string ACS::ModeName
 

typedef unsigned long long ACS::pattern
 

A 64-bit long used as a pattern of 64 bits.

typedef sequence<pattern> ACS::patternSeq
 

A sequence of pattern. See stringSeq for more on sequences.

typedef sequence<PropertyDesc> ACS::PropertyDescSeq
 

A sequence of PropertyDescSeq. See stringSeq for more on sequences.

typedef string ACS::StateName
 

typedef sequence<string> ACS::stringSeq
 

Sequences are used extensively with components that deal with multiple devices (groups) or properties, which manage a value of sequence type. Sequences defined by BACI are also used to optimize the number of network calls needed to query a remote object. The naming pattern is always <type>Seq.

typedef sequence<stringSeq> ACS::stringSeqSeq
 

Sequences of stringSeq, following the same naming pattern as simple sequences.

typedef sequence<string> ACS::StringSequence
 

typedef unsigned long ACS::Tag
 

A Tag type that allows the client to tag and later identify Callbacks through the DescIn and DescOut structures. Through both structures, the client programmer can exchange the id_tag parameter with the server to uniquely tag the remote call. The only interaction the control system has with the id_tag is that it passes it unchanged from CBDescIn to CBDescOut.

typedef unsigned long long ACS::Time
 

Time - absolute time in 100 ns since 1582-10-15 00:00:00 see OMG Time Service Specification, ftp://ftp.omg.org/pub/docs/formal/97-12-21.pdf. Currently, Time is handled as longlong.

typedef long long ACS::TimeInterval
 

TimeInterval - difference between two absolute time points.

typedef sequence<TimeInterval> ACS::TimeIntervalSeq
 

A sequence of TimeInterval. See stringSeq for more on sequences.

typedef sequence<Time> ACS::TimeSeq
 

A sequence of Time. See stringSeq for more on sequences.

typedef unsigned long long ACS::uLongLong
 

A 64-bit unsigned integer

typedef sequence<uLongLong> ACS::uLongLongSeq
 

A sequence of uLongLong. See stringSeq for more on sequences.


Enumeration Type Documentation

enum Bool
 

Enumeration values:
acsFALSE 
acsTRUE 

enum ComponentStates
 

Component state enumeration. Component starts it's lifecycle in state NEW. During objects life it cycles though following states in prescribed order, possibly skipping the nasty ones:

  • COMPSTATE_NEW
  • COMPSTATE_INITIALIZING
  • COMPSTATE_INITIALIZED
  • COMPSTATE_OPERATIONAL
  • COMPSTATE_ERROR
  • COMPSTATE_DESTROYING
  • COMPSTATE_ABORTING
  • COMPSTATE_DEFUNCT

Object lifecycle can be aborted anytime, abort sequence prescribes next order.

  • COMPSTATE_ABORTING
  • COMPSTATE_DEFUNCT

The COMPSTATE_UNKNOWN signals an abnormal situation, or a situation where it is not possible to read/retrieve the state

There also exists an error state:

  • COMPSTATE_ERROR

Note: recycable objects are allowed to be initialized again after COMPSTATE_DESTROYING or COMPSTATE_ERROR states.

Enumeration values:
COMPSTATE_NEW 
COMPSTATE_INITIALIZING 
COMPSTATE_INITIALIZED 
COMPSTATE_OPERATIONAL 
COMPSTATE_ERROR 
COMPSTATE_DESTROYING 
COMPSTATE_ABORTING 
COMPSTATE_DEFUNCT 
COMPSTATE_UNKNOWN 

enum Condition
 

Possible state conditions of a physical device. The names correspond to colours of typical LEDs.

Enumeration values:
RED  RED implies the physical device is in an error state.
YELLOW  YELLOW implies the physical device is in a caution state.
GREEN  RED implies the physical device is in an OK state.
GREY  RED implies the physical device is turned off.

enum OnOffSwitch
 

Enumeration values:
acsOn 
acsOff 


Function Documentation

ACS_ENUM OnOffSwitch   ) 
 

ACS_ENUM Bool   ) 
 


Variable Documentation

const ModeName ACS::SUBSYSMODE_DEGRADED = "DEGRADED"
 

const ModeName ACS::SUBSYSMODE_SIMULATION = "SIMULATION"
 

const ModeName ACS::SUBSYSMODE_STANDALONE = "STANDALONE"
 

const StateName ACS::SUBSYSSTATE_AVAILABLE = "AVAILABLE"
 

const StateName ACS::SUBSYSSTATE_ERROR = "ERROR"
 

const StateName ACS::SUBSYSSTATE_INITIALIZING_PASS1 = "INITIALIZING_PASS1"
 

const StateName ACS::SUBSYSSTATE_INITIALIZING_PASS2 = "INITIALIZING_PASS2"
 

const StateName ACS::SUBSYSSTATE_OFFLINE = "OFFLINE"
 

const StateName ACS::SUBSYSSTATE_ONLINE = "ONLINE"
 

const StateName ACS::SUBSYSSTATE_OPERATIONAL = "OPERATIONAL"
 

const StateName ACS::SUBSYSSTATE_PREINITIALIZED = "PREINITIALIZED"
 

const StateName ACS::SUBSYSSTATE_PRESHUTDOWN = "PRESHUTDOWN"
 

const StateName ACS::SUBSYSSTATE_REINITIALIZING = "REINITIALIZING"
 

const StateName ACS::SUBSYSSTATE_SHUTDOWN = "SHUTDOWN"
 

const StateName ACS::SUBSYSSTATE_SHUTTINGDOWN_PASS1 = "SHUTTINGDOWN_PASS1"
 

const StateName ACS::SUBSYSSTATE_SHUTTINGDOWN_PASS2 = "SHUTTINGDOWN_PASS2"
 


Generated on Thu Apr 30 02:27:10 2009 for ACS IDL interfaces by doxygen 1.3.8