|
|
||||||
|
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 1224 of file cfl_baseset.h. ◆ TEMP
Definition at line 1223 of file cfl_baseset.h. ◆ THIS
Definition at line 1222 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 546 of file cfl_nameset.h. ◆ StateSet
Definition at line 296 of file cfl_indexset.h. ◆ StateSetVector
Definition at line 304 of file cfl_indexset.h. ◆ TaStateSet
template<class Attr >
Convenience Macro (pre C++11) Convenience Typedef (C++11) Definition at line 581 of file cfl_indexset.h. ◆ TransSet
Type definition for default sorted TTransSet Definition at line 1019 of file cfl_transset.h. ◆ TransSetEvX1X2Type definition for ev, x1, x2 sorted TTransSet Definition at line 1025 of file cfl_transset.h. ◆ TransSetEvX2X1Type definition for ev, x2, x1 sorted TTransSet Definition at line 1028 of file cfl_transset.h. ◆ TransSetX1EvX2Type definition for default sorted TTransSet Definition at line 1022 of file cfl_transset.h. ◆ TransSetX1X2EvType definition for x1, x2, ev sorted TTransSet Definition at line 1037 of file cfl_transset.h. ◆ TransSetX2EvX1Type definition for x2, ev, x1 sorted TTransSet Definition at line 1031 of file cfl_transset.h. ◆ TransSetX2X1EvType definition for x2, x1, ev sorted TTransSet Definition at line 1034 of file cfl_transset.h. Function Documentation◆ ApplyRelabelMap()
Apply relable map to nameset This implementation tries to keep the attributes from the domain elements.
Definition at line 31 of file cfl_transset.cpp. ◆ 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 2444 of file cfl_baseset.h. ◆ AttachClient()
template<class T , class Cmp >
Record that we provide contents to some other BaseSet Definition at line 1656 of file cfl_baseset.h. ◆ AttachIterator()
template<class T , class Cmp >
Record that an iterator refers to this TBaseSet Definition at line 1706 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 2497 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 2504 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 2486 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 2453 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 2389 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 2384 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::TaNameSet< NameSet >, faudes::TaIndexSet< Attr >, faudes::TaIndexSet< StateAttr >, faudes::TaIndexSet< faudes::DiagLabelSet >, and faudes::TaIndexSet< faudes::NameSet >. Definition at line 2378 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 2104 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 2394 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 2524 of file cfl_baseset.h. ◆ Detach()
template<class T , class Cmp >
Definition at line 1444 of file cfl_baseset.h. ◆ DetachClient()
template<class T , class Cmp >
Record that we stop providing data for some TBaseSet Definition at line 1664 of file cfl_baseset.h. ◆ DetachIterator()
template<class T , class Cmp >
Record that an iterator stops to refer to this TBaseSet Definition at line 1713 of file cfl_baseset.h. ◆ Disjoint()
template<class T , class Cmp >
Test for this set to be disjoint witg other set
Definition at line 2296 of file cfl_baseset.h. ◆ DoAssign()
template<class T , class Cmp >
assign my members Definition at line 1366 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 2531 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 2559 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 2539 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 1983 of file cfl_baseset.h. ◆ DoDWriteElement()
template<class T , class Cmp >
Token output for an individual element of the set, strict XML debug. See also DoWriteElement
Definition at line 1937 of file cfl_baseset.h. ◆ DoEqual()
template<class T , class Cmp >
test equality Definition at line 2351 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 2042 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 2028 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 2012 of file cfl_baseset.h. ◆ DoWrite()
template<class T , class Cmp >
Token output, see Type::Write 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 1951 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 1909 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 1968 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 1923 of file cfl_baseset.h. ◆ DValid()
template<class T , class Cmp >
Some validation of deferred copy mechanism (provoke abort) Definition at line 1720 of file cfl_baseset.h. ◆ Empty()
template<class T , class Cmp >
Test whether if the TBaseSet is Empty
Definition at line 1904 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 2403 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 2233 of file cfl_baseset.h. ◆ Erase() [2/2]
template<class T , class Cmp >
Erase element by reference
Definition at line 2226 of file cfl_baseset.h. ◆ EraseSet()
template<class T , class Cmp >
Erase elements given by other set
Definition at line 2249 of file cfl_baseset.h. ◆ Exists()
template<class T , class Cmp >
Test existence of element
Definition at line 2322 of file cfl_baseset.h. ◆ Find()
template<class T , class Cmp >
Find element and return iterator.
Definition at line 2317 of file cfl_baseset.h. ◆ FromStl()
template<class T , class Cmp >
Create a copy as plain STL set. This is virtual to allow overrides that address attributes.
Definition at line 2606 of file cfl_baseset.h. ◆ GlobalEmptyAttributes()
template<class T , class Cmp >
construct and record static members (the fiasco) Definition at line 1255 of file cfl_baseset.h. ◆ GlobalEmptySet()
template<class T , class Cmp >
construct and record static members (the fiasco) Definition at line 1242 of file cfl_baseset.h. ◆ Inject() [1/2]
template<class T , class Cmp >
Insert specified element
Definition at line 2180 of file cfl_baseset.h. ◆ Inject() [2/2]
template<class T , class Cmp >
Insert specified element
Definition at line 2188 of file cfl_baseset.h. ◆ Insert()
template<class T , class Cmp >
Insert specified element
Definition at line 2167 of file cfl_baseset.h. ◆ InsertSet()
template<class T , class Cmp >
Insert elements given by rOtherSet
Definition at line 2194 of file cfl_baseset.h. ◆ IsDefault()
template<class T , class Cmp >
Test fo default aka empty Reimplemented from faudes::AttrType. Definition at line 2156 of file cfl_baseset.h. ◆ Lock()
template<class T , class Cmp >
Detach and lock any further reallocation Definition at line 1576 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 2372 of file cfl_baseset.h. ◆ operator<=()
template<class T , class Cmp >
Test for subset Definition at line 2360 of file cfl_baseset.h. ◆ operator>=()
template<class T , class Cmp >
Test for superset Definition at line 2366 of file cfl_baseset.h. ◆ RelinkClients()
template<class T , class Cmp >
Ensure that we do not host contents to anyone else Definition at line 1607 of file cfl_baseset.h. ◆ RestrictSet()
template<class T , class Cmp >
Restrict elements given by other set
Definition at line 2271 of file cfl_baseset.h. ◆ SetDifference()
template<class T , class Cmp >
Definition at line 1149 of file cfl_baseset.h. ◆ SetEquality()
template<class T , class Cmp >
Definition at line 1183 of file cfl_baseset.h. ◆ SetInclusion()
template<class T , class Cmp >
Definition at line 1199 of file cfl_baseset.h. ◆ SetIntersection()
template<class T , class Cmp >
Definition at line 1120 of file cfl_baseset.h. ◆ SetUnion()
template<class T , class Cmp >
Definition at line 1090 of file cfl_baseset.h. ◆ Size()
template<class T , class Cmp >
Get Size of TBaseSet
Definition at line 1899 of file cfl_baseset.h. ◆ Str() [1/2]
template<class T , class Cmp >
Return pretty printable element. Primary meant for debugging messages.
Definition at line 1877 of file cfl_baseset.h. ◆ Str() [2/2]
template<class T , class Cmp >
Return pretty printable set Primary meant for debugging messages.
Reimplemented in faudes::TTransSet< Cmp >, faudes::TTransSet< TransSort::X1EvX2 >, faudes::TTransSet< TransSort::X2EvX1 >, faudes::RelabelMap, 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::TaNameSet< NameSet >, faudes::NameSet, and faudes::IndexSet. Definition at line 1884 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 1293 of file cfl_baseset.h. ◆ TBaseSet() [2/3]
template<class T , class Cmp >
Copy-constructor.
Definition at line 1316 of file cfl_baseset.h. ◆ TBaseSet() [3/3]
template<class T , class Cmp >
Constructor. Definition at line 1269 of file cfl_baseset.h. ◆ ThisIterator()
template<class T , class Cmp >
Convert STL iterator to API iterator Definition at line 2088 of file cfl_baseset.h. ◆ ToStl()
template<class T , class Cmp >
Copy data to a plain STL set This is virtual to allow overrides that address attributes.
Definition at line 2615 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 2161 of file cfl_baseset.h. ◆ ~TBaseSet()
template<class T , class Cmp >
Virtual destructor Definition at line 1342 of file cfl_baseset.h. libFAUDES 2.33l --- 2025.09.16 --- c++ api documentaion by doxygen |