Actin®  Version 5.2.0
Software for Robotics Simulation and Control
EcControlExpressionColumnTableFunction Class Reference

This evaluates a table function on the child. The input and the output are columns. More...

#include <ecContExpColumnTableFunction.h>

Inheritance diagram for EcControlExpressionColumnTableFunction:
EcExpressionElement EcBaseExpressionTreeElement EcXmlCompoundType EcXmlObject

Public Member Functions

 EcControlExpressionColumnTableFunction ()
 default constructor
 
 EcControlExpressionColumnTableFunction (const EcControlExpressionContainer *containerPointer)
 constructor from an EcControlExpressionContainer pointer
 
virtual ~EcControlExpressionColumnTableFunction ()
 destructor
 
 EcControlExpressionColumnTableFunction (const EcControlExpressionColumnTableFunction &orig)
 copy constructor
 
EcControlExpressionColumnTableFunctionoperator= (const EcControlExpressionColumnTableFunction &orig)
 assignment operator
 
EcBoolean operator== (const EcControlExpressionColumnTableFunction &orig) const
 equality operator
 
virtual EcBoolean xmlInit () EC_OVERRIDE
 initialize XML components for reading and writing
 
virtual EcXmlObjectclone () const EC_OVERRIDE
 clone - a virtual constructor to an EcXmlObject pointer
 
virtual EcBoolean equality (const EcXmlObject *other) const EC_OVERRIDE
 equality - virtual equality to an EcXmlObject pointer
 
virtual EcXmlObjectnewObject () const EC_OVERRIDE
 
virtual const EcVelocityControlDatavalue () const EC_OVERRIDE
 
virtual void registerComponents () EC_OVERRIDE
 registers components with the parent
 
virtual void setContainer (const EcXmlBaseVariableCompoundType *container) EC_OVERRIDE
 
virtual const EcControlExpressionContainerinputValuesContainer () const
 
virtual void setInputValuesContainer (const EcControlExpressionContainer &inputValuesContainer)
 
virtual void setInputValuesElement (const EcExpressionElement &inputValuesElement)
 
virtual const EcCompositeFunctionContainertableFunctionContainer () const
 
virtual void setTableFunctionContainer (const EcCompositeFunctionContainer &tableFunctionContainer)
 
virtual void setTableFunctionElement (const EcCompositeFunctionElement &tableFunctionElement)
 
virtual const EcTokentoken () const EC_OVERRIDE
 
virtual EcBoolean read (EcXmlReader &stream) EC_OVERRIDE
 
virtual EcBoolean write (EcXmlWriter &stream) const EC_OVERRIDE
 
- Public Member Functions inherited from EcExpressionElement
 EcExpressionElement ()
 default constructor - should not be used
 
 EcExpressionElement (const EcExpressionContainer *containerPointer)
 constructor from an EcExpressionContainer pointer
 
virtual ~EcExpressionElement ()
 destructor
 
 EcExpressionElement (const EcExpressionElement &orig)
 copy constructor
 
EcExpressionElementoperator= (const EcExpressionElement &orig)
 assignment operator
 
EcBoolean operator== (const EcExpressionElement &orig) const
 equality operator
 
- Public Member Functions inherited from EcBaseExpressionTreeElement
 EcBaseExpressionTreeElement ()
 default constructor
 
 EcBaseExpressionTreeElement (const EcXmlBaseVariableCompoundType *containerPointer)
 constructor given container pointer
 
virtual ~EcBaseExpressionTreeElement ()
 destructor
 
 EcBaseExpressionTreeElement (const EcBaseExpressionTreeElement &orig)
 copy constructor
 
EcBaseExpressionTreeElementoperator= (const EcBaseExpressionTreeElement &orig)
 assignment operator
 
EcBoolean operator== (const EcBaseExpressionTreeElement &orig) const
 equality operator
 
virtual const EcXmlBaseVariableCompoundTypecontainer () const
 gets the container
 
- Public Member Functions inherited from EcXmlCompoundType
 ECDECLARE_BIGFOUR (EcXmlCompoundType)
 
virtual EcBoolean readAttributes (EcXmlReader &stream)
 read object attributes from an XML stream
 
virtual EcBoolean readElements (EcXmlReader &stream)
 read object elements from an XML stream
 
virtual EcBoolean writeAttributes (EcXmlWriter &stream) const
 write object attributes to an XML stream
 
virtual EcBoolean writeElements (EcXmlWriter &stream) const
 write object elements to an XML stream
 
virtual EcBoolean writeSchema (EcXmlSchema &stream) const EC_OVERRIDE
 write schema
 
virtual EcBoolean writeSchemaAttributes (EcXmlSchema &stream) const
 write schema attributes
 
virtual EcBoolean writeSchemaElements (EcXmlSchema &stream) const
 write schema elements
 
virtual void registerComponent (const EcToken &token, EcXmlObject *obj)
 register a single component More...
 
virtual void registerComponent (EcXmlObject *obj)
 register a single component More...
 
virtual void registerComponentReadOnly (const EcToken &token, EcXmlObject *obj)
 register a single component as read-only More...
 
virtual const EcXmlComponentMapcomponentMap () const
 get a reference to the component map
 
virtual void registerAttributeComponent (const EcToken &AttribToken, EcXmlObject *Obj)
 register a single attribute component More...
 
virtual void registerAttributeComponentReadOnly (const EcToken &AttribToken, EcXmlObject *Obj)
 register a single attribute component read-only More...
 
virtual const EcXmlComponentMapattributeComponentMap ()
 get a reference to the component attribute map
 
virtual const EcXmlSpecialDescriptorMapspecialDescriptorMap ()
 get a reference to the special-descriptor map
 
virtual void registerComponentDescriptor (const EcToken &xmlToken, const EcToken &descriptorToken, const EcString &descriptorString)
 register an XML token-string descriptor More...
 
virtual const EcXmlTokenStringDescriptorMapMaptokenStringDescriptorMap ()
 get a reference to the XML token-string descriptor map
 
virtual EcBoolean hasChildren () const
 return EcTrue if there are children components or EcFalse if an empty element.
 
virtual EcBoolean hasAttributes () const
 return EcTrue if there are attributes in the element.
 
- Public Member Functions inherited from EcXmlObject
 ECDECLARE_BIGFOUR (EcXmlObject)
 
virtual EcBoolean readAttribute (EcXmlReader &stream)
 read this attribute from an XML stream
 
virtual EcBoolean createSchema (const EcString &filename, const EcToken &objectName=EcXml::EcDefaultToken) const
 create schema
 
virtual EcBoolean xmlInitialized () const
 get XML initialized flag. This bit is set on initialization.
 
virtual void setXmlInitialized (EcBoolean val=EcTrue)
 set XML initialized flag. This bit is set on initialization.
 
virtual EcBoolean specified () const
 get specified flag. This bit is set upon reading from an XML file.
 
virtual void setSpecified (EcBoolean val=EcTrue)
 set specified flag. This bit is set upon reading from an XML file.
 
virtual EcBoolean isBasicType () const
 Return true/false for basic type.
 
virtual EcBoolean equalsDefault () const
 tests equality of XML object with default
 

Static Public Member Functions

static EcControlExpressionColumnTableFunction nullObject ()
 
static const EcTokenclassToken ()
 
static EcXmlObjectcreator ()
 

Protected Attributes

EcControlExpressionContainer m_InputValuesContainer
 the input values container
 
EcCompositeFunctionContainer m_TableFunctionContainer
 the table function container
 
EcRealVector m_InputVector
 a utility vector to hold input values
 
- Protected Attributes inherited from EcExpressionElement
EcVelocityControlData m_Array
 a real array to cache the returned value
 
- Protected Attributes inherited from EcBaseExpressionTreeElement
const EcXmlBaseVariableCompoundTypem_pContainer
 a pointer to the container
 
- Protected Attributes inherited from EcXmlCompoundType
EcXmlComponentMapm_pComponentMap
 
EcXmlComponentMapm_pAttributeComponentMap
 
EcXmlSpecialDescriptorMapm_pSpecialDescriptorMap
 
EcXmlTokenStringDescriptorMapMapm_pComponentMapTokenStringDescriptor
 
- Protected Attributes inherited from EcXmlObject
EcU8 m_State
 the state of the object - eight boolean flags
 

Additional Inherited Members

- Public Types inherited from EcXmlCompoundType
enum  {
  READONLYCOMPONENT = 0,
  READONLYATTRIBUTE
}
 special-descriptor codes More...
 
- Protected Member Functions inherited from EcXmlCompoundType
virtual EcBoolean readValueFromToken (const EcToken &token, EcXmlReader &stream)
 
virtual EcBoolean readValueFromSpecialToken (const EcToken &token, EcXmlReader &stream)
 read value from unregistered token
 
virtual EcBoolean readAttributeFromToken (const EcToken &token, EcXmlReader &stream)
 
virtual EcXmlComponentMapnewComponentMap () const
 allocate a new componentMap
 
virtual EcXmlSpecialDescriptorMapnewSpecialDescriptorMap ()
 allocate a new specialDescriptorsMap
 
virtual EcXmlTokenStringDescriptorMapMapnewTokenStringDescriptorMap ()
 allocate a new tokenStringDescriptorsMap
 
virtual void createComponentMap () const
 create component map
 
virtual void createAttributeComponentMap ()
 create attribute component map
 
virtual void createSpecialDescriptorMap ()
 create special-descriptors map
 
virtual void createTokenStringDescriptorMap ()
 create token-string descriptor map
 
virtual EcBoolean isReadOnlyComponent (const EcToken token) const
 check to see if the token corresponds to a read-only component
 
virtual EcBoolean isReadOnlyAttribute (const EcToken token) const
 check to see if the token corresponds to a read-only attribute
 
virtual EcXmlObjectlibraryAttribute ()
 
- Static Protected Attributes inherited from EcXmlObject
static const EcU8 m_theXmlInitializedBit
 the bit used to describe xml initialization
 
static const EcU8 m_theSpecifiedBit
 the bit used to describe specification
 

Detailed Description

This evaluates a table function on the child. The input and the output are columns.

Definition at line 21 of file ecContExpColumnTableFunction.h.

Member Function Documentation

static const EcToken& EcControlExpressionColumnTableFunction::classToken ( )
static

token for this class

Returns
(EcToken&) The classs token
static EcXmlObject* EcControlExpressionColumnTableFunction::creator ( )
static

static creator function

Returns
(EcXmlObject*) the xml object pointer
virtual const EcControlExpressionContainer& EcControlExpressionColumnTableFunction::inputValuesContainer ( ) const
virtual

gets the input values container

Returns
(EcControlExpressionContainer&) The input values container
virtual EcXmlObject* EcControlExpressionColumnTableFunction::newObject ( ) const
virtual

virtual new that returns an EcXmlObject

Returns
(EcXmlObject*) The xml object

Implements EcXmlObject.

static EcControlExpressionColumnTableFunction EcControlExpressionColumnTableFunction::nullObject ( )
static

get a null object

Returns
(EcControlExpressionColumnTableFunction) The null object
virtual EcBoolean EcControlExpressionColumnTableFunction::read ( EcXmlReader stream)
virtual

read this object from an XML stream

Parameters
[in]stream(EcXmlReader&) stream to be read from xml file

Reimplemented from EcXmlCompoundType.

virtual void EcControlExpressionColumnTableFunction::setContainer ( const EcXmlBaseVariableCompoundType container)
virtual

sets the container

Parameters
[in]container(EcXmlBaseVariableCompoundType*) value to set the container

Reimplemented from EcBaseExpressionTreeElement.

virtual void EcControlExpressionColumnTableFunction::setInputValuesContainer ( const EcControlExpressionContainer inputValuesContainer)
virtual

sets the input values container

Parameters
[in]inputValuesContainer(EcControlExpressionContainer&) value to set the input value container
virtual void EcControlExpressionColumnTableFunction::setInputValuesElement ( const EcExpressionElement inputValuesElement)
virtual

sets the input values element

Parameters
[in]inputValuesElement(EcExpressionElement&) value to set the input values element of the container
virtual void EcControlExpressionColumnTableFunction::setTableFunctionContainer ( const EcCompositeFunctionContainer tableFunctionContainer)
virtual

sets the table function container

Parameters
[in]tableFunctionContainer(EcCompositeFunctionContainer&) Value to set the table fucntion container
virtual void EcControlExpressionColumnTableFunction::setTableFunctionElement ( const EcCompositeFunctionElement tableFunctionElement)
virtual

sets the table function element

Parameters
[in]tableFunctionElement(EcCompositeFunctionElement&) value to set the table function container element
virtual const EcCompositeFunctionContainer& EcControlExpressionColumnTableFunction::tableFunctionContainer ( ) const
virtual

gets the table function container

Returns
(EcCompositeFunctionContainer&) The composite dunction container
virtual const EcToken& EcControlExpressionColumnTableFunction::token ( ) const
virtual

return a token

Returns
(EcToken&) The xml token

Implements EcXmlObject.

virtual const EcVelocityControlData& EcControlExpressionColumnTableFunction::value ( ) const
virtual

return the value

Returns
(EcVelocityControlData&) the velocity control data

Implements EcExpressionElement.

virtual EcBoolean EcControlExpressionColumnTableFunction::write ( EcXmlWriter stream) const
virtual

write this object to an XML stream

Parameters
[in]stream(EcXmlWriter&) stream to be written into xml file

Reimplemented from EcXmlCompoundType.


The documentation for this class was generated from the following file:
Created by Energid Technologies www.energid.com
Copyright © 2016 Energid. All trademarks mentioned in this document are property of their respective owners.