Actin  Version 5.5.5
Software for Robotics Simulation and Control
EcXmlPairType< FirstType, SecondType > Class Template Reference

An XML readable/writable Pair. Can hold any to types of XML objects. More...

#include <ecXmlPairType.h>

Inheritance diagram for EcXmlPairType< FirstType, SecondType >:
[legend]
Collaboration diagram for EcXmlPairType< FirstType, SecondType >:
[legend]

Public Types

typedef std::pair< FirstType, SecondType > PairContainer
 convenience typedef of the pair container
 

Public Member Functions

 ECXMLOBJECT (EcXmlPairType)
 ECXMLOBJECT(cls) EcXmlObject class convenience macro
 
 EcXmlPairType (FirstType first, SecondType second)
 single value constructor
 
virtual const FirstType & first () const
 get the first value
 
virtual FirstType & first ()
 get the first value (nonconst)
 
virtual void setFirst (const FirstType &first)
 set the first value
 
virtual const SecondType & second () const
 get the second value
 
virtual SecondType & second ()
 get the second value (nonconst)
 
virtual void setSecond (const SecondType &second)
 set the second value
 
virtual void set (const FirstType &first, const SecondType &second)
 set both first and second values
 
virtual const PairContainerpairContainer () const
 gets a const reference to the pair container
 
virtual PairContainerpairContainer ()
 gets a non const reference to the pair container
 
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 schema
 
void setXmlTagNames (const EcString &first, const EcString &second)
 sets the XML tag names for the pair
 
- Public Member Functions inherited from EcXmlObject
 ECDECLARE_BIGFOUR (EcXmlObject)
 
virtual EcXmlObjectclone () const =0
 clone
 
virtual EcBoolean xmlInit ()
 xml-initialize
 
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
 
virtual EcBoolean equality (const EcXmlObject *other) const =0
 equality - a virtual equality to an EcXmlObject pointer
 
virtual EcXmlObjectnewObject () const =0
 creates new object - a virtual new to an EcXmlObject pointer
 
virtual const EcTokentoken () const =0
 gets the xml token used for writing out.
 

Protected Attributes

PairContainer m_PairContainer
 Internal representation.
 
EcStringStringPair m_TagNames
 XML tag names.
 
- Protected Attributes inherited from EcXmlObject
EcU8 m_State
 the state of the object - eight boolean flags
 

Additional Inherited Members

- 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

template<class FirstType, class SecondType>
class EcXmlPairType< FirstType, SecondType >

An XML readable/writable Pair. Can hold any to types of XML objects.

Template Parameters
FirstTypethe first XML object type of the pair
SecondTypethe second XML object type of the pair

Definition at line 19 of file ecXmlPairType.h.


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