RWEnumImpl<> Class Template Reference

#include <enumpropRWImpl.h>

Inheritance diagram for RWEnumImpl<>:

[legend]Collaboration diagram for RWEnumImpl<>:

[legend]List of all members.

Public Member Functions
	RWEnumImpl (const ACE_CString &name, BACIComponent *cob, DevIO< T > *devIO=0, bool flagdeldevIO=false)
virtual	~RWEnumImpl ()
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	setValueAction (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 void	setValue (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 ACSErr::Completion *	set_sync (T value) throw (CORBA::SystemException )
virtual void	set_async (T value, ACS::CBvoid_ptr cb, const ACS::CBDescIn &desc) throw (CORBA::SystemException)
virtual void	set_nonblocking (T value) throw ( CORBA::SystemException )
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.
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
ACS::stringSeq	m_statesDescription
ACS::ConditionSeq	m_condition
DevIO< T > *	devIO_mp
bool	deldevIO_m
T	m_value
int	m_enumLength

---

Detailed Description

template<ACS_ENUM_C>
class RWEnumImpl<>

Template implemantation of enum RW property

---

Constructor & Destructor Documentation

template<ACS_ENUM_C > RWEnumImpl<>::RWEnumImpl (  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 RWEnumImpl<>::~RWEnumImpl (   )  [virtual]

Destructor

---

Member Function Documentation

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

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

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

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

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

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

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

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

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

template<ACS_ENUM_C > virtual void RWEnumImpl<>::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* RWEnumImpl<>::format (   )  throw ( CORBA::SystemException ) [virtual]

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

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

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

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

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

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

DevIO accessor

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

BACI Monitor instance accessor

template<ACS_ENUM_C > virtual void RWEnumImpl<>::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 RWEnumImpl<>::getValueAction (  BACIComponent *  cob, const int &  callbackID, const CBDescIn &  descIn, BACIValue *  value, Completion &  completion, CBDescOut &  descOut )  [virtual]

template<ACS_ENUM_C > virtual int RWEnumImpl<>::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 RWEnumImpl<>::initialize_devio (   )  throw (CORBA::SystemException) [virtual]

template<ACS_ENUM_C > virtual ActionRequest RWEnumImpl<>::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 RWEnumImpl<>::min_timer_trigger (   )  throw ( CORBA::SystemException ) [virtual]

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

template<ACS_ENUM_C > virtual bool RWEnumImpl<>::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 RWEnumImpl<>::resolution (   )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual void RWEnumImpl<>::set_async (  T  value, ACS::CBvoid_ptr  cb, const ACS::CBDescIn &  desc )  throw (CORBA::SystemException) [virtual]

template<ACS_ENUM_C > virtual void RWEnumImpl<>::set_nonblocking (  T  value  )  throw ( CORBA::SystemException ) [virtual]

template<ACS_ENUM_C > virtual ACSErr::Completion* RWEnumImpl<>::set_sync (  T  value  )  throw (CORBA::SystemException ) [virtual]

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

Set value method (value mutator) To make RW property simetric to RO property Parameters: property  property which requested value value  value to be returned completion  error handling structure descOut  callback descriptor

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

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

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

---

Member Data Documentation

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

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

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

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

Destroy status.

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

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

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

history start pointer

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

history time buffer

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

history end pointer

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

history value buffer

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

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

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

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

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

Characteristics

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

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

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

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

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

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

BACI property.

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

CORBA reference.

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

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

---

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

• enumpropRWImpl.h

---