Detailed Description

template<class Attr>
class faudes::TaNameSet< Attr >

Set of indices with symbolic names and attributes.

This class is derived from NameSet and the interface TAttrMap.

The file format is demonstrated by the following example of a set "Alphabet" consisting of events "alpha", "beta" and "gamma" with "gamma" having some attribute (see eg AtributeFlags)

<Alphabet> 
"alpha" 
"beta" 
"gamma" 0x0f
<\Alphabet> 

As with TBaseSet, reading a file silently ignores unknown attributes. Thus, the above example may also be read as NameSet.

Definition at line 588 of file cfl_nameset.h.

#include <cfl_nameset.h>

Public Member Functions
	TaNameSet (void)

	TaNameSet (const TaNameSet &rOtherSet)

	TaNameSet (const NameSet &rOtherSet)

	TaNameSet (const std::string &rFilename, const std::string &rLabel="")

virtual	~TaNameSet (void)

virtual TaNameSet &	Copy (const TBaseSet< Idx > &rSrc)

TaNameSet &	operator= (const NameSet &rSrc)

virtual bool	Insert (const Idx &rIndex)

virtual bool	Insert (const Idx &rIndex, const Attr &rAttr)

virtual Idx	Insert (const std::string &rName)

virtual Idx	Insert (const std::string &rName, const Attr &rAttr)

virtual void	InsertSet (const NameSet &rOtherSet)

virtual void	InsertSet (const TBaseSet< Idx > &rOtherSet)

virtual bool	Erase (const Idx &rIndex)

virtual bool	Erase (const std::string &rName)

virtual NameSet::Iterator	Erase (const Iterator &pos)

virtual void	EraseSet (const NameSet &rOtherSet)

virtual void	EraseSet (const TBaseSet< Idx > &rOtherSet)

virtual void	RestrictSet (const NameSet &rOtherSet)

virtual void	RestrictSet (const TBaseSet< Idx > &rOtherSet)

virtual void	Attributes (const TBaseSet< Idx > &rOtherSet)

virtual std::string	Str (const Idx &rIndex) const

virtual std::string	Str (void) const

const Attr *	AttributeType (void) const

Attr *	Attributep (const Idx &rElem)

const Attr &	Attribute (const Idx &rElem) const

void	Attribute (const Idx &rElem, const Attr &rAttr)

void	Attribute (const Idx &rElem, const Type &rAttr)

void	AttributeTry (const Idx &rElem, const Type &rAttr)

const Attr &	Attribute (const std::string &rName) const

Attr *	Attributep (const std::string &rName)

void	Attribute (const std::string &rName, const Attr &rAttr)

void	Attribute (const std::string &rName, const Type &rAttr)

Public Member Functions inherited from faudes::NameSet
	NameSet (void)

	NameSet (const NameSet &rOtherSet)

	NameSet (const std::string &rFilename, const std::string &rLabel="")

virtual	~NameSet (void)

SymbolTable *	SymbolTablep (void) const

void	SymbolTablep (SymbolTable *pSymTab)

bool	Insert (const Idx &rIndex)

Idx	Insert (const std::string &rName)

void	EraseSet (const NameSet &rOtherSet)

void	RestrictSet (const NameSet &rOtherSet)

void	SymbolicName (Idx index, const std::string &rName)

void	SymbolicName (const std::string &rName, const std::string &rNewName)

std::string	SymbolicName (Idx index) const

Idx	Index (const std::string &rName) const

bool	Exists (const Idx &rIndex) const

bool	Exists (const std::string &rName) const

NameSet::Iterator	Find (const Idx &rIndex) const

NameSet::Iterator	Find (const std::string &rName) const

NameSet	operator+ (const NameSet &rOtherSet) const

NameSet	operator- (const NameSet &rOtherSet) const

NameSet	operator* (const NameSet &rOtherSet) const

bool	operator<= (const NameSet &rOtherSet) const

bool	operator>= (const NameSet &rOtherSet) const

Public Member Functions inherited from faudes::TBaseSet< Idx >
	TBaseSet (void)

	TBaseSet (const TBaseSet &rOtherSet)

	TBaseSet (const std::string &rFilename, const std::string &rLabel="BaseSet")

virtual	~TBaseSet (void)

virtual void	Clear (void)

virtual bool	IsDefault (void) const

Idx	Size (void) const

bool	Empty (void) const

Iterator	Begin (void) const

Iterator	End (void) const

virtual bool	Valid (const Idx &rElem) const

virtual bool	Erase (const Idx &rElem)

virtual Iterator	Erase (const Iterator &pos)

virtual void	EraseSet (const TBaseSet &rOtherSet)

virtual void	RestrictSet (const TBaseSet &rOtherSet)

virtual bool	Disjoint (const TBaseSet &rOtherSet) const

virtual bool	Insert (const Idx &rElem)

virtual Iterator	Inject (const Iterator &pos, const Idx &rElem)

virtual void	Inject (const Idx &rElem)

virtual void	InsertSet (const TBaseSet &rOtherSet)

bool	Exists (const Idx &rElem) const

Iterator	Find (const Idx &rElem) const

TBaseSet	operator+ (const TBaseSet &rOtherSet) const

TBaseSet	operator- (const TBaseSet &rOtherSet) const

TBaseSet	operator* (const TBaseSet &rOtherSet) const

bool	operator<= (const TBaseSet &rOtherSet) const

bool	operator>= (const TBaseSet &rOtherSet) const

bool	operator< (const TBaseSet &rOtherSet) const

void	DValid (const std::string &rMessage="") const

void	Detach (DetachMode flag=AttrIncl) const

void	Lock (void) const

virtual bool	AttributeTest (const Type &rAttr) const

virtual TBaseSet &	CopyWithoutAttributes (const TBaseSet &rSourceSet)

virtual void	Attributes (const TBaseSet &rOtherSet)

Idx	AttributesSize (void) const

void	ClearAttributes (void)

bool	EqualAttributes (const TBaseSet &rOtherSet) const

virtual void	ClrAttribute (const Idx &rElem)

virtual void	FromStl (const std::set< Idx, std::less< Idx > > &rStlSet)

virtual void	ToStl (std::set< Idx, std::less< Idx > > &rStlSet) const

Public Member Functions inherited from faudes::ExtType
	ExtType (void)

	ExtType (const ExtType &rType)

virtual	~ExtType (void)

const std::string &	Name (void) const

void	Name (const std::string &rName)

virtual const std::string &	TypeName (void) const

virtual void	TypeName (const std::string &rType)

virtual const std::string &	ElementTag (void) const

virtual void	ElementTag (const std::string &rTag)

virtual const std::string &	ElementType (void) const

virtual const TypeDefinition *	TypeDefinitionp (void) const

Type &	operator= (const Type &rSrc)

Type &	operator= (Type &&rSrc)

bool	operator== (const Type &rOther) const

bool	operator!= (const Type &rOther) const

Public Member Functions inherited from faudes::AttrType
	AttrType (void)

	AttrType (const AttrType &rSrc)

virtual	~AttrType (void)

Type &	operator= (const Type &rSrc)

Type &	operator= (Type &&rSrc)

bool	operator== (const Type &rOther) const

bool	operator!= (const Type &rOther) const

Public Member Functions inherited from faudes::Type
	Type (void)

	Type (const Type &rType)

virtual	~Type (void)

virtual Type *	New (void) const

virtual Type *	NewCpy (void) const

virtual const Type *	Cast (const Type *pOther) const

virtual Type &	Copy (const Type &rSrc)

virtual Type &	Move (Type &rSrc)

Type &	operator= (const Type &rSrc)

Type &	operator= (Type &&rSrc)

virtual bool	Equal (const Type &rOther) const

bool	operator== (const Type &rOther) const

bool	operator!= (const Type &rOther) const

void	Write (const Type *pContext=0) const

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

void	Write (const std::string &pFileName, std::ios::openmode openmode) const

void	Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

virtual void	XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const

void	XWrite (const Type *pContext=0) const

void	XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

std::string	ToString (const std::string &rLabel="", const Type *pContext=0) const

std::string	ToText (const std::string &rLabel="", const Type *pContext=0) const

void	DWrite (const Type *pContext=0) const

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

void	DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

void	SWrite (TokenWriter &rTw) const

void	SWrite (void) const

std::string	ToSText (void) const

void	Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)

void	FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)

void	Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)

Public Member Functions inherited from faudes::TAttrMap< Idx, Attr >
	TAttrMap (TBaseSet< Idx, std::less< Idx > > *pBaseSetRef)

virtual	~TAttrMap (void)

void	CopyWithAttributes (const TBaseSet< Idx, std::less< Idx > > &rSourceSet)

const Attr *	AttributeType (void) const

Attr *	Attributep (const Idx &rElem)

const Attr &	Attribute (const Idx &rElem) const

void	Attribute (const Idx &rElem, const Type &attr)

void	Attribute (const Idx &rElem, const Attr &attr)

void	AttributeTry (const Idx &rElem, const Type &attr)

bool	Insert (const Idx &rElem)

bool	Insert (const Idx &rElem, const Attr &attr)

void	InsertSet (const TBaseSet< Idx, std::less< Idx > > &rOtherSet)

bool	Erase (const Idx &rElem)

TBaseSet< Idx, std::less< Idx > >::Iterator	Erase (const typename TBaseSet< Idx, std::less< Idx > >::Iterator &pos)

void	EraseSet (const TBaseSet< Idx, std::less< Idx > > &rOtherSet)

void	RestrictSet (const TBaseSet< Idx, std::less< Idx > > &rOtherSet)

Protected Member Functions
void	DoCopy (const TaNameSet &rSourceSet)

bool	DoEqual (const NameSet &rOtherSet) const

Protected Member Functions inherited from faudes::NameSet
void	DoCopy (const NameSet &rSourceSet)

void	DoMove (NameSet &rSourceSet)

bool	DoEqual (const NameSet &rOtherSet) const

virtual void	DoWrite (TokenWriter &tw, const std::string &rLabel="", const Type *pContext=0) const

virtual void	DoDWrite (TokenWriter &tw, const std::string &rLabel="", const Type *pContext=0) const

virtual void	DoXWrite (TokenWriter &tw, const std::string &rLabel="", const Type *pContext=0) const

virtual void	DoRead (TokenReader &tr, const std::string &rLabel="", const Type *pContext=0)

Protected Member Functions inherited from faudes::TBaseSet< Idx >
virtual void	DoWriteElement (TokenWriter &rTw, const Idx &rElem, const std::string &rLabel="", const Type *pContext=0) const

virtual void	DoXWriteElement (TokenWriter &rTw, const Idx &rElem, const std::string &rLabel="", const Type *pContext=0) const

virtual void	DoDWriteElement (TokenWriter &rTw, const Idx &rElem, const std::string &rLabel="", const Type *pContext=0) const

virtual void	DoReadElement (TokenReader &rTr, Idx &rElem, const std::string &rLabel, const Type *pContext)

virtual void	DoSWrite (TokenWriter &rTw) const

void	DoCopy (const TBaseSet &rSourceSet)

void	DoMove (TBaseSet &rSourceSet)

bool	DoEqual (const TBaseSet &rOtherSet) const

void	DoAttribute (const Idx &rElem, const Type *pAttr)

const AttributeVoid *	DoAttribute (const Idx &rElem) const

AttributeVoid *	DoAttributeExplicit (const Idx &rElem)

TBaseSet< Idx, std::less< Idx > >::Iterator	ThisIterator (const typename std::set< Idx, std::less< Idx > >::const_iterator &sit) const

void	RelinkClients (void)

void	AttachClient (TBaseSet *pRef) const

void	DetachClient (TBaseSet *pRef) const

void	AttachIterator (Iterator *pFit) const

void	DetachIterator (Iterator *pFit) const

Protected Member Functions inherited from faudes::AttrType
void	DoCopy (const AttrType &rSrc)

bool	DoEqual (const AttrType &rOther) const

Protected Member Functions inherited from faudes::Type
void	DoCopy (const Type &rSrc)

void	DoMove (Type &rSrc)

bool	DoEqual (const Type &rOther) const

virtual Token	XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const

Friends
class	NameSet

Additional Inherited Members
Public Types inherited from faudes::TBaseSet< Idx >
enum	DetachMode

typedef Iterator	CIterator

Static Public Member Functions inherited from faudes::AttrType
static void	Skip (TokenReader &rTr)

Protected Types inherited from faudes::TBaseSet< Idx >
typedef std::set< Idx, std::less< Idx > >::iterator	iterator

typedef std::set< Idx, std::less< Idx > >::const_iterator	const_iterator

typedef std::map< Idx, AttributeVoid * >::iterator	aiterator

typedef std::map< Idx, AttributeVoid * >::const_iterator	const_aiterator

Protected Types inherited from faudes::TAttrMap< Idx, Attr >
typedef TBaseSet< Idx, std::less< Idx > >::iterator	iterator

typedef TBaseSet< Idx, std::less< Idx > >::const_iterator	const_iterator

typedef TBaseSet< Idx, std::less< Idx > >::aiterator	aiterator

typedef TBaseSet< Idx, std::less< Idx > >::const_aiterator	const_aiterator

Static Protected Member Functions inherited from faudes::TBaseSet< Idx >
static std::set< Idx, std::less< Idx > > *	GlobalEmptySet (void)

static std::map< Idx, AttributeVoid * > *	GlobalEmptyAttributes (void)

Protected Attributes inherited from faudes::NameSet
SymbolTable *	mpSymbolTable

Protected Attributes inherited from faudes::TBaseSet< Idx >
std::set< Idx, std::less< Idx > > *	pSet

std::set< Idx, std::less< Idx > > *	mpSet

std::map< Idx, AttributeVoid * > *	pAttributes

std::map< Idx, AttributeVoid * > *	mpAttributes

TBaseSet< Idx, std::less< Idx > > *	pHostSet

std::list< TBaseSet< Idx, std::less< Idx > > * >::iterator	mClientRecord

std::list< TBaseSet< Idx, std::less< Idx > > * > *	mpClients

bool	mDetached

bool	mLocked

std::set< Iterator * >	mIterators

std::set< Idx, std::less< Idx > > *	pGes

std::map< Idx, AttributeVoid * > *	pGea

Protected Attributes inherited from faudes::ExtType
std::string	mElementType

std::string	mElementTagDef

std::string	mObjectName

Protected Attributes inherited from faudes::TAttrMap< Idx, Attr >
TBaseSet< Idx, std::less< Idx > > *	pBaseSet

Constructor & Destructor Documentation

◆ TaNameSet() [1/4]

template<class Attr >

faudes::TaNameSet< Attr >::TaNameSet ( void )

Constructor for NameSet referring to the static SymbolTable.

Definition at line 1157 of file cfl_nameset.h.

◆ TaNameSet() [2/4]

template<class Attr >

faudes::TaNameSet< Attr >::TaNameSet ( const TaNameSet< Attr > & rOtherSet )

Copy-constructor from other TaNameSet (incl attributes and symboltable)

Parameters

rOtherSet Set to copy

Definition at line 1168 of file cfl_nameset.h.

◆ TaNameSet() [3/4]

template<class Attr >

faudes::TaNameSet< Attr >::TaNameSet ( const NameSet & rOtherSet )

Constructor from NameSet (sets default attributes, same symboltable)

Parameters

rOtherSet Set to copy

Definition at line 1178 of file cfl_nameset.h.

◆ TaNameSet() [4/4]

template<class Attr >

faudes::TaNameSet< Attr >::TaNameSet	(	const std::string &	rFilename,
		const std::string &	rLabel = `""`
	)

Constructor from file. This constructor reads a NameSet from a file using the DoRead(TokenReader&, const std::String&) function. The section is specified by rLabel and the static SymbolTable is used.

Parameters

rFilename	Name of File
rLabel	Section for the set in the file;

Definition at line 1189 of file cfl_nameset.h.

◆ ~TaNameSet()

template<class Attr >

virtual faudes::TaNameSet< Attr >::~TaNameSet ( void )

inlinevirtual

Virtual destructor

Definition at line 644 of file cfl_nameset.h.

Member Function Documentation

◆ Attribute() [1/6]

template<class Attr >

const Attr & faudes::TaNameSet< Attr >::Attribute ( const Idx & rElem ) const

inlinevirtual

Attribute access. This virtual function provides an interface for derived classes with attributes eg TaIndexSet. The TBaseSet has no attributes and thus returns a void attribute. Derived classes that provide attributes are meant to return the attribute specified by rElem.

Parameters

rElem Element of which the attribute is requested

Returns: Attribute of specified element

Reimplemented from faudes::TBaseSet< Idx >.

Definition at line 888 of file cfl_nameset.h.

◆ Attribute() [2/6]

template<class Attr >

void faudes::TaNameSet< Attr >::Attribute	(	const Idx &	rElem,
		const Attr &	rAttr
	)

inline

Definition at line 889 of file cfl_nameset.h.

◆ Attribute() [3/6]

template<class Attr >

void faudes::TaNameSet< Attr >::Attribute	(	const Idx &	rElem,
		const Type &	rAttr
	)

inlinevirtual

Attribute access. This virtual function provides an interface for derived classes with attributes eg TaIndexSet. The TBaseSet itself has void attributes and thus formally accepts any nontrivial attribute, however, ignoring any value. Derived classes that provide attributes are meant to set the attribute as specified. Only if the required cast to the actual attribute type fails an exception is thrown.

Parameters

rElem	Element of which the attribute is to be set
rAttr	Attribute value to set.

Exceptions

Exception

Element does not exist (60)
Cannot cast attribute type (63)

Reimplemented from faudes::TBaseSet< Idx >.

Definition at line 890 of file cfl_nameset.h.

◆ Attribute() [4/6]

template<class Attr >

const Attr & faudes::TaNameSet< Attr >::Attribute ( const std::string & rName ) const

inline

Definition at line 894 of file cfl_nameset.h.

◆ Attribute() [5/6]

template<class Attr >

void faudes::TaNameSet< Attr >::Attribute	(	const std::string &	rName,
		const Attr &	rAttr
	)

inline

Definition at line 900 of file cfl_nameset.h.

◆ Attribute() [6/6]

template<class Attr >

void faudes::TaNameSet< Attr >::Attribute	(	const std::string &	rName,
		const Type &	rAttr
	)

inline

Definition at line 903 of file cfl_nameset.h.

◆ Attributep() [1/2]

template<class Attr >

Attr * faudes::TaNameSet< Attr >::Attributep ( const Idx & rElem )

inlinevirtual

Attribute access. This virtual function provides an interface for derived classes with attributes eg TaIndexSet. The TBaseSet has no attributes and thus throws an exception. Derived classes that provide attributes are meant to return a pointer to the attribute specified by rElem.

Parameters

rElem Element of which the attribute is requested

Returns: Attribute of specified element

Exceptions

Exception

No attributes provided (id 63)

Reimplemented from faudes::TBaseSet< Idx >.

Definition at line 887 of file cfl_nameset.h.

◆ Attributep() [2/2]

template<class Attr >

Attr * faudes::TaNameSet< Attr >::Attributep ( const std::string & rName )

inline

Definition at line 897 of file cfl_nameset.h.

◆ Attributes()

template<class Attr >

void faudes::TaNameSet< Attr >::Attributes ( const TBaseSet< Idx > & rOtherSet )

virtual

Set attributes. Provided that rOtherSet has attributes that can be casted to the appropriate type, attributes are copied per element from rOtherSet. Elements of this set which are not in rOtherSet maintain their attribute.

Parameters

rOtherSet Other IndexSet

Exceptions

Exception

Element does not exist (63)
Cannot cast attribute type (63)
Cannot cast to NameSet (63)

Definition at line 1427 of file cfl_nameset.h.

◆ AttributeTry()

template<class Attr >

void faudes::TaNameSet< Attr >::AttributeTry	(	const Idx &	rElem,
		const Type &	rAttr
	)

inlinevirtual

Attribute access. This virtual function provides an interface for derived classes with attributes eg TaIndexSet. It is meant to try to set the attribute as specified if the type can be casted. Otherwise it does nothing.

Parameters

rElem	Element of which the attribute is to be set
rAttr	Attribute value to set.

Reimplemented from faudes::TBaseSet< Idx >.

Definition at line 891 of file cfl_nameset.h.

◆ AttributeType()

template<class Attr >

const Attr * faudes::TaNameSet< Attr >::AttributeType ( void ) const

inlinevirtual

resolve ambiguities from attribute interface ("using" wont do the job)

Reimplemented from faudes::TBaseSet< Idx >.

Definition at line 886 of file cfl_nameset.h.

◆ Copy()

template<class Attr >

TaNameSet< Attr > & faudes::TaNameSet< Attr >::Copy ( const TBaseSet< Idx > & rSrc )

virtual

Relaxed assignment method (uses base class to maintain attributes)

Runtimetype check for TransSet, maintains attributes provided they can be casted.

Parameters

rSrc	Source from which to assign

Returns: Ref to this set

Definition at line 1225 of file cfl_nameset.h.

◆ DoCopy()

template<class Attr >

void faudes::TaNameSet< Attr >::DoCopy ( const TaNameSet< Attr > & rSourceSet )

protected

Copy to other name set. Performs a fake copy, see TBaseSet. This function maintains attributes.

Parameters

rSourceSet Destination to copy from

Returns: ref to this set

Definition at line 1208 of file cfl_nameset.h.

◆ DoEqual()

template<class Attr >

bool faudes::TaNameSet< Attr >::DoEqual ( const NameSet & rOtherSet ) const

protected

Test equality of configuration data, ignore attributes Ignore name of the set, insist in matching symboltables.

Parameters

rOtherSet Other object to compare with.

Returns: True on match.

Definition at line 1216 of file cfl_nameset.h.

◆ Erase() [1/3]

template<class Attr >

bool faudes::TaNameSet< Attr >::Erase ( const Idx & rIndex )

virtual

Delete element by index. Symbolic name is not removed from SymbolTable.

Parameters

rIndex Index to delete

Returns: True if element did exist

Reimplemented from faudes::NameSet.

Definition at line 1330 of file cfl_nameset.h.

◆ Erase() [2/3]

template<class Attr >

NameSet::Iterator faudes::TaNameSet< Attr >::Erase ( const Iterator & pos )

virtual

Delete element by iterator. Symbolic name is not removed from SymbolTable.

Parameters

pos	TaNameSet::iterator

Returns: Iterator to next element

Exceptions

Exception

invalid iterator (id 62)

Reimplemented from faudes::NameSet.

Definition at line 1352 of file cfl_nameset.h.

◆ Erase() [3/3]

template<class Attr >

bool faudes::TaNameSet< Attr >::Erase ( const std::string & rName )

virtual

Delete element by symbolic name. Symbolic name is not removed from SymbolTable

Parameters

rName Symbolic name of element to dlete

Returns: True if element did exist

Exceptions

Exception

name not found in Symboltable (id 66)

Reimplemented from faudes::NameSet.

Definition at line 1337 of file cfl_nameset.h.

◆ EraseSet() [1/2]

template<class Attr >

void faudes::TaNameSet< Attr >::EraseSet ( const NameSet & rOtherSet )

virtual

Erase elements indicated by rOtherSet

Exceptions

Exception

symboltable mismatch (id 67)

Parameters

rOtherSet Other StateSet

Definition at line 1358 of file cfl_nameset.h.

◆ EraseSet() [2/2]

template<class Attr >

void faudes::TaNameSet< Attr >::EraseSet ( const TBaseSet< Idx > & rOtherSet )

virtual

Erase elements specified by rOtherSet

This function requires a runtime cast to access the synboltable. An expection is thrown if the cast fails.

Parameters

rOtherSet Other NameSet

Exceptions

Exception

symboltable mismatch (id 67)
cast to nameset failed (id 67)

Reimplemented from faudes::NameSet.

Definition at line 1373 of file cfl_nameset.h.

◆ Insert() [1/4]

template<class Attr >

bool faudes::TaNameSet< Attr >::Insert ( const Idx & rIndex )

virtual

Add an element by index. Index must be already known to the global SymbolTable. If the element already exists in the set, the attribute is maintained. Otherwise, the element is inserted with default attribute.

Parameters

rIndex Index to add

Returns: True, if element was new to set

Exceptions

Exception

no symbolic name for index (id 65)

Definition at line 1251 of file cfl_nameset.h.

◆ Insert() [2/4]

template<class Attr >

bool faudes::TaNameSet< Attr >::Insert	(	const Idx &	rIndex,
		const Attr &	rAttr
	)

virtual

Add an element by index incl. attribute

Parameters

rIndex	Index to add
rAttr	Attribute to add

Returns: True, if index was new to set

Exceptions

Exception

no symbolic name for index (id 65)

Definition at line 1265 of file cfl_nameset.h.

◆ Insert() [3/4]

template<class Attr >

Idx faudes::TaNameSet< Attr >::Insert ( const std::string & rName )

virtual

Add an element by its symbolic name. If the name is unknown, a new index will be generated and recorded in the symboltable. If the name is known, the corresponding index will be added to the set. If the element already exists in the set, the attribute is maintained. Otherwise, the element is inserted with default attribute.

Parameters

rName symbolic name of element to add

Returns: Index of (new) element

Definition at line 1279 of file cfl_nameset.h.

◆ Insert() [4/4]

template<class Attr >

Idx faudes::TaNameSet< Attr >::Insert	(	const std::string &	rName,
		const Attr &	rAttr
	)

virtual

Add an element by its symbolic name. If the name is unknown, a new index will be generated and recorded in the symboltable. If the name is known, the corresponding index will be added to the set.

Parameters

rName	symbolic name of element to add
rAttr	Attribute

Returns: Index of (new) element

Definition at line 1287 of file cfl_nameset.h.

◆ InsertSet() [1/2]

template<class Attr >

void faudes::TaNameSet< Attr >::InsertSet ( const NameSet & rOtherSet )

virtual

Inserts elements of rOtherSet.

Attributes of this set are maintained, newly inserted elements obtain the attribute from rOtherSet provided they can be casted appropriately.

Parameters

rOtherSet Other StateSet

Exceptions

Exception

symboltable mismatch (id 67)

Reimplemented from faudes::NameSet.

Definition at line 1296 of file cfl_nameset.h.

◆ InsertSet() [2/2]

template<class Attr >

void faudes::TaNameSet< Attr >::InsertSet ( const TBaseSet< Idx > & rOtherSet )

virtual

Inserts all elements of rOtherSet.

This variant requires a runtime cast to access the synboltable. An expection is thrown if the cast fails.

Parameters

rOtherSet Other NameSet

Exceptions

Exception

symboltable mismatch (id 67)
cast to nameset failed (id 67)

Reimplemented from faudes::NameSet.

Definition at line 1310 of file cfl_nameset.h.

◆ operator=()

template<class Attr >

TaNameSet & faudes::TaNameSet< Attr >::operator= ( const NameSet & rSrc )

inline

Relaxed assignment operator (uses base class to maintain attributes)

Parameters

rSrc	Source from which to assign

Returns: Ref to this set

Definition at line 664 of file cfl_nameset.h.

◆ RestrictSet() [1/2]

template<class Attr >

void faudes::TaNameSet< Attr >::RestrictSet ( const NameSet & rOtherSet )

virtual

Restrict elements indicated by rOtherSet

Exceptions

Exception

symboltable mismatch (id 67)

Parameters

rOtherSet Other EventSet

Definition at line 1393 of file cfl_nameset.h.

◆ RestrictSet() [2/2]

template<class Attr >

void faudes::TaNameSet< Attr >::RestrictSet ( const TBaseSet< Idx > & rOtherSet )

virtual

Restrict to elements specified by rOtherSet

This function requires a runtime cast to access the synboltable. An expection is thrown if the cast fails.

Parameters

rOtherSet Other NameSet

Exceptions

Exception

symboltable mismatch (id 67)
cast to nameset failed (id 67)

Reimplemented from faudes::NameSet.

Definition at line 1407 of file cfl_nameset.h.

◆ Str() [1/2]

template<class Attr >

std::string faudes::TaNameSet< Attr >::Str ( const Idx & rIndex ) const

virtual

Return pretty printable symbolic name for index. Primary meant for debugging messages.

Parameters

rIndex Index to print

Returns: String

Reimplemented from faudes::NameSet.

Definition at line 1448 of file cfl_nameset.h.

◆ Str() [2/2]

template<class Attr >

std::string faudes::TaNameSet< Attr >::Str ( void ) const

virtual

Return pretty printable string for entire set Primary meant for debugging messages.

Parameters

rIndex Index to print

Returns: String

Reimplemented from faudes::NameSet.

Reimplemented in faudes::RelabelMap.

Definition at line 1454 of file cfl_nameset.h.

Friends And Related Symbol Documentation

◆ NameSet

template<class Attr >

friend class NameSet ( void )

friend

We implement "protected privacy for template classes" by friendship. This is used for the pragmatic implemention conversion constructors.

Definition at line 596 of file cfl_nameset.h.

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

cfl_nameset.h

Detailed Description

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ TaNameSet() [1/4]

◆ TaNameSet() [2/4]

◆ TaNameSet() [3/4]

◆ TaNameSet() [4/4]

◆ ~TaNameSet()

Member Function Documentation

◆ Attribute() [1/6]

◆ Attribute() [2/6]

◆ Attribute() [3/6]

◆ Attribute() [4/6]

◆ Attribute() [5/6]

◆ Attribute() [6/6]

◆ Attributep() [1/2]

◆ Attributep() [2/2]

◆ Attributes()

◆ AttributeTry()

◆ AttributeType()

◆ Copy()

◆ DoCopy()

◆ DoEqual()

◆ Erase() [1/3]

◆ Erase() [2/3]

◆ Erase() [3/3]

◆ EraseSet() [1/2]

◆ EraseSet() [2/2]

◆ Insert() [1/4]

◆ Insert() [2/4]

◆ Insert() [3/4]

◆ Insert() [4/4]

◆ InsertSet() [1/2]

◆ InsertSet() [2/2]

◆ operator=()

◆ RestrictSet() [1/2]

◆ RestrictSet() [2/2]

◆ Str() [1/2]

◆ Str() [2/2]

Friends And Related Symbol Documentation

◆ NameSet