Classes
interface	OffShoot
interface	ACSComponent
interface	PingableResource
exception	NoSuchCharacteristic
interface	CharacteristicModel
interface	Property
struct	PropertyDesc
struct	CBDescIn
struct	CBDescOut
interface	Callback
interface	Subscription
interface	Monitor
interface	Monitordouble
interface	Monitorfloat
interface	Monitorpattern
interface	Monitorstring
interface	MonitorstringSeq
interface	Monitorlong
interface	MonitorlongLong
interface	MonitoruLongLong
interface	TypelessProperty
struct	CharacteristicComponentDesc
interface	CharacteristicComponent
interface	CBvoid
interface	CBpattern
interface	CBdouble
interface	CBfloat
interface	CBstring
interface	CBstringSeq
interface	CBlong
interface	CBlongLong
interface	CBuLongLong
interface	CBdoubleSeq
interface	CBfloatSeq
interface	CBlongSeq
interface	Alarmpattern
interface	Alarmdouble
interface	Alarmfloat
interface	Alarmlong
interface	Alarmstring
interface	AlarmstringSeq
interface	Pdouble
interface	Pfloat
interface	Plong
interface	Ppattern
interface	Pstring
interface	PstringSeq
interface	PdoubleSeq
interface	PfloatSeq
interface	PlongSeq
interface	ROdouble
interface	RWdouble
interface	ROfloat
interface	RWfloat
interface	ROpattern
interface	RWpattern
interface	RWstring
interface	ROstring
interface	ROstringSeq
interface	ROdoubleSeq
interface	RWdoubleSeq
interface	ROfloatSeq
interface	RWfloatSeq
interface	ROlongSeq
interface	RWlongSeq
interface	ROlong
interface	RWlong
interface	PlongLong
interface	AlarmlongLong
interface	ROlongLong
interface	RWlongLong
interface	PuLongLong
interface	AlarmuLongLong
interface	ROuLongLong
interface	RWuLongLong
interface	MasterComponentReadOnly
interface	MasterComponent
interface	SpecialTestMasterComponent
interface	CharacteristicTask
interface	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< Time >	TimeSeq
typedef sequence< TimeInterval >	TimeIntervalSeq
typedef sequence< Condition >	ConditionSeq
typedef sequence< pattern >	patternSeq
typedef sequence< double >	doubleSeq
typedef sequence< float >	floatSeq
typedef sequence< long >	longSeq
typedef sequence< doubleSeq >	doubleSeqSeq
typedef sequence< floatSeq >	floatSeqSeq
typedef sequence< longSeq >	longSeqSeq
typedef sequence< stringSeq >	stringSeqSeq
typedef sequence< longLong >	longLongSeq
typedef sequence< uLongLong >	uLongLongSeq
typedef unsigned long	Tag
typedef sequence< PropertyDesc >	PropertyDescSeq
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 ACS::Bool

Enumerator:

acsFALSE
acsTRUE

enum ACS::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.

Enumerator:

COMPSTATE_NEW
COMPSTATE_INITIALIZING
COMPSTATE_INITIALIZED
COMPSTATE_OPERATIONAL
COMPSTATE_ERROR
COMPSTATE_DESTROYING
COMPSTATE_ABORTING
COMPSTATE_DEFUNCT
COMPSTATE_UNKNOWN

enum ACS::Condition

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

Enumerator:

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.