Actin  Version 5.5.5
Software for Robotics Simulation and Control
EcXmlSetType< ElementType > Class Template Reference

An XML readable/writable set container. More...

#include <ecXmlSetType.h>

Inheritance diagram for EcXmlSetType< ElementType >:
[legend]
Collaboration diagram for EcXmlSetType< ElementType >:
[legend]

Public Types

typedef std::set< ElementType > SetContainer
 The SetContainer is a type definition based on std::set.
 

Public Member Functions

 ECXMLOBJECT (EcXmlSetType)
 ECXMLOBJECT(cls) EcXmlObject class convenience macro
 
 EcXmlSetType (const ElementType &value)
 single value constructor
 
virtual EcBoolean find (const ElementType &key) const
 find a value. Returns true if it is found, false otherwise.
 
virtual void clear ()
 erase all key/value pairs, leaving an empty set
 
virtual EcSizeT size () const
 get the size of the set 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
 
virtual void add (const ElementType &value)
 add an element to the set
 
virtual EcBoolean erase (const ElementType &key)
 erases an element in the set
 
virtual const SetContainersetContainer () const
 get the set container
 
virtual SetContainersetContainer ()
 get the non-const set container
 
- 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.
 

Static Public Member Functions

static SetContainer nullObject ()
 get a null value
 

Protected Attributes

SetContainer m_SetContainer
 the internal representation of the set.
 
- 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 ElementType>
class EcXmlSetType< ElementType >

An XML readable/writable set container.

Definition at line 16 of file ecXmlSetType.h.


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