Detailed Description

Set of indices.

This class is built on top of the faudes version TBaseSet of STL sets. It provides the essentials of the STL interface and inherits the standard token IO interface from Type, so you may use Read and Write for file/string/console IO.

IndexSet is used as common base for TaIndexSet (indices with attributes), NameSet (indices with symbolic names) and TaNameSet (indices with attributes and symbolic names).

The index of value 0 is reserved to indicate the invalid index. If the macro FAUDES_CHECKED is defined, the attempt to insert an index 0 triggers an exception (id 61). Invalid iterators throw an exception (id 62) when used as an argument to a IndexSet function.

Technically, file IO is done by TaIndexSet functions. This requires a copy and for that reason may be reimplemented in a future versions. The format is demonstrated by the following example of a set with name "MySet" consisting of indices 17, 25, 26, 27, 28, 40:

<Myset> 
17 
<Consecutive> 25 4 </Consecutive> 
40 
</MySet>  

Theere is a minimum number of consecutive indices for the use of the consecutive section defined in definitions.h.

Definition at line 78 of file cfl_indexset.h.

#include <cfl_indexset.h>

Public Member Functions
	IndexSet (void)
	Constructor. More...

	IndexSet (const IndexSet &rOtherSet)
	Copy-constructor. More...

	IndexSet (const TBaseSet< Idx > &rOtherSet)
	Copy-constructor. More...

	IndexSet (const std::string &rFilename, const std::string &rLabel="")
	Construct from file. More...

virtual	~IndexSet (void)
	Virtual destructor. More...

Idx	MaxIndex (void) const
	Get maximum index used in this set (0 for emptyset) More...

bool	Valid (const Idx &rIndex) const
	Test whether index is not 0. More...

Idx	Insert (void)
	Insert new index to set. More...

bool	Insert (const Idx &rIndex)
	Insert specified index. More...

Idx	Signature (void) const
	Compute an Idx type signature for a Set. More...

std::string	Str (const Idx &rIndex) const
	Return pretty printable index. More...

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

	TBaseSet (const TBaseSet &rOtherSet)
	Copy-constructor. More...

	TBaseSet (const std::string &rFilename, const std::string &rLabel="BaseSet")
	Constructor from file. More...

virtual	~TBaseSet (void)
	Virtual destructor. More...

const std::string &	Name (void) const
	Return name of TBaseSet. More...

void	Name (const std::string &rName)
	Set name of TBaseSet. More...

virtual void	Clear (void)
	Clear all set. More...

Idx	Size (void) const
	Get Size of TBaseSet. More...

bool	Empty (void) const
	Test whether if the TBaseSet is Empty. More...

virtual std::string	Str (const Idx &rElem) const
	Return pretty printable element. More...

Iterator	Begin (void) const
	Iterator to the begin of set. More...

Iterator	End (void) const
	Iterator to the end of set. More...

virtual bool	Valid (const Idx &rElem) const
	Test validty of candidate element. More...

virtual bool	Erase (const Idx &rElem)
	Erase element by reference. More...

virtual Iterator	Erase (const Iterator &pos)
	Erase element by iterator. More...

virtual void	EraseSet (const TBaseSet &rOtherSet)
	Erase elements given by other set. More...

virtual void	RestrictSet (const TBaseSet &rOtherSet)
	Restrict elements given by other set. More...

virtual bool	Disjoint (const TBaseSet &rOtherSet) const
	Test for this set to be disjoint witg other set. More...

virtual bool	Insert (const Idx &rElem)
	Insert specified element. More...

virtual Iterator	Inject (const Iterator &pos, const Idx &rElem)
	Insert specified element. More...

virtual void	Inject (const Idx &rElem)
	Insert specified element. More...

virtual void	InsertSet (const TBaseSet &rOtherSet)
	Insert elements given by rOtherSet. More...

bool	Exists (const Idx &rElem) const
	Test existence of element. More...

Iterator	Find (const Idx &rElem) const
	Find element and return iterator. More...

TBaseSet	operator+ (const TBaseSet &rOtherSet) const
	Set union operator. More...

TBaseSet	operator- (const TBaseSet &rOtherSet) const
	Set difference operator. More...

TBaseSet	operator* (const TBaseSet &rOtherSet) const
	Set intersection operator. More...

bool	operator<= (const TBaseSet &rOtherSet) const
	Test for subset More...

bool	operator>= (const TBaseSet &rOtherSet) const
	Test for superset. More...

bool	operator< (const TBaseSet &rOtherSet) const
	Order for sorting containers of TBaseSet. More...

void	DValid (const std::string &rMessage="") const
	Some validation of deferred copy mechanism (provoke abort) More...

void	Detach (DetachMode flag=AttrIncl) const

void	Lock (void) const
	Detach and lock any further reallocation. More...

virtual const AttributeVoid *	AttributeType (void) const
	Attribute typeinfo. More...

virtual bool	AttributeTest (const Type &rAttr) const
	Attribute typeinfo. More...

virtual TBaseSet &	AssignWithoutAttributes (const TBaseSet &rSourceSet)
	Attribute access. More...

virtual void	Attributes (const TBaseSet &rOtherSet)
	Attributes access. More...

Idx	AttributesSize (void) const
	Attribute access. More...

void	ClearAttributes (void)
	Attribute access. More...

bool	EqualAttributes (const TBaseSet &rOtherSet) const
	Attribute access. More...

virtual AttributeVoid *	Attributep (const Idx &rElem)
	Attribute access. More...

virtual const AttributeVoid &	Attribute (const Idx &rElem) const
	Attribute access. More...

virtual void	Attribute (const Idx &rElem, const Type &rAttr)
	Attribute access. More...

virtual void	AttributeTry (const Idx &rElem, const Type &rAttr)
	Attribute access. More...

virtual void	ClrAttribute (const Idx &rElem)
	Attribute access. More...

virtual void	XElementTag (const std::string &rTag)
	Configure the element name tag. More...

virtual const std::string &	TypeName (void) const
	Get objects's type name. More...

virtual void	TypeName (const std::string &rType)
	Overwrite faudes-type name. More...

Public Member Functions inherited from faudes::Type
	Type (void)
	Constructor. More...

	Type (const Type &rType)
	Copy constructor. More...

virtual	~Type (void)
	Destructor. More...

virtual Type *	New (void) const
	Construct on heap. More...

virtual Type *	Copy (void) const
	Construct on heap. More...

virtual const Type *	Cast (const Type *pOther) const
	Cast other object to this type. More...

virtual Type &	Assign (const Type &rSrc)
	Assign configuration data from other object. More...

virtual Type &	operator= (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...

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
void	DoAssign (const IndexSet &rSource)
	Assign my members. More...

virtual void	DoWrite (TokenWriter &tw, const std::string &rLabel="", const Type *pContext=0) const
	Write to TokenWriter, see Type::Write for public wrappers. More...

virtual void	DoXWrite (TokenWriter &tw, const std::string &rLabel="", const Type *pContext=0) const
	Write to TokenWriter, see Type::Write for public wrappers. More...

virtual void	DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
	Read from TokenReader, see Type::Read for public wrappers. More...

Protected Member Functions inherited from faudes::TBaseSet< Idx >
virtual const std::string &	XElementTag (void) const
	Get name of elements (used for XML IO) More...

virtual void	DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Token output, debugging see Type::DWrite for public wrappers. More...

virtual void	DoSWrite (TokenWriter &rTw) const
	Token output, see Type::SWrite for public wrappers. More...

void	DoAssign (const TBaseSet &rSourceSet)
	assign my members More...

bool	DoEqual (const TBaseSet &rOtherSet) const
	test equality More...

void	DoAttribute (const Idx &rElem, const Type *pAttr)
	set attribute in map (assume elem exists in set, NULL <=> set to default) More...

const AttributeVoid *	DoAttribute (const Idx &rElem) const
	get attribute from map (return null if elem does not exist in map) More...

AttributeVoid *	DoAttributeExplicit (const Idx &rElem)
	get attribute from map (insert explicit default if elem does not exist in map) More...

TBaseSet< Idx, std::less< Idx > >::Iterator	ThisIterator (const typename std::set< Idx, std::less< Idx > >::const_iterator &sit) const
	Convert STL iterator to API iterator. More...

void	RelinkClients (void)
	Ensure that we do not host contents to anyone else. More...

void	AttachClient (TBaseSet *pRef) const
	Record that we provide contents to some other BaseSet. More...

void	DetachClient (TBaseSet *pRef) const
	Record that we stop providing data for some TBaseSet. More...

void	AttachIterator (Iterator *pFit) const
	Record that an iterator refers to this TBaseSet. More...

void	DetachIterator (Iterator *pFit) const
	Record that an iterator stops to refer to this TBaseSet. More...

virtual const TypeDefinition *	TypeDefinitionp (void) const
	Reimplment from type to use chache. More...

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 Token	XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const

Friends
template<class Attr >
class	TaIndexSet
	We implement "protected privacy for template classes" by friendship. More...

Additional Inherited Members
Public Types inherited from faudes::TBaseSet< Idx >
enum	DetachMode
	Detach from extern storage (incl allocation and true copy) More...

Protected Types inherited from faudes::TBaseSet< Idx >
typedef std::set< Idx, std::less< Idx > >::iterator	iterator
	STL iterator, non-const version. More...

typedef std::set< Idx, std::less< Idx > >::const_iterator	const_iterator
	STL iterator, const version. More...

typedef std::map< Idx, AttributeVoid * >::iterator	aiterator
	STL attribute iterator, non-const version. More...

typedef std::map< Idx, AttributeVoid * >::const_iterator	const_aiterator
	STL attribute iterator, const version. More...

Protected Attributes inherited from faudes::TBaseSet< Idx >
std::string	mMyName
	Name of this BaseSet. More...

std::set< Idx, std::less< Idx > > *	pSet
	Pointer on STL set to operate on. More...

std::set< Idx, std::less< Idx > > *	mpSet
	STL set, if this object hosts data (else NULL) More...

std::map< Idx, AttributeVoid * > *	pAttributes
	Pointer to attribute map to operate on. More...

std::map< Idx, AttributeVoid * > *	mpAttributes
	Attribute map, if this object hosts data (else NULL). More...

TBaseSet< Idx, std::less< Idx > > *	pHostSet
	Pointer on BaseSet that hosts our data (THIS if we host) More...

std::list< TBaseSet< Idx, std::less< Idx > > * >::iterator	mClientRecord
	Iterator to the client list that hosts our data (maintained by host) More...

std::list< TBaseSet< Idx, std::less< Idx > > * > *	mpClients
	BaseSets, that use data hosted by us (NULL if we dont host data, emptyset if we host to ourself excl.) More...

bool	mDetached
	Indicate "hosts data to myself only". More...

bool	mLocked
	Indicate "dont re-allocate the STL set ever again". More...

std::set< Iterator * >	mIterators
	Iterators that refer to this TBaseSet. More...

Static Protected Attributes inherited from faudes::TBaseSet< Idx >
static std::set< Idx, std::less< Idx > >	msEmptySet
	static empty STL set for default constructor More...

static std::map< Idx, AttributeVoid * >	msEmptyAttributes
	static empty STL map for default constructor More...

Constructor & Destructor Documentation

◆ IndexSet() [1/4]

faudes::IndexSet::IndexSet ( void )

Constructor.

Definition at line 55 of file cfl_indexset.cpp.

◆ IndexSet() [2/4]

faudes::IndexSet::IndexSet ( const IndexSet & rOtherSet )

Copy-constructor.

Definition at line 61 of file cfl_indexset.cpp.

◆ IndexSet() [3/4]

faudes::IndexSet::IndexSet ( const TBaseSet< Idx > & rOtherSet )

Copy-constructor.

Definition at line 69 of file cfl_indexset.cpp.

◆ IndexSet() [4/4]

faudes::IndexSet::IndexSet	(	const std::string &	rFilename,
		const std::string &	rLabel = `""`
	)

Construct from file.

Uses the Read(TokenReader&, const std::string&) function to read. a IndexSet from section rLabel in file rFilename.

Parameters

rFilename	Name of file to read
rLabel	Section to read

Exceptions

Exception

IO Errors (id 1)
Token mismatch (id 50, 51, 52)

Definition at line 77 of file cfl_indexset.cpp.

◆ ~IndexSet()

virtual faudes::IndexSet::~IndexSet ( void )

inlinevirtual

Virtual destructor.

Definition at line 124 of file cfl_indexset.h.

Member Function Documentation

◆ DoAssign()

void faudes::IndexSet::DoAssign ( const IndexSet & rSource )

protected

Assign my members.

This method maintains attributes provided that the type can be appropriately casted.

Parameters

rSource Source to copy from

Returns: Ref to this set

Definition at line 85 of file cfl_indexset.cpp.

◆ DoRead()

void faudes::IndexSet::DoRead	(	TokenReader &	rTr,
		const std::string &	rLabel = `""`,
		const Type *	pContext = `0`
	)

protectedvirtual

Read from TokenReader, see Type::Read for public wrappers.

This method invokes TokenReader::ReadBegin() to seek the specified section, reads subsequent integer tokens as indexes, and calls matching TokenReader::ReadEnd(). If no section is specified, the section is assumed to start at the current position of the token stream. If the current position is no begin token, the section "IndexSet" is read. When used by a derived class with attributes, attributes are read, too.

Parameters

rTr	Reference to tokenreader
rLabel	Section to read, defaults to current begin label or else "IndexSet"
pContext	Read context to provide contextual information

Exceptions

Exception

IO errors (id 1)
token mismatch (id 50, 51, 52)

Reimplemented from faudes::TBaseSet< Idx >.

Definition at line 198 of file cfl_indexset.cpp.

◆ DoWrite()

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

protectedvirtual

Write to TokenWriter, see Type::Write for public wrappers.

Appends the IndexSet to TokenWriter. This will write a section with label as specified that holds integer tokens to represent the IndexSet. For non-default attribute values, the respective index is followed by the attribute value. The latter may consist of sections (or tokens different from integer or string) to allow for transparent reading; see AttributeVoid and AttributeFlags. Example for a set with name "MySet" consisting of indices 17, 25, 40, where index 25 has a nontrivial attribute attached:

<Myset> 
17 
25 <AValue> "Some Value" </AValue> 
40 
</MySet>  

Parameters

tw	Reference to TokenWriter
rLabel	Label of section to write, defaults to name of set or "IndexSet"
pContext	Write context to provide contextual information

Exceptions

Exception

IO errors (id 2)

Reimplemented from faudes::TBaseSet< Idx >.

Definition at line 92 of file cfl_indexset.cpp.

◆ DoXWrite()

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

protectedvirtual

Write to TokenWriter, see Type::Write for public wrappers.

Appends the IndexSet to TokenWriter using XML format.

Parameters

tw	Reference to TokenWriter
rLabel	Label of section to write, defaults to name of set or "IndexSet"
pContext	Write context to provide contextual information

Exceptions

Exception

IO errors (id 2)

Reimplemented from faudes::Type.

Definition at line 142 of file cfl_indexset.cpp.

◆ Insert() [1/2]

bool faudes::IndexSet::Insert ( const Idx & rIndex )

Insert specified index.

Parameters

rIndex Index to insert

Returns: True if index was new to set

Definition at line 322 of file cfl_indexset.cpp.

◆ Insert() [2/2]

Idx faudes::IndexSet::Insert ( void )

Insert new index to set.

Returns: New index

Definition at line 313 of file cfl_indexset.cpp.

◆ MaxIndex()

Idx faudes::IndexSet::MaxIndex ( void ) const

Get maximum index used in this set (0 for emptyset)

Returns: max indices

Definition at line 298 of file cfl_indexset.cpp.

◆ Signature()

Idx faudes::IndexSet::Signature ( void ) const

Compute an Idx type signature for a Set.

The value is computed by summing up the product of every index with an integer starting at 1 (for the first index) and ending at Size() (for the last index).

Returns: Idx type set signature

Definition at line 335 of file cfl_indexset.cpp.

◆ Str()

std::string faudes::IndexSet::Str ( const Idx & rIndex ) const

inline

Return pretty printable index.

Parameters

rIndex Index to print

Returns: String

Definition at line 185 of file cfl_indexset.h.

◆ Valid()

bool faudes::IndexSet::Valid ( const Idx & rIndex ) const

Test whether index is not 0.

Parameters

rIndex Index to test

Returns: True if idx!=0

Definition at line 329 of file cfl_indexset.cpp.

Friends And Related Function Documentation

◆ TaIndexSet

template<class Attr >

friend class TaIndexSet ( void )

friend

We implement "protected privacy for template classes" by friendship.

This is used for the pragmatic implemention conversion constructors.

Definition at line 88 of file cfl_indexset.h.

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

Detailed Description

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ IndexSet() [1/4]

◆ IndexSet() [2/4]

◆ IndexSet() [3/4]

◆ IndexSet() [4/4]

◆ ~IndexSet()

Member Function Documentation

◆ DoAssign()

◆ DoRead()

◆ DoWrite()

◆ DoXWrite()

◆ Insert() [1/2]

◆ Insert() [2/2]

◆ MaxIndex()

◆ Signature()

◆ Str()

◆ Valid()

Friends And Related Function Documentation

◆ TaIndexSet