AcquisitionSystem Class Reference

Base class for acquisition system More...

Detailed Description

Base class for acquisition system

Inheritance diagram for AcquisitionSystem:

Public Member Methods
const AcquisitionChannels &	GetChannels () const
	Acquisition channels list. More...
AcquisitionChannels &	GetChannels ()
	Acquisition channels list. More...
const Int32 &	GetPoints () const
	Number of point to acquire. More...
const Int32 &	GetPoints ()
	Number of point to acquire. More...
void	SetPoints (const Int32 &value)
	Number of point to acquire. More...
const bool &	GetIsCompleted () const
	Indicates that the acquisition is completed. More...
const bool &	GetIsCompleted ()
	Indicates that the acquisition is completed. More...
void	Accept (IContainerVisitor &visitor)
	Accepts IContainerVisitor to access the object published fields. More...
void	Invoke (const DynamicInvocationRequest &request, DynamicInvocationResult &result)
	Invokes the object fields and methods. More...
bool	Add (PCChar8 targetPath, PCChar8 propertyName)
	Add a property to the acquisition. More...
bool	Remove (PCChar8 targetPath, PCChar8 propertyName)
	Remove a property to the acquisition. More...
void	Clear ()
	Clears the aquisition channels. More...
virtual void	Start ()
	Start the acquisition. More...
void	CyclicExecute ()
	Make the acquisition More...
Public Member Methods inherited from ConceptComponent
	ConceptComponent ()
	Default constructor. More...
	~ConceptComponent ()
	Destructor. More...
void	GetChildren (IReferenceList< ConceptElement > &children)
	Gets the children of this component. More...
ConceptElement &	AddNew (const BaseConceptFactory &factory, const PCChar8 name)
	Adds a new element to the component. More...
void	ReadFrom (IDataStore &dataStore, IMessageCollector *messages=NULL)
	Reads from. More...
void	WriteTo (IDataStore &dataStore) const
	Writes to. More...
Public Member Methods inherited from ConceptContainer
const bool &	GetIsXmlPropertyVisible () const
	Show the xml field in the invocation. More...
const bool &	GetIsXmlPropertyVisible ()
	Show the xml field in the invocation. More...
void	SetIsXmlPropertyVisible (const bool &value)
	Show the xml field in the invocation. More...
const bool &	GetIsXmlPropertyReadOnly () const
	Control access on the xml file shown in the invocation. More...
const bool &	GetIsXmlPropertyReadOnly ()
	Control access on the xml file shown in the invocation. More...
void	SetIsXmlPropertyReadOnly (const bool &value)
	Control access on the xml file shown in the invocation. More...
	ConceptContainer ()
	Default constructor. More...
	~ConceptContainer ()
	Destructor. More...
bool	Contains (ConceptElement &element) const
	Query if this object contains the given element. More...
void	ResolveLinks ()
	Resolve links. More...
ConceptElement *	Find (const PCChar8 path) const
	Searches into the container and sub-containers an element. More...
virtual ConceptElement *	FindByName (const PCChar8 name) const
	Searches into the container an element. More...
template<class ElementSubType >
ElementSubType *	FindByName (const PCChar8 name) const
	Searches into the container an element of a certain type. More...
void	RetrieveProvidedFactories (BaseConceptFactories &factories, const Predicate< BaseConceptFactory & > &filter)
	Retrieve provided factories. More...
void	RetrieveProvidedFactories (BaseConceptFactories &factories)
	RetrieveProvidedFactories. More...
void	RetrieveFactories (BaseConceptFactories &factories) const
	Retrieve factories. More...
Public Member Methods inherited from ConceptElement
const bool &	GetIsInvocable () const
	Controls if the objet should be shown in the invocation. More...
const bool &	GetIsInvocable ()
	Controls if the objet should be shown in the invocation. More...
void	SetIsInvocable (const bool &value)
	Controls if the objet should be shown in the invocation. More...
const bool &	GetIsSerialized () const
	Controls if the objet should be serialized. More...
const bool &	GetIsSerialized ()
	Controls if the objet should be serialized. More...
void	SetIsSerialized (const bool &value)
	Controls if the objet should be serialized. More...
	ConceptElement ()
	Default constructor. More...
	ConceptElement (const ConceptElement &right)
	Default constructor. More...
ConceptElement &	operator= (const ConceptElement &right)
	Assignment operator. More...
const StaticString< ConceptElementNameMaxLength > &	GetName () const
	Gets the name. More...
void	SetName (const PCChar8 name)
	Sets a name. More...
String	GetPath () const
	Gets the path of the ConceptElement. More...
ConceptContainer *	GetContainer () const
	Gets the container of the ConceptElement. More...
template<class ContainerType >
ContainerType *	GetContainerOfType () const
	Gets the container of a certain type the ConceptElement. More...
ConceptContainer *	GetRootContainer () const
	Gets the root container of the ConceptElement. More...
virtual const String	GetDisplayName () const
	Gets the display name. More...
virtual void	CopyDataFrom (const ConceptElement &source)
	Copies the data from another ConceptElement. More...
virtual void	CopyFrom (const ConceptElement &source)
	Copies itself from a given source. More...
virtual BaseConceptFactory &	GetFactory () const =0
	Gets the ConceptElement factory. More...
ConceptElement &	GetProvider () const
	Gets the provider of the ConceptElement if defined, throws a ConceptException otherwise. More...
template<class T >
T &	GetProvider () const
	Gets the provider of the ConceptElement if defined and of type T, throws a ConceptException otherwise. More...
bool	GetHasProvider () const
	Tests the existence of a provider. More...
template<class T >
bool	GetHasProvider () const
	Tests the existence of a provider of type T. More...
virtual ConceptElement *	Clone () const
	Makes a deep copy of this object. More...
void	RetrieveProvidedFactories (BaseConceptFactories &factories)
	Retrieve provided factories. More...
Variant	GetPropertyMetaData (PCChar8 propertyName, PCChar8 metaDataName, const Variant &defaultValue=Variant::GetVariantNull()) const
	Returns a metadata string corresponding to a property and a metadata name. More...

Private fields
AcquisitionChannels	_Channels
	Acquisition channels list. More...
Int32	Points
	Number of point to acquire. More...
bool	IsCompleted
	Indicates that the acquisition is completed. More...

Additional Inherited Members
Protected Member Functions inherited from ConceptContainer
virtual Int32	Add (ConceptElement &element)
	Adds element. More...
virtual Int32	Add (ConceptElement &element, const PCChar8 name)
	Adds element. More...
Protected Member Functions inherited from ConceptElement
void	Initialize ()
	Initializes this object. More...
virtual BaseConceptFactory &	InternalGetFactory () const
	Gets the object factory. More...
virtual void	RetrieveElementProvidedFactories (BaseConceptFactories &factories, const Predicate< BaseConceptFactory & > &filter)
	RetrieveElementProvidedFactories. Used by the macro CONCEPT_PROVIDED_COMPONENT_BEGIN More...

Methods Documentation

void Accept ( IContainerVisitor &  visitor )

inlinevirtual

Accepts IContainerVisitor to access the object published fields.

Parameters

visitor

[in,out] The visitor.

Reimplemented from ConceptContainer.

Reimplemented in AcquisitionSystemRT< AcquitisionBufferSize, LoggerBufferSize, MemoryRootBufferSize >.

bool Add	(	PCChar8	targetPath,
		PCChar8	propertyName
	)

Add a property to the acquisition.

Parameters

targetPath	The target path of the property owner. (e.g : /object1/object2/).
propertyName	The property name (e.g : MyValue).

Returns

true is the property link has been correctly added.

RT Exceptions:

RT_ERROR_ADD_CHANNEL_OUT_OF_LIMIT

RT_ERROR_MODIFY_CHANNEL_NOT_ALLOWED

RT_ERROR_INTERNAL_OBJECT_NOT_DEFINED_PROPERLY

RT_ERROR_EVALUATION_FAILD

void Clear ( )

virtual

Clears the aquisition channels.

Note

Deterministic: AquisitionChannels::Clear is deterministic. BaseClass behavior not called here.

Reimplemented from ConceptComponent.

void CyclicExecute

(

)

Make the acquisition

This method should be called cyclically on the smallest application cycle. In order to make a significant acquisition the cycle should be deterministic so that the time between two samples with be constant.

AcquisitionChannels & GetChannels ( )

inline

Acquisition channels list.

Each channel gives the ability to acquire one property.

Returns

the child as reference.

See also

Child: _Channels

const AcquisitionChannels & GetChannels ( ) const

inline

Acquisition channels list.

Each channel gives the ability to acquire one property.

Returns

the child as reference.

See also

Child: _Channels

const bool & GetIsCompleted ( ) const

inline

Indicates that the acquisition is completed.

After the acquisition is started it will run until the number of Points is reached. Once all the points are acquired the process is completed.

Returns

the property value

See also

Field: IsCompleted

const bool & GetIsCompleted ( )

inline

Indicates that the acquisition is completed.

After the acquisition is started it will run until the number of Points is reached. Once all the points are acquired the process is completed.

Returns

the property value

See also

Field: IsCompleted

const Int32 & GetPoints ( )

inline

Number of point to acquire.

The process of aquisition will run until this number of point is reached.

Returns

the property value

See also

Field: Points

Setter: SetPoints()

const Int32 & GetPoints ( ) const

inline

Number of point to acquire.

The process of aquisition will run until this number of point is reached.

Returns

the property value

See also

Field: Points

Setter: SetPoints()

void Invoke ( const DynamicInvocationRequest &  request, DynamicInvocationResult &  result  )

inlinevirtual

Invokes the object fields and methods.

Parameters

request	The request.
result	[in,out] The result.

Dynamic Invocation on IInvocable objects enables us to have remote access on published fields and methods.

Reimplemented from ConceptContainer.

Reimplemented in AcquisitionSystemRT< AcquitisionBufferSize, LoggerBufferSize, MemoryRootBufferSize >.

bool Remove	(	PCChar8	targetPath,
		PCChar8	propertyName
	)

Remove a property to the acquisition.

Parameters

targetPath	The target path of the property owner. (e.g : /object1/object2/).
propertyName	The property name (e.g : MyValue).

Returns

true is the property link has been correctly removed.

RT Exceptions:

RT_ERROR_MODIFY_CHANNEL_NOT_ALLOWED

void SetPoints ( const Int32 &  value )

inline

Number of point to acquire.

The process of aquisition will run until this number of point is reached.

Parameters

[in]

value

The new parameter value.

Returns

the property value

See also

Field: Points

Getter: GetPoints()

virtual void Start ( )

virtual

Start the acquisition.

RT Exceptions:

RT_ERROR_BAD_START_CONDITIONS

RT_ERROR_INTERNAL_OBJECT_NOT_DEFINED_PROPERLY

Reimplemented in AcquisitionSystemRT< AcquitisionBufferSize, LoggerBufferSize, MemoryRootBufferSize >.

Fields Documentation

AcquisitionChannels _Channels

private

Acquisition channels list.

Each channel gives the ability to acquire one property.

See also

Getter: GetChannels()

bool IsCompleted

private

Indicates that the acquisition is completed.

After the acquisition is started it will run until the number of Points is reached. Once all the points are acquired the process is completed.

See also

Getter: GetIsCompleted()

Int32 Points

private

Number of point to acquire.

The process of aquisition will run until this number of point is reached.

See also

Getter: GetPoints()

Setter: SetPoints()