Literal Class Reference

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

+ Inheritance diagram for Literal:

Public Member Functions

 Literal (const DataFieldIdentifier &dataFieldIdentifier, const std::string &checkName, const VarList &checkParameters=createParameterList())
 Construct a literal using a datafieldidentifier object. More...
 
 Literal (const DataFieldIdentifierPtr &dataFieldIdentifier, const std::string &checkName, const VarList &checkParameters=createParameterList())
 Construct a literal using a datafieldidentifier pointer. More...
 
 Literal (const DatafieldRefBasePtr &datafieldRef, const std::string &checkName, const VarList &checkParameters=createParameterList())
 
 Literal (const std::string &dataFieldIdentifierStr, const std::string &checkName, const VarList &checkParameters=createParameterList())
 Construct a literal using a datafieldidentifier as string. More...
 
ParameterList toParamList (const VarList &varList) const
 
- Public Member Functions inherited from Term
TermImplPtr getImpl () const
 Retrieve term implementation object as used in the ArmarX Framework in order to build distributed expression trees. More...
 
Term operator! (void) const
 The logical NOT operator. More...
 
Term operator&& (const Term &right) const
 The logical AND operator. More...
 
Termoperator= (const Term &right)
 The assignment operator. More...
 
Term operator|| (const Term &right) const
 The logical OR operator. More...
 
 Term ()
 Construct an empty term. More...
 
 Term (const Term &other)
 Copy constructor. More...
 
 Term (TermImplPtr impl)
 Construct term by term implementation. More...
 

Static Public Member Functions

static VarList createParameterList ()
 Static helper method to create an empty parameterlist. More...
 
static VarList createParameterList (const Variant &param1)
 Static helper method to create a parameterlist. More...
 
static VarList createParameterList (const Variant &param1, const Variant &param2)
 Static helper method to create a parameterlist. More...
 
static VarList createParameterList (const Variant &param1, const Variant &param2, const Variant &param3)
 Static helper method to create a parameterlist. More...
 

Additional Inherited Members

- Protected Attributes inherited from Term
TermImplPtr termImpl
 

Detailed Description

Literals are part of the user front end of the ArmarX condition mechanism. Literals describe condition checks in the distributed ArmarX scenario.

See also
Conditions

Definition at line 208 of file Term.h.

Constructor & Destructor Documentation

◆ Literal() [1/4]

Literal ( const std::string &  dataFieldIdentifierStr,
const std::string &  checkName,
const VarList checkParameters = createParameterList() 
)

Construct a literal using a datafieldidentifier as string.

Parameters
dataFieldIdentifierStrdataFieldIdentifier as string
checkNamename of the check as available in the observer. The usual checks can be found in the namespace armarx::checks. For the available checks for the specific observer, check the Gui ObserverView while the Observer is running
checkParametersparameter list for the check

Definition at line 109 of file Term.cpp.

+ Here is the call graph for this function:

◆ Literal() [2/4]

Literal ( const DataFieldIdentifier dataFieldIdentifier,
const std::string &  checkName,
const VarList checkParameters = createParameterList() 
)

Construct a literal using a datafieldidentifier object.

Parameters
dataFieldIdentifierdataFieldIdentifier object
checkNamename of the check as available in the observer. The usual checks can be found in the namespace armarx::checks. For the available checks for the specific observer, check the Gui ObserverView while the Observer is running
checkParametersparameter list for the check

Definition at line 114 of file Term.cpp.

+ Here is the call graph for this function:

◆ Literal() [3/4]

Literal ( const DataFieldIdentifierPtr dataFieldIdentifier,
const std::string &  checkName,
const VarList checkParameters = createParameterList() 
)

Construct a literal using a datafieldidentifier pointer.

Parameters
dataFieldIdentifierdataFieldIdentifier pointer
checkNamename of the check as available in the observer. The usual checks can be found in the namespace armarx::checks. For the available checks for the specific observer, check the Gui ObserverView while the Observer is running
checkParametersparameter list for the check

Definition at line 119 of file Term.cpp.

+ Here is the call graph for this function:

◆ Literal() [4/4]

Literal ( const DatafieldRefBasePtr &  datafieldRef,
const std::string &  checkName,
const VarList checkParameters = createParameterList() 
)

Definition at line 124 of file Term.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ createParameterList() [1/4]

VarList createParameterList ( )
static

Static helper method to create an empty parameterlist.

Returns
parameterlist as required for the construction of a literal

Definition at line 129 of file Term.cpp.

+ Here is the caller graph for this function:

◆ createParameterList() [2/4]

VarList createParameterList ( const Variant param1)
static

Static helper method to create a parameterlist.

Parameters
param1first parameter
Returns
parameterlist as required for the construction of a literal

Definition at line 134 of file Term.cpp.

+ Here is the call graph for this function:

◆ createParameterList() [3/4]

VarList createParameterList ( const Variant param1,
const Variant param2 
)
static

Static helper method to create a parameterlist.

Parameters
param1first parameter
param2second parameter
Returns
parameterlist as required for the construction of a literal

Definition at line 142 of file Term.cpp.

+ Here is the call graph for this function:

◆ createParameterList() [4/4]

VarList createParameterList ( const Variant param1,
const Variant param2,
const Variant param3 
)
static

Static helper method to create a parameterlist.

Parameters
param1first parameter
param2second parameter
param3third parameter
Returns
parameterlist as required for the construction of a literal

Definition at line 151 of file Term.cpp.

+ Here is the call graph for this function:

◆ toParamList()

ParameterList toParamList ( const VarList varList) const

Definition at line 161 of file Term.cpp.

+ Here is the caller graph for this function:

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