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

Holds a description of a vector of general end effectors. More...

#include <ecPositionControlMethodVector.h>

Inheritance diagram for EcPositionControlMethodVector:
EcXmlVariableVectorType< ElementType > EcXmlBaseVariableCompoundType EcXmlObject

Public Member Functions

 EcPositionControlMethodVector ()
 default constructor
 
virtual ~EcPositionControlMethodVector ()
 destructor
 
 EcPositionControlMethodVector (const EcPositionControlMethodVector &orig)
 copy constructor
 
EcPositionControlMethodVectoroperator= (const EcPositionControlMethodVector &orig)
 assignment operator
 
EcBoolean operator== (const EcPositionControlMethodVector &orig) const
 equality operator
 
virtual EcBoolean equality (const EcXmlObject *other) const EC_OVERRIDE
 equality - a virtual equality to an EcXmlObject pointer
 
virtual EcXmlObjectnewObject () const EC_OVERRIDE
 virtual new that returns an EcXmlObject
 
virtual const EcTokentoken () const EC_OVERRIDE
 return a string token
 
virtual EcXmlObjectclone () const EC_OVERRIDE
 clone - a virtual constructor to an EcXmlObject pointer
 
virtual void registerComponents ()
 register components with the parent
 
virtual void registerComponentCreators () EC_OVERRIDE
 register all component creators
 
- Public Member Functions inherited from EcXmlVariableVectorType< ElementType >
 ECXMLOBJECT (EcXmlVariableVectorType)
 
 EcXmlVariableVectorType (EcSizeT size)
 constructor of vector size
 
virtual const ElementType & operator[] (EcSizeT index) const
 get by index - const version
 
virtual ElementType & operator[] (EcSizeT index)
 get by index - nonconst version
 
virtual EcBoolean exchange (EcSizeT index, const ElementType &newValue)
 exhange one entry with another if the other exists
 
virtual EcBoolean erase (const EcSizeT index)
 erase one element
 
virtual EcBoolean erase (const EcSizeT first, const EcSizeT last)
 erase a range of elements
 
const ElementType & back () const
 get back
 
ElementType & back ()
 get back
 
virtual void pushBack (const ElementType &element)
 push a copy of an object onto the vector
 
virtual const VectorContainervectorContainer () const
 get the vector container
 
virtual void reserve (EcSizeT size)
 reserve space in the vector container
 
virtual void resize (EcSizeT size)
 resize the vector container
 
virtual void clear ()
 clear all entries in the vector container
 
virtual void assign (EcSizeT size, ElementType &obj)
 assign an object to a range of values
 
virtual EcSizeT size () const
 get the length of the vector
 
virtual EcBoolean read (EcXmlReader &stream) EC_OVERRIDE
 read this object from an XML stream
 
virtual EcBoolean write (EcXmlWriter &stream) const EC_OVERRIDE
 write this object to an XML stream
 
virtual EcBoolean writeSchema (EcXmlSchema &stream) const EC_OVERRIDE
 write this object to an XML stream
 
virtual EcBoolean writeHeaderToStream (std::ostream &stream, EcXmlWriter *&pWriter, const EcString &streamName, const EcToken &objectName=EcXml::EcDefaultToken) const
 write the header for this object to an ostream
 
virtual EcBoolean writeBodyToStream (EcXmlWriter *pWriter) const
 write the body (the elements) of this vector to an ostream
 
virtual EcBoolean appendElementToStream (EcXmlWriter *pWriter, const ElementType &element) const
 append an element to an ostream
 
virtual EcBoolean writeFooterToStream (EcXmlWriter *&pWriter) const
 
- Public Member Functions inherited from EcXmlBaseVariableCompoundType
 ECDECLARE_BIGFOUR (EcXmlBaseVariableCompoundType)
 
virtual EcBoolean xmlInit () EC_OVERRIDE
 xml-initialize
 
virtual void registerComponentCreator (const EcToken &token, EcXmlObjectCreator creator)
 register a single optional component
 
virtual EcXmlObjectnewObjectFromToken (const EcToken &token) const
 create a new object from its token
 
virtual const EcXmlStringVectoraddLibraries () const
 gets the library names (minus extension)
 
virtual void setAddLibraries (const EcXmlStringVector &addLibraries)
 sets the library names (minus extension)
 
virtual const EcXmlCreatorMapcreatorMap () const
 gets the creator map
 
- 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
 

Additional Inherited Members

- Public Types inherited from EcXmlVariableVectorType< ElementType >
typedef std::vector< ElementType * > VectorContainer
 VectorContainer type from std::vector.
 
- Protected Member Functions inherited from EcXmlVariableVectorType< ElementType >
virtual EcBoolean readValueFromToken (const EcToken &token, EcXmlReader &stream) EC_OVERRIDE
 
- Protected Member Functions inherited from EcXmlBaseVariableCompoundType
virtual void processLibraries ()
 process the add libraries
 
- Protected Attributes inherited from EcXmlVariableVectorType< ElementType >
VectorContainer m_VectorContainer
 XML data.
 
- Protected Attributes inherited from EcXmlBaseVariableCompoundType
EcXmlFactory m_XmlFactory
 A map holding the relationship between string labels and subcomponents.
 
EcXmlStringVector m_AddLibraries
 the arry of library names
 
- Protected Attributes inherited from EcXmlObject
EcU8 m_State
 the state of the object - eight boolean flags
 
- 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

Holds a description of a vector of general end effectors.

Holds a description of a vector of general position control methods.

Definition at line 19 of file ecPositionControlMethodVector.h.


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.