ConditionRoot Class Reference

ConditionRoot Condition roots are top-level nodes of the expression tree. More...

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

+ Inheritance diagram for ConditionRoot:

Public Member Functions

void output (std::ostream &out) const override
 output to stream.
 
void update (const Ice::Current &c=Ice::emptyCurrent) override
 Update state f the ConditionRoot object based on the child.
 
void updateWithData (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.
 

Static Public Member Functions

static std::vector< LiteralImplPtr > ExtractLiterals (const TermImplBasePtr &expression)
 

Protected Member Functions

 ConditionRoot ()
 Creates an empty ConditionRoot.
 
 ConditionRoot (const EventListenerInterfacePrx &listener, const EventBasePtr &event, const std::string &description, bool onlyFireOnce, const DatafieldRefList &refs)
 Creates and initializes a ConditionRoot.
 
- 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
 
std::ostream & operator<< (std::ostream &stream, const ConditionRoot &rhs)
 stream operator for Condition
 
std::ostream & operator<< (std::ostream &stream, const ConditionRootPtr &rhs)
 stream operator for ConditionPtr
 

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

ConditionRoot Condition roots are top-level nodes of the expression tree.

Condition roots are the root node of expression tree. They have an event as member, which is fires once the expression described by the tree is fulfilled.

Constructor & Destructor Documentation

◆ ConditionRoot() [1/2]

ConditionRoot ( )
protected

Creates an empty ConditionRoot.

Used by Ice factory.

◆ ConditionRoot() [2/2]

ConditionRoot ( const EventListenerInterfacePrx & listener,
const EventBasePtr & event,
const std::string & description,
bool onlyFireOnce,
const DatafieldRefList & refs )
protected

Creates and initializes a ConditionRoot.

Used by ConditionHandler.

Member Function Documentation

◆ ExtractLiterals()

std::vector< LiteralImplPtr > ExtractLiterals ( const TermImplBasePtr & expression)
static

◆ output()

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

output to stream.

pure virtual.

Parameters
stream

Implements TermImpl.

◆ update()

void update ( const Ice::Current & c = Ice::emptyCurrent)
override

Update state f the ConditionRoot object based on the child.

Fire ConditionRoot::event if value is true. The event is only fired, if no previous event has been fired.

◆ updateWithData()

void updateWithData ( const Ice::Current & c = Ice::emptyCurrent)
override

Friends And Related Symbol Documentation

◆ ConditionHandler

friend class ConditionHandler
friend

◆ GenericFactory

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

◆ operator<< [1/2]

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

stream operator for Condition

◆ operator<< [2/2]

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

stream operator for ConditionPtr


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