Acquisition channel More...

Detailed Description

Acquisition channel

Inheritance diagram for AcquisitionChannel:

Public Member Methods
const String &	GetLastValue () const
	The last aquired value. More...

const String &	GetLastValue ()
	The last aquired value. More...

const String &	GetTargetPath () const
	The target property path of the acquisition channel. More...

const String &	GetTargetPath ()
	The target property path of the acquisition channel. More...

const String &	GetPropertyName () const
	Get the name of the property to acquire. More...

const String &	GetPropertyName ()
	Get the name of the property to acquire. More...

const bool &	GetIsActivate () const
	Query if the acquisition channel is active. More...

const bool &	GetIsActivate ()
	Query if the acquisition channel is active. More...

BaseConceptFactory &	GetFactory () const
	Gets the ConceptElement factory. 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	Configure (DynamicInvocationClientObject &root, PCChar8 path, PCChar8 propertyName)
	Configure the channel in order to by linked to a property More...

void	Acquire ()
	Aquires the property value More...

bool	operator== (const AcquisitionChannel &right) const
	Equality operator. 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...

void	Clear ()
	Clears the content of this container. 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...

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...

Static Public Member Functions
static BaseConceptFactory &	GetClassFactory ()
	Get the class factory. More...

Protected Member Functions
void	SetLastValue (const String &value)
	The last aquired value. More...

void	Initialize ()
	Component inner initialization. More...

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...

Private fields
String	LastValue
	The last aquired value. More...

String	TargetPath
	The target property path of the acquisition channel. More...

String	PropertyName
	Get the name of the property to acquire. More...

bool	IsActivate
	Query if the acquisition channel is active. 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.

void Acquire ( )

Aquires the property value

bool Configure	(	DynamicInvocationClientObject &	root,
		PCChar8	path,
		PCChar8	propertyName
	)

Configure the channel in order to by linked to a property

Parameters

root	[in,out] The root object.
path	The property path.
propertyName	The property name.

Returns: true if the channel has been configured properly, false if not.

RT Exceptions:: RT_ERROR_EVALUATION_FAILD

static BaseConceptFactory& GetClassFactory ( )

inlinestatic

Get the class factory.

Returns: The class factory.

BaseConceptFactory& GetFactory ( ) const

inlinevirtual

Gets the ConceptElement factory.

Returns: The factory.

RT Exceptions:: RT_ERROR_INTERNAL_FACTORY_NOT_DEFINED

Implements ConceptElement.

const bool & GetIsActivate ( )

inline

Query if the acquisition channel is active.

Once the channel is configured, the channel is activated.

Returns: the property value

See also: Field: IsActivate

const bool & GetIsActivate ( ) const

inline

Query if the acquisition channel is active.

Once the channel is configured, the channel is activated.

Returns: the property value

See also: Field: IsActivate

const String & GetLastValue ( ) const

inline

The last aquired value.

Used by the AquisitionSystem to read cyclically the channel value.

Returns: the property value

See also: Field: LastValue; Setter: SetLastValue()

const String & GetLastValue ( )

inline

The last aquired value.

Used by the AquisitionSystem to read cyclically the channel value.

Returns: the property value

See also: Field: LastValue; Setter: SetLastValue()

const String & GetPropertyName ( )

inline

Get the name of the property to acquire.

This name is used to resolve the link with the TargetPath to the property.

Returns: the property value

See also: Field: PropertyName

const String & GetPropertyName ( ) const

inline

Get the name of the property to acquire.

This name is used to resolve the link with the TargetPath to the property.

Returns: the property value

See also: Field: PropertyName

const String & GetTargetPath ( ) const

inline

The target property path of the acquisition channel.

The target path define the path between the root element given to the acquisitionSystem and the property to acquire.

Returns: the property value

See also: Field: TargetPath

const String & GetTargetPath ( )

inline

The target property path of the acquisition channel.

The target path define the path between the root element given to the acquisitionSystem and the property to acquire.

Returns: the property value

See also: Field: TargetPath

void Initialize ( )

protected

Component inner initialization.

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.

bool operator== ( const AcquisitionChannel & right ) const

inline

Equality operator.

Parameters

right The instance to compare.

Returns: true if it's the owned object is the same object than 'right'.

void SetLastValue ( const String & value )

inlineprotected

The last aquired value.

Used by the AquisitionSystem to read cyclically the channel value.

Parameters

[in] value The new parameter value.

Returns: the property value

See also: Field: LastValue; Getter: GetLastValue()

Fields Documentation

bool IsActivate

private

Query if the acquisition channel is active.

Once the channel is configured, the channel is activated.

See also: Getter: GetIsActivate()

String LastValue

private

The last aquired value.

Used by the AquisitionSystem to read cyclically the channel value.

See also: Getter: GetLastValue(); Setter: SetLastValue()

String PropertyName

private

Get the name of the property to acquire.

This name is used to resolve the link with the TargetPath to the property.

See also: Getter: GetPropertyName()

String TargetPath

private

The target property path of the acquisition channel.

The target path define the path between the root element given to the acquisitionSystem and the property to acquire.

See also: Getter: GetTargetPath()

Detailed Description

Public Member Methods

Static Public Member Functions

Protected Member Functions

Private fields

Methods Documentation

Fields Documentation