List of all members | Classes | Public Member Functions | Protected Member Functions | Friends
LiteralImpl Class Reference
ArmarXCore » ArmarX Observers » Conditions

LiteralImpls are the basic elements for defining conditional expressions. More...

#include <ArmarXCore/observers/condition/LiteralImpl.h>

+ Inheritance diagram for LiteralImpl:

Classes

struct  Impl
 

Public Member Functions

CheckConfiguration getCheckConfiguration (const Ice::Current &c=Ice::emptyCurrent) override
 Retrieve check configuration.
 
Ice::ObjectPtr ice_clone () const override
 Reimplementation of the ice_clone method.
 
void output (std::ostream &out) const override
 output to stream.
 
void setValue (bool value, const Ice::Current &c=Ice::emptyCurrent) override
 Set value of LiteralImpl.
 
void setValueAndData (bool value, const ::armarx::DataFieldIdentifierBasePtr &id, const ::armarx::VariantBasePtr &data, const Ice::Current &c=Ice::emptyCurrent) override
 
- Public Member Functions inherited from TermImpl
void addChild (const TermImplBasePtr &child, const Ice::Current &c=Ice::emptyCurrent) override
 Add child to term.
 
TermImplSequence getChilds (const Ice::Current &c=Ice::emptyCurrent) override
 retrieve childs of this term in the expression tree.
 
StringVariantBaseMap getDatafields (const Ice::Current &) const override
 
TermImplBasePtr getParent (const Ice::Current &c=Ice::emptyCurrent) override
 retrieve parent of this term in the expression tree.
 
TermType getType (const Ice::Current &c=Ice::emptyCurrent) const override
 Retrieve type of term.
 
bool getValue (const Ice::Current &c=Ice::emptyCurrent) const override
 retrieve current value of term.
 
void removeChildren ()
 
void update (const Ice::Current &c=Ice::emptyCurrent) override
 Updates the parent in the expression tree.
 
void updateWithData (const Ice::Current &c=Ice::emptyCurrent) override
 
 ~TermImpl () override
 Destructor of TermImpl.
 

Protected Member Functions

void createInstance ()
 
void init (const std::string &dataFieldIdentifierStr, const std::string &checkName, const ParameterList &checkParameters)
 
 LiteralImpl ()
 Creates an empty LiteralImpl.
 
 LiteralImpl (const DataFieldIdentifier &dataFieldIdentifier, const std::string &checkName, const ParameterList &checkParameters)
 Creates a LiteralImpl using the DataFieldIdentifier type with multiple parameter.
 
 LiteralImpl (const DataFieldIdentifierPtr &dataFieldIdentifier, const std::string &checkName, const ParameterList &checkParameters)
 Creates a LiteralImpl using the DataFieldIdentifier type with multiple parameter.
 
 LiteralImpl (const DatafieldRefBasePtr &dataFieldIdentifier, const std::string &checkName, const ParameterList &checkParameters)
 
 LiteralImpl (const std::string &dataFieldIdentifierStr, const std::string &checkName, const ParameterList &checkParameters)
 Creates a LiteralImpl using string as dataFieldIdentifier with multiple parameter.
 
 ~LiteralImpl ()
 
- Protected Member Functions inherited from TermImpl
void __decRef () override
 Overwritten version of reference counting from GCShared.
 
void __incRef () override
 Overwritten version of reference counting from GCShared.
 
void resetParent (const Ice::Current &c=Ice::emptyCurrent) override
 Reset the parent of this term.
 
void setParent (const TermImplBasePtr &parent, const Ice::Current &c=Ice::emptyCurrent) override
 Sets the parent for this term in the expression tree.
 

Friends

class ConditionHandler
 
template<class BaseClass, class VariantClass>
class GenericFactory
 
class Literal
 
std::ostream & operator<< (std::ostream &stream, const LiteralImpl &rhs)
 stream operator for LiteralImpl
 
std::ostream & operator<< (std::ostream &stream, const LiteralImplPtr &rhs)
 stream operator for LiteralImplPtr
 

Additional Inherited Members

- Static Protected Member Functions inherited from TermImpl
static int atomicDecAndTestValue (volatile int *counter, int value)
 atomicDecAndTestValue - decrement and test @v: pointer of type AtomicCounter @value: value to test for
 

Detailed Description

LiteralImpls are the basic elements for defining conditional expressions.

LiteralImpl are leaves in the expression tree. Each LiteralImpl is associated to a ConditionCheck. The state of the LiteralImpl corresponds to the state of the ConditionCheck.

Definition at line 56 of file LiteralImpl.h.

Constructor & Destructor Documentation

◆ LiteralImpl() [1/5]

LiteralImpl ( )
protected

Creates an empty LiteralImpl.

Required for Ice ObjectFactory

Definition at line 46 of file LiteralImpl.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ~LiteralImpl()

~LiteralImpl ( )
protected

Definition at line 52 of file LiteralImpl.cpp.

◆ LiteralImpl() [2/5]

LiteralImpl ( const std::string & dataFieldIdentifierStr,
const std::string & checkName,
const ParameterList & checkParameters )
protected

Creates a LiteralImpl using string as dataFieldIdentifier with multiple parameter.

See also createParameterList().

Parameters
dataFieldIdentifierStridentifier of the datafield used by the condition in the form "observerName.channelName.datafieldName"
checkNamename of the condition check
checkParameterparameter for the condition check

Definition at line 56 of file LiteralImpl.cpp.

+ Here is the call graph for this function:

◆ LiteralImpl() [3/5]

LiteralImpl ( const DataFieldIdentifier & dataFieldIdentifier,
const std::string & checkName,
const ParameterList & checkParameters )
protected

Creates a LiteralImpl using the DataFieldIdentifier type with multiple parameter.

See also createParameterList()

Parameters
dataFieldIdentifieridentifier of the datafield used by the condition
checkNamename of the condition check
checkParameterslist of check parameters

Definition at line 64 of file LiteralImpl.cpp.

+ Here is the call graph for this function:

◆ LiteralImpl() [4/5]

LiteralImpl ( const DataFieldIdentifierPtr & dataFieldIdentifier,
const std::string & checkName,
const ParameterList & checkParameters )
protected

Creates a LiteralImpl using the DataFieldIdentifier type with multiple parameter.

See also createParameterList()

Parameters
dataFieldIdentifierpointer to identifier of the datafield used by the condition
checkNamename of the condition check
checkParameterslist of check parameters

Definition at line 72 of file LiteralImpl.cpp.

+ Here is the call graph for this function:

◆ LiteralImpl() [5/5]

LiteralImpl ( const DatafieldRefBasePtr & dataFieldIdentifier,
const std::string & checkName,
const ParameterList & checkParameters )
protected

Definition at line 80 of file LiteralImpl.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ createInstance()

void createInstance ( )
protected

Definition at line 90 of file LiteralImpl.cpp.

+ Here is the caller graph for this function:

◆ getCheckConfiguration()

CheckConfiguration getCheckConfiguration ( const Ice::Current & c = Ice::emptyCurrent)
override

Retrieve check configuration.

Inherited from LiteralImplBase

Returns
configuration of check

Definition at line 95 of file LiteralImpl.cpp.

+ Here is the caller graph for this function:

◆ ice_clone()

Ice::ObjectPtr ice_clone ( ) const
override

Reimplementation of the ice_clone method.

Returns
clone of the object

Definition at line 120 of file LiteralImpl.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ init()

void init ( const std::string & dataFieldIdentifierStr,
const std::string & checkName,
const ParameterList & checkParameters )
protected

Definition at line 182 of file LiteralImpl.cpp.

+ Here is the caller graph for this function:

◆ output()

void output ( std::ostream & out) const
overridevirtual

output to stream.

pure virtual.

Parameters
stream

Implements TermImpl.

Definition at line 133 of file LiteralImpl.cpp.

+ Here is the caller graph for this function:

◆ setValue()

void setValue ( bool value,
const Ice::Current & c = Ice::emptyCurrent )
override

Set value of LiteralImpl.

Parameters
valueof LiteralImpl

Definition at line 101 of file LiteralImpl.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setValueAndData()

void setValueAndData ( bool value,
const ::armarx::DataFieldIdentifierBasePtr & id,
const ::armarx::VariantBasePtr & data,
const Ice::Current & c = Ice::emptyCurrent )
override

Definition at line 108 of file LiteralImpl.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ ConditionHandler

friend class ConditionHandler
friend

Definition at line 60 of file LiteralImpl.h.

◆ GenericFactory

template<class BaseClass, class VariantClass>
friend class GenericFactory
friend

Definition at line 63 of file LiteralImpl.h.

◆ Literal

friend class Literal
friend

Definition at line 61 of file LiteralImpl.h.

◆ operator<< [1/2]

std::ostream & operator<< ( std::ostream & stream,
const LiteralImpl & rhs )
friend

stream operator for LiteralImpl

Definition at line 149 of file LiteralImpl.h.

◆ operator<< [2/2]

std::ostream & operator<< ( std::ostream & stream,
const LiteralImplPtr & rhs )
friend

stream operator for LiteralImplPtr

Definition at line 160 of file LiteralImpl.h.

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