|
|
||||||
|
Detailed DescriptionThis module collects all basic container classes aka state- event- and transition-sets, e.g.,
All libFAUDES container classes share the same basic API similar to the one known from STL containers. In addition, they implement file IO via faudes token streams and/or XML. Most commonly used is the plain faudes::EventSet and the faudes::Alphabet. Plug-ins introduce specialized sets for their purposes.
Macro Definition Documentation◆ BASE
Definition at line 1171 of file cfl_baseset.h. ◆ TEMP
Definition at line 1170 of file cfl_baseset.h. ◆ THIS
Definition at line 1169 of file cfl_baseset.h. Typedef Documentation◆ Alphabet
Convenience typedef for event sets with controllability attributes. Definition at line 43 of file cfl_cgenerator.h. ◆ EventSet
Convenience typedef for plain event sets Definition at line 534 of file cfl_nameset.h. ◆ StateSet
Definition at line 273 of file cfl_indexset.h. ◆ StateSetVector
Definition at line 281 of file cfl_indexset.h. ◆ TaStateSet
template<class Attr >
Convenience Macro (pre C++11) Convenience Typedef (C++11) Definition at line 558 of file cfl_indexset.h. ◆ TransSet
Type definition for default sorted TTransSet Definition at line 1010 of file cfl_transset.h. ◆ TransSetEvX1X2Type definition for ev, x1, x2 sorted TTransSet Definition at line 1016 of file cfl_transset.h. ◆ TransSetEvX2X1Type definition for ev, x2, x1 sorted TTransSet Definition at line 1019 of file cfl_transset.h. ◆ TransSetX1EvX2Type definition for default sorted TTransSet Definition at line 1013 of file cfl_transset.h. ◆ TransSetX1X2EvType definition for x1, x2, ev sorted TTransSet Definition at line 1028 of file cfl_transset.h. ◆ TransSetX2EvX1Type definition for x2, ev, x1 sorted TTransSet Definition at line 1022 of file cfl_transset.h. ◆ TransSetX2X1EvType definition for x2, x1, ev sorted TTransSet Definition at line 1025 of file cfl_transset.h. Function Documentation◆ AssignWithoutAttributes()
template<class T , class Cmp >
Attribute access. This virtual function provides an interface for derived classes with attributes eg TaIndexSet. The current implementation uses the DoAssign method and clears any attributes afterwards. Future implementations may be more efficient.
Definition at line 2302 of file cfl_baseset.h. ◆ AttachClient()
template<class T , class Cmp >
Record that we provide contents to some other BaseSet Definition at line 1563 of file cfl_baseset.h. ◆ AttachIterator()
template<class T , class Cmp >
Record that an iterator refers to this TBaseSet Definition at line 1613 of file cfl_baseset.h. ◆ Attribute() [1/2]
template<class T , class Cmp >
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.
Definition at line 2355 of file cfl_baseset.h. ◆ Attribute() [2/2]
template<class T , class Cmp >
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.
Definition at line 2362 of file cfl_baseset.h. ◆ Attributep()
template<class T , class Cmp >
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.
Definition at line 2344 of file cfl_baseset.h. ◆ Attributes()
template<class T , class Cmp >
Attributes access. This virtual function provides an interface for derived classes with attributes eg TaIndexSet. It copies attributes from the specified set, provided that they can be casted appropriately. Elements of this set which are not in rOtherSet maintain their attribute.
Definition at line 2311 of file cfl_baseset.h. ◆ AttributesSize()
template<class T , class Cmp >
Attribute access. This virtual function provides an interface for derived classes with attributes eg TaIndexSet. Provide the number of explicit attributes. The TBaseSet itself has no attributes and thus this function returns 0. Definition at line 2247 of file cfl_baseset.h. ◆ AttributeTest()
template<class T , class Cmp >
Attribute typeinfo. This virtual function provides an interface for derived classes with attributes eg TaIndexSet. It tests whether this set accepts the specified attribute type ie whether it can be casted. The test is performned by the Cast function of the attribute type returned by AttributeType().
Definition at line 2242 of file cfl_baseset.h. ◆ AttributeType()
template<class T , class Cmp >
Attribute typeinfo. This virtual function provides an interface for derived container classes with attributes eg TaIndexSet. When not re-implemented, it returns an attribute with type AttributeVoid to indicate the absence of nontrivial attributes Reimplemented in faudes::TaTransSet< Attr >, faudes::TaNameSet< Attr >, faudes::TaNameSet< faudes::AttributeFailureEvents >, faudes::TaNameSet< AttributeSimCondition >, faudes::TaNameSet< faudes::AttributeSignalEvent >, faudes::TaNameSet< faudes::AttributeSimplenetEvent >, faudes::TaNameSet< EventAttr >, faudes::TaNameSet< SimEventAttribute >, faudes::TaIndexSet< Attr >, faudes::TaIndexSet< StateAttr >, and faudes::TaIndexSet< faudes::DiagLabelSet >. Definition at line 2236 of file cfl_baseset.h. ◆ Begin()
template<class T , class Cmp >
◆ Clear()
template<class T , class Cmp >
Clear all set to default aka empty Reimplemented from faudes::Type. Definition at line 1962 of file cfl_baseset.h. ◆ ClearAttributes()
template<class T , class Cmp >
Attribute access. This virtual function provides an interface for derived classes with attributes eg TaIndexSet. The TBaseSet itself has no attributes and thus this function does nothing. Definition at line 2252 of file cfl_baseset.h. ◆ ClrAttribute()
template<class T , class Cmp >
Attribute access. Cleras an explicit attribute associated with the specified element if sucht attribute exists. The TBaseSet itself has no attributes and thus this function will do nothing.
Definition at line 2382 of file cfl_baseset.h. ◆ Detach()
template<class T , class Cmp >
Definition at line 1352 of file cfl_baseset.h. ◆ DetachClient()
template<class T , class Cmp >
Record that we stop providing data for some TBaseSet Definition at line 1571 of file cfl_baseset.h. ◆ DetachIterator()
template<class T , class Cmp >
Record that an iterator stops to refer to this TBaseSet Definition at line 1620 of file cfl_baseset.h. ◆ Disjoint()
template<class T , class Cmp >
Test for this set to be disjoint witg other set
Definition at line 2154 of file cfl_baseset.h. ◆ DoAssign()
template<class T , class Cmp >
assign my members Definition at line 1281 of file cfl_baseset.h. ◆ DoAttribute() [1/2]
template<class T , class Cmp >
get attribute from map (return null if elem does not exist in map) Definition at line 2389 of file cfl_baseset.h. ◆ DoAttribute() [2/2]
template<class T , class Cmp >
set attribute in map (assume elem exists in set, NULL <=> set to default) Definition at line 2417 of file cfl_baseset.h. ◆ DoAttributeExplicit()
template<class T , class Cmp >
get attribute from map (insert explicit default if elem does not exist in map) Definition at line 2397 of file cfl_baseset.h. ◆ DoDWrite()
template<class T , class Cmp >
Token output, debugging see Type::DWrite for public wrappers. Reimplement this function in derived classes for specific specific template parameters.
Reimplemented from faudes::Type. Reimplemented in faudes::NameSet. Definition at line 1852 of file cfl_baseset.h. ◆ DoEqual()
template<class T , class Cmp >
test equality Definition at line 2209 of file cfl_baseset.h. ◆ DoRead()
template<class T , class Cmp >
Token input, see Type::Read for public wrappers. Reimplement this function in derived classes for specific specific template parameters. By convention, the default label "" should be translated to some meaningful default, eg "IndexSet" for a set of indices". The pContext pointer can de type-checked and interpreted, ie as a symboltable to provide symbolic names. It is also passed on to attributes.
Reimplemented from faudes::Type. Reimplemented in faudes::NameSet, faudes::SymbolSet, and faudes::IndexSet. Definition at line 1900 of file cfl_baseset.h. ◆ DoReadElement()
template<class T , class Cmp >
Token input for individual elemets. Reimplement this function in derived classes for specific specific template parameters. The pContext pointer can de type-checked and interpreted, ie as a symboltable to provide symbolic names. It is also passed on to attributes.
Definition at line 1886 of file cfl_baseset.h. ◆ DoSWrite()
template<class T , class Cmp >
Token output, see Type::SWrite for public wrappers. Statistics include size, name and attributey type. The latter is retrieved from the RTI, if initialized. Dereived sets may reimplement this method.
Reimplemented from faudes::Type. Definition at line 1870 of file cfl_baseset.h. ◆ DoWrite()
template<class T , class Cmp >
Token output, see Type::WWrite for public wrappers. The default implementation iterates over the individual elements and writes them by DoWriteElement. Reimplement this function in derived classes for a taylored output format. By convention, the default label "" should be translated to a) the name of the set or b) some meaningful default, eg "IndexSet" for a set of indices. The pContext pointer can de type-checked and interpreted, ie as a symboltable to provide symbolic names. It is also passed on to attributes.
Reimplemented from faudes::Type. Reimplemented in faudes::SymbolSet, faudes::NameSet, faudes::IndexSet, faudes::TTransSet< Cmp >, faudes::TTransSet< TransSort::X1EvX2 >, and faudes::TTransSet< TransSort::X2EvX1 >. Definition at line 1820 of file cfl_baseset.h. ◆ DoWriteElement()
template<class T , class Cmp >
Token output for an individual element of the set. The default implementation casts the element to faudes::Type and uses the API thereof. This is meant for "small sets of large elements". For a more tailored ourput on "large sets of small elements", you most likely want to re-implement DoWrite.
Definition at line 1792 of file cfl_baseset.h. ◆ DoXWrite()
template<class T , class Cmp >
Token output, strict XML version Reimplement this function in derived classes for specific specific template parameters.
Reimplemented from faudes::Type. Reimplemented in faudes::NameSet, and faudes::IndexSet. Definition at line 1837 of file cfl_baseset.h. ◆ DoXWriteElement()
template<class T , class Cmp >
Token output for an individual element of the set, strict XML variant. See also DoWriteElement
Definition at line 1806 of file cfl_baseset.h. ◆ DValid()
template<class T , class Cmp >
Some validation of deferred copy mechanism (provoke abort) Definition at line 1627 of file cfl_baseset.h. ◆ Empty()
template<class T , class Cmp >
Test whether if the TBaseSet is Empty
Definition at line 1787 of file cfl_baseset.h. ◆ End()
template<class T , class Cmp >
◆ EqualAttributes()
template<class T , class Cmp >
Attribute access. Test whether attributes match with other set, and return true if attributes match for shared elements. It uses the equality test of individual attributes and, hence, requires the attribute type match too.
Definition at line 2261 of file cfl_baseset.h. ◆ Erase() [1/2]
template<class T , class Cmp >
Erase element by iterator
Reimplemented in faudes::TTransSet< Cmp >, faudes::TTransSet< TransSort::X1EvX2 >, and faudes::TTransSet< TransSort::X2EvX1 >. Definition at line 2091 of file cfl_baseset.h. ◆ Erase() [2/2]
template<class T , class Cmp >
Erase element by reference
Definition at line 2084 of file cfl_baseset.h. ◆ EraseSet()
template<class T , class Cmp >
Erase elements given by other set
Definition at line 2107 of file cfl_baseset.h. ◆ Exists()
template<class T , class Cmp >
Test existence of element
Definition at line 2180 of file cfl_baseset.h. ◆ Find()
template<class T , class Cmp >
Find element and return iterator.
Definition at line 2175 of file cfl_baseset.h. ◆ Inject() [1/2]
template<class T , class Cmp >
Insert specified element
Definition at line 2038 of file cfl_baseset.h. ◆ Inject() [2/2]
template<class T , class Cmp >
Insert specified element
Definition at line 2046 of file cfl_baseset.h. ◆ Insert()
template<class T , class Cmp >
Insert specified element
Definition at line 2025 of file cfl_baseset.h. ◆ InsertSet()
template<class T , class Cmp >
Insert elements given by rOtherSet
Definition at line 2052 of file cfl_baseset.h. ◆ IsDefault()
template<class T , class Cmp >
Test fo default aka empty Reimplemented from faudes::AttrType. Definition at line 2014 of file cfl_baseset.h. ◆ Lock()
template<class T , class Cmp >
Detach and lock any further reallocation Definition at line 1483 of file cfl_baseset.h. ◆ operator*()
template<class T , class Cmp >
◆ operator+()
template<class T , class Cmp >
◆ operator-()
template<class T , class Cmp >
◆ operator<()
template<class T , class Cmp >
Order for sorting containers of TBaseSet Definition at line 2230 of file cfl_baseset.h. ◆ operator<=()
template<class T , class Cmp >
Test for subset Definition at line 2218 of file cfl_baseset.h. ◆ operator>=()
template<class T , class Cmp >
Test for superset Definition at line 2224 of file cfl_baseset.h. ◆ RelinkClients()
template<class T , class Cmp >
Ensure that we do not host contents to anyone else Definition at line 1514 of file cfl_baseset.h. ◆ RestrictSet()
template<class T , class Cmp >
Restrict elements given by other set
Definition at line 2129 of file cfl_baseset.h. ◆ SetDifference()
template<class T , class Cmp >
Definition at line 1096 of file cfl_baseset.h. ◆ SetEquality()
template<class T , class Cmp >
Definition at line 1130 of file cfl_baseset.h. ◆ SetInclusion()
template<class T , class Cmp >
Definition at line 1146 of file cfl_baseset.h. ◆ SetIntersection()
template<class T , class Cmp >
Definition at line 1067 of file cfl_baseset.h. ◆ SetUnion()
template<class T , class Cmp >
Definition at line 1037 of file cfl_baseset.h. ◆ Size()
template<class T , class Cmp >
Get Size of TBaseSet
Definition at line 1782 of file cfl_baseset.h. ◆ Str()
template<class T , class Cmp >
Return pretty printable element. Reimplement this method for derived classes.
Definition at line 1775 of file cfl_baseset.h. ◆ TBaseSet() [1/3]
template<class T , class Cmp >
Constructor from file. This constructor indicates the intended interface for derived classes. The base set itself cannot read from token streams.
Definition at line 1212 of file cfl_baseset.h. ◆ TBaseSet() [2/3]
template<class T , class Cmp >
Copy-constructor.
Definition at line 1233 of file cfl_baseset.h. ◆ TBaseSet() [3/3]
template<class T , class Cmp >
Constructor. Definition at line 1193 of file cfl_baseset.h. ◆ ThisIterator()
template<class T , class Cmp >
Convert STL iterator to API iterator Definition at line 1946 of file cfl_baseset.h. ◆ Valid()
template<class T , class Cmp >
Test validty of candidate element. Reimplement this function for particular type T of elements, eg for an index set with T=Idx indicate 0 an invalid index.
Definition at line 2019 of file cfl_baseset.h. ◆ ~TBaseSet()
template<class T , class Cmp >
Virtual destructor Definition at line 1257 of file cfl_baseset.h. Variable Documentation◆ msEmptyAttributes
template<class T , class Cmp >
static empty STL map for default constructor Definition at line 1015 of file cfl_baseset.h. ◆ msEmptySet
template<class T , class Cmp >
static empty STL set for default constructor Definition at line 1012 of file cfl_baseset.h. libFAUDES 2.33h --- 2025.06.18 --- c++ api documentaion by doxygen |