baci::BACIProperty Class Reference

#include <baciBACIProperty.h>

Collaboration diagram for baci::BACIProperty:

List of all members.

Public Member Functions
	BACIProperty (const ACE_CString &name_, PropertyImplementator *propertyImplementator_, CharacteristicModelImpl *characteristicModel_, const BACIValue &defaultValue_, BACIComponent *component_p)
	~BACIProperty ()
const char *	getName () const
BACIValue::Type	getType () const
PropertyImplementator *	getPropertyImplementator () const
CharacteristicModelImpl *	getCharacteristicModel () const
void	getValue (BACIProperty *property, BACIValue *value, Completion &completion, CBDescOut &descOut)
BACIComponent *	getComponent () const
int	getMonitorCount () const
BACIMonitor *	getMonitorAt (int pos) const
bool	hasTriggerOnValueMonitor () const
bool	hasTriggerOnValuePercentMonitor () const
ACS::TimeInterval	getPollInterval () const
ACS::TimeInterval	getLastPollTime () const
ACS::TimeInterval	getMonMinTriggerTime () const
BACIValue	getLastValue () const
void	setPollInterval (const ACS::TimeInterval &_pollInterval)
void	setLastPollTime (const ACS::TimeInterval &_lastPollTime)
void	setMonMinTriggerTime (const ACS::TimeInterval &_interval)
void	setLastValue (const BACIValue &_lastValue)
void	dispatchMonitors (Completion &completion, CBDescOut &descOut)
void	updateMonitorStates ()
bool	isInDestructionState () const
Protected Member Functions
void	addMonitor (BACIMonitor *monitor)
void	removeMonitor (BACIMonitor *monitor)
ACS::TimeInterval	GCD (ACS::TimeInterval t1, ACS::TimeInterval t2)
Private Member Functions
void	operator= (const BACIProperty &)
	BACIProperty (const BACIProperty &)
Private Attributes
ACE_CString	name_m
PropertyImplementator *	propertyImplementator_mp
CharacteristicModelImpl *	characteristicModel_mp
BACIValue	lastValue_m
BACIComponent *	component_mp
BACIMonitorVector	monitorVector_m
bool	triggerOnValueMonitor_m
bool	triggerOnValuePercentMonitor_m
ACS::TimeInterval	pollInterval_m
ACS::TimeInterval	lastPollTime_m
ACS::TimeInterval	monMinTriggerTime_m
BACIMonitor *	archiver_mp
BACIValue::Type	type_m
bool	inDestructionState_m
BACIMutex	monitorVectorMutex_m
Friends
class	BACIComponent
class	BACIMonitor

---

Detailed Description

Class represeting BACI Property (Paramenter)

Author:

Matej Sekoranja, Jozef Stefan Institute, Slovenia

---

Constructor & Destructor Documentation

baci::BACIProperty::BACIProperty	(	const ACE_CString &	name_,
		PropertyImplementator *	propertyImplementator_,
		CharacteristicModelImpl *	characteristicModel_,
		const BACIValue &	defaultValue_,
		BACIComponent *	component_p
	)

Constructor

Parameters:

	name_	property name
	propertyImplementator_	property implementator refernce
	characteristicModel	characteristic model to be used to retrieve data
	defaultValue_	property default value (identifies type of this property - value MUST NOT BE NullValue!!!)
	component_p	property owner

baci::BACIProperty::~BACIProperty

(

)

Destructor

baci::BACIProperty::BACIProperty

(

const BACIProperty &

)

[private]

ALMA C++ coding standards state copy constructors should be disabled.

---

Member Function Documentation

void baci::BACIProperty::addMonitor

(

BACIMonitor *

monitor

)

[protected]

void baci::BACIProperty::dispatchMonitors	(	Completion &	completion,
		CBDescOut &	descOut
	)

ACS::TimeInterval baci::BACIProperty::GCD	(	ACS::TimeInterval	t1,
		ACS::TimeInterval	t2
	)			[protected]

CharacteristicModelImpl* baci::BACIProperty::getCharacteristicModel

(

)

const [inline]

BACIComponent* baci::BACIProperty::getComponent

(

)

const [inline]

ACS::TimeInterval baci::BACIProperty::getLastPollTime

(

)

const [inline]

BACIValue baci::BACIProperty::getLastValue

(

)

const [inline]

BACIMonitor* baci::BACIProperty::getMonitorAt

(

int

pos

)

const [inline]

int baci::BACIProperty::getMonitorCount

(

)

const [inline]

ACS::TimeInterval baci::BACIProperty::getMonMinTriggerTime

(

)

const [inline]

const char* baci::BACIProperty::getName

(

void

)

const [inline]

ACS::TimeInterval baci::BACIProperty::getPollInterval

(

)

const [inline]

PropertyImplementator* baci::BACIProperty::getPropertyImplementator

(

)

const [inline]

BACIValue::Type baci::BACIProperty::getType

(

)

const [inline]

void baci::BACIProperty::getValue	(	BACIProperty *	property,
		BACIValue *	value,
		Completion &	completion,
		CBDescOut &	descOut
	)			[inline]

Get value method (value accessor)

Parameters:

	property	property which requested value
	value	value to be returned
	completion	error handling structure
	descOut	callback descriptor

bool baci::BACIProperty::hasTriggerOnValueMonitor

(

)

const [inline]

bool baci::BACIProperty::hasTriggerOnValuePercentMonitor

(

)

const [inline]

bool baci::BACIProperty::isInDestructionState

(

)

const [inline]

void baci::BACIProperty::operator=

(

const BACIProperty &

)

[private]

ALMA C++ coding standards state assignment operators should be disabled.

void baci::BACIProperty::removeMonitor

(

BACIMonitor *

monitor

)

[protected]

void baci::BACIProperty::setLastPollTime

(

const ACS::TimeInterval &

_lastPollTime

)

[inline]

void baci::BACIProperty::setLastValue

(

const BACIValue &

_lastValue

)

[inline]

void baci::BACIProperty::setMonMinTriggerTime

(

const ACS::TimeInterval &

_interval

)

[inline]

void baci::BACIProperty::setPollInterval

(

const ACS::TimeInterval &

_pollInterval

)

[inline]

void baci::BACIProperty::updateMonitorStates

(

)

---

Friends And Related Function Documentation

friend class BACIComponent [friend]

friend class BACIMonitor [friend]

---

Member Data Documentation

BACIMonitor* baci::BACIProperty::archiver_mp [private]

CharacteristicModelImpl* baci::BACIProperty::characteristicModel_mp [private]

BACIComponent* baci::BACIProperty::component_mp [private]

bool baci::BACIProperty::inDestructionState_m [private]

ACS::TimeInterval baci::BACIProperty::lastPollTime_m [private]

BACIValue baci::BACIProperty::lastValue_m [private]

BACIMonitorVector baci::BACIProperty::monitorVector_m [private]

BACIMutex baci::BACIProperty::monitorVectorMutex_m [private]

ACS::TimeInterval baci::BACIProperty::monMinTriggerTime_m [private]

ACE_CString baci::BACIProperty::name_m [private]

ACS::TimeInterval baci::BACIProperty::pollInterval_m [private]

PropertyImplementator* baci::BACIProperty::propertyImplementator_mp [private]

bool baci::BACIProperty::triggerOnValueMonitor_m [private]

bool baci::BACIProperty::triggerOnValuePercentMonitor_m [private]

BACIValue::Type baci::BACIProperty::type_m [private]

---

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

• baciBACIProperty.h