AuboCaps  0.6.0
arcs::aubo_scope::Expression Class Reference

#include <expression.h>

Public Member Functions

 Expression (Expression &f)
 
 Expression (Expression &&f)
 
virtual ~Expression ()
 
std::string toString ()
 
void append (const std::string &expressionPart)
 Append a string part of the expression. More...
 
void appendVariable (VariablePtr variable)
 Append a variable object to the expression. More...
 
void appendFeature (FeaturePtr feature)
 Append a Feature object to the expression. More...
 
void appendWaypoint (WaypointPtr waypoint)
 Append a waypoint to the expression. More...
 
void appendIo (IoPtr io)
 Append an I/O object to the expression. More...
 

Private Member Functions

 Expression ()
 

Private Attributes

void * d_ { nullptr }
 

Friends

class DataSwitch
 

Detailed Description

An expression can be used for, e.g. configuration of various built-in program nodes, such as If and Wait nodes. Expressions are typically conditional expressions (which evaluates to true or false).

An Expression is built using the ExpressionBuilder interface.

Definition at line 25 of file expression.h.

Constructor & Destructor Documentation

arcs::aubo_scope::Expression::Expression ( Expression f)
arcs::aubo_scope::Expression::Expression ( Expression &&  f)
virtual arcs::aubo_scope::Expression::~Expression ( )
virtual
arcs::aubo_scope::Expression::Expression ( )
private

Member Function Documentation

void arcs::aubo_scope::Expression::append ( const std::string &  expressionPart)

Append a string part of the expression.

This can be anything that is valid in an expression or even the full expression if it does not contain references to any entities (such as variables and features among others).

Parameters
expressionPartthe expression part to be appended.
Returns
the ExpressionBuilder
void arcs::aubo_scope::Expression::appendFeature ( FeaturePtr  feature)

Append a Feature object to the expression.

When this part is evaluated the pose of the Feature is used.

Parameters
featurethe Feature to append
Returns
the ExpressionBuilder
void arcs::aubo_scope::Expression::appendIo ( IoPtr  io)

Append an I/O object to the expression.

Parameters
iothe I/O to append.
Returns
the ExpressionBuilder
void arcs::aubo_scope::Expression::appendVariable ( VariablePtr  variable)

Append a variable object to the expression.

Parameters
variablethe variable to append.
Returns
the ExpressionBuilder
void arcs::aubo_scope::Expression::appendWaypoint ( WaypointPtr  waypoint)

Append a waypoint to the expression.

When this part is evaluated the pose of the waypoint is used.

Parameters
waypointthe waypoint to append
Returns
the ExpressionBuilder
std::string arcs::aubo_scope::Expression::toString ( )

Friends And Related Function Documentation

friend class DataSwitch
friend

Definition at line 79 of file expression.h.

Member Data Documentation

void* arcs::aubo_scope::Expression::d_ { nullptr }
private

Definition at line 81 of file expression.h.


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