Detailed Description

Rti convenience wrapper for relabeling maps.

The observer plugin uses an STL map from integers to sets of integers as re-labeling map. In order to support this data type in the libfaudes run-time interface, we provide a wrapper class that is derived from faudes Type. The implementation is minimla (no token io). Later revisions may use a faudes set with set valued attributes.

Definition at line 1097 of file op_observercomputation.h.

#include <op_observercomputation.h>

Public Member Functions

 EventRelabelMap (void)
 Rti wrapper class implementation. More...
 
 EventRelabelMap (const EventRelabelMap &rOther)
 
virtual ~EventRelabelMap (void)
 
virtual void Clear (void)
 Clear configuration data. More...
 
const std::map< Idx, std::set< Idx > > & StlMap (void) const
 
std::map< Idx, std::set< Idx > > & StlMap (void)
 
void StlMap (const std::map< Idx, std::set< Idx > > &rMap)
 
- Public Member Functions inherited from faudes::Type
 Type (void)
 Constructor. More...
 
 Type (const Type &rType)
 Copy constructor. More...
 
virtual ~Type (void)
 Destructor. More...
 
virtual TypeNew (void) const
 Construct on heap. More...
 
virtual TypeCopy (void) const
 Construct on heap. More...
 
virtual const TypeCast (const Type *pOther) const
 Cast other object to this type. More...
 
virtual TypeAssign (const Type &rSrc)
 Assign configuration data from other object. More...
 
virtual Typeoperator= (const Type &rSrc)
 Assign configurationdata from other object. More...
 
virtual bool Equal (const Type &rOther) const
 Test equality of configuration data. More...
 
virtual bool operator== (const Type &rOther) const
 Test equality of configuration data. More...
 
virtual bool operator!= (const Type &rOther) const
 Test equality of configuration data. More...
 
virtual void Name (const std::string &rName)
 Set the objects's name. More...
 
virtual const std::string & Name (void) const
 Get objects's name. More...
 
virtual const std::string & TypeName (void) const
 Get objects's type name. More...
 
void Write (const Type *pContext=0) const
 Write configuration data to console. More...
 
void Write (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
 Write configuration data to a file. More...
 
void Write (const std::string &pFileName, std::ios::openmode openmode) const
 Write configuration data to a file. More...
 
void Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data to TokenWriter. More...
 
virtual void XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data to an XML file. More...
 
void XWrite (const Type *pContext=0) const
 Write configuration data in XML format to concole Note: this write function uses the virtual function DoXWrite(), to be reimplemented by derived classes. More...
 
void XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data in XML format to TokenWriter. More...
 
std::string ToString (const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data to a string. More...
 
std::string ToText (const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data to a formated string. More...
 
void DWrite (const Type *pContext=0) const
 Write configuration data to console, debugging format. More...
 
void DWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
 Write configuration data to a file, debugging format. More...
 
void DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data in debug format to TokenWriter. More...
 
void SWrite (TokenWriter &rTw) const
 Write statistics comment to TokenWriter. More...
 
void SWrite (void) const
 Write statistics comment to console. More...
 
std::string ToSText (void) const
 Write statistics to a string. More...
 
void Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)
 Read configuration data from file with label specified. More...
 
void FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)
 Read configuration data from a string. More...
 
void Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 Read configuration data from TokenReader with label sepcified. More...
 

Protected Member Functions

virtual void DoAssign (const EventRelabelMap &rSrc)
 
virtual bool DoEqual (const EventRelabelMap &rOther) const
 
- Protected Member Functions inherited from faudes::Type
void DoAssign (const Type &rSrc)
 Assign configuration data from other object. More...
 
bool DoEqual (const Type &rOther) const
 Test equality of configuration data. More...
 
virtual void DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 Read configuration data of this object from TokenReader. More...
 
virtual void DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data of this object to TokenWriter. More...
 
virtual void DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data of this object to TokenWriter in XML format. More...
 
virtual void DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write configuration data in debugging format to TokenWriter. More...
 
virtual void DoSWrite (TokenWriter &rTw) const
 Write statistical data as a comment to TokenWriter. More...
 
virtual const TypeDefinitionTypeDefinitionp (void) const
 Get objects's type definition. More...
 
virtual Token XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const
 

Protected Attributes

std::map< Idx, std::set< Idx > > mMap
 

Constructor & Destructor Documentation

◆ EventRelabelMap() [1/2]

faudes::EventRelabelMap::EventRelabelMap ( void  )

Rti wrapper class implementation.

Definition at line 1946 of file op_observercomputation.cpp.

◆ EventRelabelMap() [2/2]

faudes::EventRelabelMap::EventRelabelMap ( const EventRelabelMap rOther)

Definition at line 1947 of file op_observercomputation.cpp.

◆ ~EventRelabelMap()

faudes::EventRelabelMap::~EventRelabelMap ( void  )
virtual

Definition at line 1948 of file op_observercomputation.cpp.

Member Function Documentation

◆ Clear()

void faudes::EventRelabelMap::Clear ( void  )
virtual

Clear configuration data.

Derived classes should re-implement this method to ensure some consistent configuration data.

Reimplemented from faudes::Type.

Definition at line 1951 of file op_observercomputation.cpp.

◆ DoAssign()

void faudes::EventRelabelMap::DoAssign ( const EventRelabelMap rSrc)
protectedvirtual

Definition at line 1954 of file op_observercomputation.cpp.

◆ DoEqual()

bool faudes::EventRelabelMap::DoEqual ( const EventRelabelMap rOther) const
protectedvirtual

Definition at line 1955 of file op_observercomputation.cpp.

◆ StlMap() [1/3]

void faudes::EventRelabelMap::StlMap ( const std::map< Idx, std::set< Idx > > &  rMap)

Definition at line 1960 of file op_observercomputation.cpp.

◆ StlMap() [2/3]

std::map< Idx, std::set< Idx > > & faudes::EventRelabelMap::StlMap ( void  )

Definition at line 1959 of file op_observercomputation.cpp.

◆ StlMap() [3/3]

const std::map< Idx, std::set< Idx > > & faudes::EventRelabelMap::StlMap ( void  ) const

Definition at line 1958 of file op_observercomputation.cpp.

Member Data Documentation

◆ mMap

std::map<Idx, std::set<Idx> > faudes::EventRelabelMap::mMap
protected

Definition at line 1114 of file op_observercomputation.h.


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

libFAUDES 2.32b --- 2024.03.01 --- c++ api documentaion by doxygen