ROEnumImpl<> Class Template Reference

#include <enumpropROImpl.h>

Inheritance diagram for ROEnumImpl<>:

[legend]Collaboration diagram for ROEnumImpl<>:

[legend]List of all members.

Public Member Functions
	ROEnumImpl (const ACE_CString &name, BACIComponent *cob, DevIO< T > *devIO=0, bool flagdeldevIO=false)
virtual	~ROEnumImpl ()
virtual int	initialization ()
CORBA::Object_ptr	getCORBAReference () const
BACIProperty *	getProperty () const
DevIO< T > *	getDevIO () const
virtual void	destroy ()
virtual ActionRequest	getValueAction (BACIComponent *cob, const int &callbackID, const CBDescIn &descIn, BACIValue *value, Completion &completion, CBDescOut &descOut)
virtual ActionRequest	invokeAction (int function, BACIComponent *cob, const int &callbackID, const CBDescIn &descIn, BACIValue *value, Completion &completion, CBDescOut &descOut)
virtual void	getValue (BACIProperty *property, BACIValue *value, Completion &completion, CBDescOut &descOut)
virtual char *	name () throw ( CORBA::SystemException )
virtual char *	characteristic_component_name () throw ( CORBA::SystemException )
virtual char *	description () throw ( CORBA::SystemException )
virtual char *	format () throw ( CORBA::SystemException )
virtual char *	units () throw ( CORBA::SystemException )
virtual ACS::pattern	resolution () throw ( CORBA::SystemException )
virtual CORBA::Boolean	initialize_devio () throw (CORBA::SystemException)
virtual ACS::TimeInterval	default_timer_trigger () throw ( CORBA::SystemException )
virtual ACS::TimeInterval	min_timer_trigger () throw ( CORBA::SystemException )
virtual T	default_value () throw ( CORBA::SystemException )
virtual T	get_sync (ACSErr::Completion_out c) throw ( CORBA::SystemException )
virtual void	get_async (CBpattern *cb, const ACS::CBDescIn &desc) throw ( CORBA::SystemException )
virtual CORBA::Long	get_history (CORBA::Long n_last_values, TSeq_out vs, ACS::TimeSeq_out ts) throw ( CORBA::SystemException )
virtual ACS::Monitorpattern *	create_monitor (CBpattern *cb, const ACS::CBDescIn &desc) throw ( CORBA::SystemException )
virtual ACS::Monitor *	create_postponed_monitor (ACS::Time start_time, CBpattern *cb, const ACS::CBDescIn &desc) throw ( CORBA::SystemException )
virtual ACS::stringSeq *	statesDescription () throw ( CORBA::SystemException )
virtual ACS::ConditionSeq *	condition () throw ( CORBA::SystemException )
virtual TSeq *	allStates () throw ( CORBA::SystemException )
virtual TSeq *	alarm_on () throw ( CORBA::SystemException )
virtual TSeq *	alarm_off () throw ( CORBA::SystemException )
virtual ACS::Subscription_ptr	new_subscription_AlarmEnum (ACS::Alarmpattern_ptr cb, const ACS::CBDescIn &desc) throw (CORBA::SystemException)
bool	checkAlarm (T state)
Protected Member Functions
virtual bool	readCharacteristics ()
void	addValueToHistory (ACS::Time time, ACS::pattern value)
Private Attributes
T	state
int	initialization_m
	Initialization status.
bool	destroyed_m
	Destroy status.
CORBA::Object_ptr	reference_mp
	CORBA reference.
BACIProperty *	property_mp
	BACI property.
MonitorenumpropEventDispatcher *	monitorEventDispatcher_mp
	Event dispatcher;.
AlarmSystemMonitorEnumProp< T, ROEnumImpl< ACS_ENUM_T(T), SK > >	alarmSystemMonitorEnumProp_mp )
	alarm system monitor
T	historyValue_m [HISTORY_SIZE]
	history value buffer
ACS::Time	historyTime_m [HISTORY_SIZE]
	history time buffer
int	historyStart_m
	history start pointer
bool	historyTurnaround_m
	history end pointer
ACE_CString	m_description
ACE_CString	format_m
ACE_CString	units_m
ACS::pattern	m_resolution
bool	initializeDevIO_m
T	defaultValue_m
TimeInterval	defaultTimerTrig_m
TimeInterval	minTimerTrig_m
TimeInterval	m_alarm_timer_trig
ACS::stringSeq	m_statesDescription
ACS::ConditionSeq	m_condition
TSeq	m_alarm_on
TSeq	m_alarm_off
bool	alarmRaised_m
DevIO< T > *	devIO_mp
bool	deldevIO_m
T	m_value
int	m_enumLength

---

Detailed Description

template<ACS_ENUM_C>
class ROEnumImpl<>

Template implemantation of enum RO property

---

Constructor & Destructor Documentation

template<ACS_ENUM_C > ROEnumImpl<>::ROEnumImpl (  const ACE_CString &  name, BACIComponent *  cob, DevIO< T > *  devIO = 0, bool  flagdeldevIO = false )

Constuctor Parameters: name  property name (e.q. AMSMount:decliantion) cob  parent of the property

template<ACS_ENUM_C > virtual ROEnumImpl<>::~ROEnumImpl (   )  [virtual]

Destructor

---

Member Function Documentation

template<ACS_ENUM_C > void ROEnumImpl<>::addValueToHistory (  ACS::Time  time, ACS::pattern  value )  [protected]

template<ACS_ENUM_C > virtual TSeq* ROEnumImpl<>::alarm_off (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual TSeq* ROEnumImpl<>::alarm_on (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual TSeq* ROEnumImpl<>::allStates (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual char* ROEnumImpl<>::characteristic_component_name (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > bool ROEnumImpl<>::checkAlarm (  T  state  )

Checks if the passed state correspond to an alarm on. Parameters: state  the value for the enumeration to be checked. Returns: true if this state is in the alarm_on list.

template<ACS_ENUM_C > virtual ACS::ConditionSeq* ROEnumImpl<>::condition (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual ACS::Monitorpattern* ROEnumImpl<>::create_monitor (  CBpattern *  cb, const ACS::CBDescIn &  desc )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual ACS::Monitor* ROEnumImpl<>::create_postponed_monitor (  ACS::Time  start_time, CBpattern *  cb, const ACS::CBDescIn &  desc )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual ACS::TimeInterval ROEnumImpl<>::default_timer_trigger (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual T ROEnumImpl<>::default_value (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual char* ROEnumImpl<>::description (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual void ROEnumImpl<>::destroy (   )  [virtual]

Destructor method This method must be called to destroy property, POA will call destructor (direct call of destructor will most likely cause code to crash)

template<ACS_ENUM_C > virtual char* ROEnumImpl<>::format (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual void ROEnumImpl<>::get_async (  CBpattern *  cb, const ACS::CBDescIn &  desc )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual CORBA::Long ROEnumImpl<>::get_history (  CORBA::Long  n_last_values, TSeq_out  vs, ACS::TimeSeq_out  ts )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual T ROEnumImpl<>::get_sync (  ACSErr::Completion_out  c  )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > CORBA::Object_ptr ROEnumImpl<>::getCORBAReference (   )  const [inline]

Get CORBA referece of this object Returns: reference to CORBa object

template<ACS_ENUM_C > DevIO<T>* ROEnumImpl<>::getDevIO (   )  const [inline]

DevIO accessor

template<ACS_ENUM_C > BACIProperty* ROEnumImpl<>::getProperty (   )  const [inline]

BACI Monitor instance accessor

template<ACS_ENUM_C > virtual void ROEnumImpl<>::getValue (  BACIProperty *  property, BACIValue *  value, Completion &  completion, CBDescOut &  descOut )  [virtual]

Get value method (value accessor) Parameters: property  property which requested value value  value to be returned completion  error handling structure descOut  callback descriptor Implements baci::PropertyImplementator.

template<ACS_ENUM_C > virtual ActionRequest ROEnumImpl<>::getValueAction (  BACIComponent *  cob, const int &  callbackID, const CBDescIn &  descIn, BACIValue *  value, Completion &  completion, CBDescOut &  descOut )  [virtual]

template<ACS_ENUM_C > virtual int ROEnumImpl<>::initialization (   )  [inline, virtual]

Property construction status method After contruction of a property, this method will be called to check if construction was successful; if not, monitor will be destroyed by parent Returns: 0 on success or any other value (value can indicate cause of faulire) on faulure Reimplemented from baci::PropertyImplementator.

template<ACS_ENUM_C > virtual CORBA::Boolean ROEnumImpl<>::initialize_devio (   )  throw (CORBA::SystemException) [virtual]

template<ACS_ENUM_C > virtual ActionRequest ROEnumImpl<>::invokeAction (  int  function, BACIComponent *  cob, const int &  callbackID, const CBDescIn &  descIn, BACIValue *  value, Completion &  completion, CBDescOut &  descOut )  [virtual]

Action dispatcher function Parameters: function  action funtion to be invoked cob  owner of the action callbackID  id of the callback to be notified descIn  callback descriptor (passed by client) value  action data (e.g. value to be set) completion  error handing structure descOut  callback descriptor which will be passed to client Returns: request to be performed by BACI reqNone - do nothing (action will be kept in queue) reqInvokeWorking - invoke Callback::working reqInvokeDone - invoke Callback::done and destroy callback reqDestroy - destroy callback (callback should has been called already by function) Implements baci::ActionImplementator.

template<ACS_ENUM_C > virtual ACS::TimeInterval ROEnumImpl<>::min_timer_trigger (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual char* ROEnumImpl<>::name (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual ACS::Subscription_ptr ROEnumImpl<>::new_subscription_AlarmEnum (  ACS::Alarmpattern_ptr  cb, const ACS::CBDescIn &  desc )  throw (CORBA::SystemException) [virtual]

template<ACS_ENUM_C > virtual bool ROEnumImpl<>::readCharacteristics (   )  [protected, virtual]

Read characteristics from CDB Parameters: propertyName  name of the property whose characteristics to read Returns: true on success, false on failure Reimplemented from baci::CharacteristicModelImpl.

template<ACS_ENUM_C > virtual ACS::pattern ROEnumImpl<>::resolution (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual ACS::stringSeq* ROEnumImpl<>::statesDescription (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual char* ROEnumImpl<>::units (   )  throw ( CORBA::SystemException ) [virtual]

---

Member Data Documentation

template<ACS_ENUM_C > bool ROEnumImpl<>::alarmRaised_m [private]

True if the alarm is ON

template<ACS_ENUM_C > AlarmSystemMonitorEnumProp<T, ROEnumImpl<ACS_ENUM_T(T), SK> > ROEnumImpl<>::alarmSystemMonitorEnumProp_mp) [private]

alarm system monitor

template<ACS_ENUM_C > TimeInterval ROEnumImpl<>::defaultTimerTrig_m [private]

template<ACS_ENUM_C > T ROEnumImpl<>::defaultValue_m [private]

template<ACS_ENUM_C > bool ROEnumImpl<>::deldevIO_m [private]

template<ACS_ENUM_C > bool ROEnumImpl<>::destroyed_m [private]

Destroy status.

template<ACS_ENUM_C > DevIO<T>* ROEnumImpl<>::devIO_mp [private]

template<ACS_ENUM_C > ACE_CString ROEnumImpl<>::format_m [private]

template<ACS_ENUM_C > int ROEnumImpl<>::historyStart_m [private]

history start pointer

template<ACS_ENUM_C > ACS::Time ROEnumImpl<>::historyTime_m[HISTORY_SIZE] [private]

history time buffer

template<ACS_ENUM_C > bool ROEnumImpl<>::historyTurnaround_m [private]

history end pointer

template<ACS_ENUM_C > T ROEnumImpl<>::historyValue_m[HISTORY_SIZE] [private]

history value buffer

template<ACS_ENUM_C > int ROEnumImpl<>::initialization_m [private]

Initialization status. Definition of ActionFunction (member function of RO)

template<ACS_ENUM_C > bool ROEnumImpl<>::initializeDevIO_m [private]

template<ACS_ENUM_C > TSeq ROEnumImpl<>::m_alarm_off [private]

A sequence of values that correspond to an alarm OFF

template<ACS_ENUM_C > TSeq ROEnumImpl<>::m_alarm_on [private]

A sequence of values that correspond to an alarm ON

template<ACS_ENUM_C > TimeInterval ROEnumImpl<>::m_alarm_timer_trig [private]

template<ACS_ENUM_C > ACS::ConditionSeq ROEnumImpl<>::m_condition [private]

template<ACS_ENUM_C > ACE_CString ROEnumImpl<>::m_description [private]

Characteristics

template<ACS_ENUM_C > int ROEnumImpl<>::m_enumLength [private]

template<ACS_ENUM_C > ACS::pattern ROEnumImpl<>::m_resolution [private]

template<ACS_ENUM_C > ACS::stringSeq ROEnumImpl<>::m_statesDescription [private]

template<ACS_ENUM_C > T ROEnumImpl<>::m_value [private]

template<ACS_ENUM_C > TimeInterval ROEnumImpl<>::minTimerTrig_m [private]

template<ACS_ENUM_C > MonitorenumpropEventDispatcher* ROEnumImpl<>::monitorEventDispatcher_mp [private]

Event dispatcher;.

template<ACS_ENUM_C > BACIProperty* ROEnumImpl<>::property_mp [private]

BACI property.

template<ACS_ENUM_C > CORBA::Object_ptr ROEnumImpl<>::reference_mp [private]

CORBA reference.

template<ACS_ENUM_C > T ROEnumImpl<>::state [private]

Current value for the enumeration property

template<ACS_ENUM_C > ACE_CString ROEnumImpl<>::units_m [private]

---

The documentation for this class was generated from the following file:

• enumpropROImpl.h

---