Detailed Description

Base class of all FAUDES generators.

Overview

The faudes::vGenerator models the plain five-tupel G = (X, Sigma, Delta, X_0, X_m) to represent the marked language L(G) and closed language L_m(G), respectively. It provides read and write access to core menbers, e.g. methods for inserting/deleting events, states and transitions.

States, events and transitions in a generator can be addressed in three alternative methods:

by index, involves a search on a sorted set (efficient)
by name, involves two searches on sorted sets (not quite so efficient)
by iterator, involves pointer dereferencing (very efficient)

For read access, const refererences to sets are provided. In order to allow for consistency checks, write access is via generator methods only. When the compiletime option FAUDES_CHECKED is defined, write methods throw an exception on inconsistent data, eg. setting an initial state that is not an element of the state set, or introducing a transition with an event label that is not in the alphabet.

Events Versus States

While both, events and states, are represented by the integer type faudes::Idx, there is a fundamental distinction between both, which stems from the design choice to use generators as a tool to represent formal languages. From this perspective, events are global enteties while states are local to the respective generator. Any two events within libFAUDES are related while states only compare within a generator.

In consequence, there is global sybmoltable for event name resolution, while there is one local state symboltable for each generator. Furthermore, state names are considered cosmetic and hence are optional, while event names are mandatory.

Example: two machines both refer to the event name "alpha" that models the process of passing a workpiece from one machine to the other. In libFAUDES this is indeed modelled as one event which is represented by one index. However, both machines may have a state "Idle" which indicates that the respective machine is idle. In libFAUDES the two states are treated locally to the generators and whether or not they have the same index is regarded irrelevant.

The generator class carries a flag to indicate that functions with result type generator shall attach names to the newly created states, based on the state names of the respective arguments. Turning of this feature and avoiding state names alltogether considerably increases libFAUDES performance.

File I/O (default format)

Generators inherit the standard token IO interface from the libFAUDES general purpose base Type, so you may use Read and Write functions for generators. The file-format consists of a generator section that includes one subsection for each core member. It is illustrated by the below example

<Generator name="simple machine">
% libFAUDES Generator for the simple machine                   
 
<Alphabet>                         
alpha beta mue lambda      
</Alphabet>
 
<States>                           
idle busy down
</States>
 
<TransRel>
idle  alpha  busy
busy  beta   idle
busy  mue    down
down  lambda idle
</TransRel>
 
<InitStates>
idle
</InitStates>
 
<MarkedStates>
idle
</MarkedStates>
</Generator>

Technical Detail: Since symbolic state names are optional, states may alternatively be represented by their index. In order to consitently read a generator from a token stream, the convention was that states are indexed consecutively starting from 1. This convention produces nice and human-readable output. However, it requires a re-indexing when writing the generator. As of libFAUDES 2.20j, the token format was extended to allow for explicit symbol table entries in the format "symbolic_state_name#index". Whether or not re-indexing is applied can be configured via ReindexOnWrite(bool). The default is not to re-index. If you want to read your token stream with libFAUDES pre 2.20j, you must turn re-index on.

Technical Detail: The generator name, the alphabet and the state set are optional. The generator name defaults to "generator"; the alphabet and the state set are extracted from the transition relation. Furthermore, there alternative short labels "A" for "Alphabet", "S" for "States" etc. are accepted. This short format has been introduced in 2.24e and is meant for embedding data concisely into luafaudes scripts. In general, the full format is preferable.

<Generator>
<T>
idle  alpha  busy
busy  beta   idle
busy  mue    down
down  lambda idle
</T>
<I> idle </I>
<M> idle </M>
</Generator>

File I/O (XML file-format)

The alternative file file format prodiced by XWrite() is meant to accomodate for additional attributes attached to states, events and transitions, including e.g. graph data for a graphical representation. It starts with the outer element "Generator" with name attribute (optionally) and type attribute (mandatory).

<Generator name="simpla machine" ftype="Generator">
<Alphabet>                         
<Event name="alpha"/>
<Event name="beta"/>
<Event name="mue"/>
<Event name="lambda"/>
</Alphabet>
 
<StateSet>                           
<State name="idle" id="1">
  <Marked/><Initial/>
<State/>
<State name="busy" id="2"/>
<State name="down" id="3"/>
</StateSet>
 
<TransitionRelation>
<Transition x1="1" event="alphs" x2="2"/>
<Transition x1="2" event="beta" x2="2"/>
<Transition x1="2" event="mue" x2="3"/>
<Transition x1="3" event="lambda" x2="1"/>
<TransitionRelation/>
 
</Generator>

Attributes

libFAUDES generators provide an interface to access so called attributes, ie data that is optionally attached to individual states, events, transitions, or globally to the generator.

The faudes::Generator's interface to attributes is abstract in the sense that a generator is not aware of the actual type of its attributes. Instances of the class Generator indeed have trivial attributes that hold no data at all. To use attributes, you are meant to instantiate objects of the derived class TaGenerator with template parameters to specify attribute types. Basic algorithms implemented for plain generators will accept attributed generators as arguments. Such algorithms may occasionally inspect or set attributes using the abstract interface and C++ dynamic casts. For specialised algorithms that refer to extended generator semantics, we recommend derived generator classes as argument type.

Definition at line 213 of file cfl_generator.h.

#include <cfl_generator.h>

Public Member Functions
Constructors & Destructor
	vGenerator (void)

	vGenerator (const vGenerator &rOtherGen)

	vGenerator (const std::string &rFileName)

virtual vGenerator *	New (void) const

virtual vGenerator *	Copy (void) const

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

virtual	~vGenerator (void)

Copy and Assignment
virtual vGenerator &	Assign (const Type &rSrc)

virtual vGenerator &	AssignWithoutAttributes (const vGenerator &rGen)

virtual void	Move (vGenerator &rGen)

vGenerator &	operator= (const vGenerator &rOtherGen)

virtual void	Version (const std::string &rVersion, vGenerator &rResGen) const

virtual void	Version (Idx version, vGenerator &rResGen) const

virtual void	Version (const std::string &rPattern, const std::string &rReplacement, vGenerator &rResGen) const

Basic Maintenance
virtual bool	Valid (void) const

virtual void	Clear (void)

void	ClearStates (void)

Idx	AlphabetSize (void) const

Idx	Size (void) const

Idx	TransRelSize (void) const

Idx	InitStatesSize (void) const

Idx	MarkedStatesSize (void) const

bool	Empty (void) const

bool	AlphabetEmpty (void) const

bool	TransRelEmpty (void) const

bool	InitStatesEmpty (void) const

bool	MarkedStatesEmpty (void) const

Event Symboltable
SymbolTable *	EventSymbolTablep (void) const

virtual void	EventSymbolTablep (SymbolTable *pSymTab)

virtual void	EventSymbolTablep (const vGenerator &rOtherGen)

EventSet	NewEventSet (void) const

EventSet *	NewEventSetp (void) const

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

std::string	EventName (Idx index) const

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

std::string	UniqueEventName (const std::string &rName) const

bool	EventRename (Idx event, const std::string &rNewName)

bool	EventRename (const std::string &rOldName, const std::string &rNewName)

State Symboltable
const SymbolTable &	StateSymbolTable (void) const

void	StateSymbolTable (const SymbolTable &rSymTab)

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

std::string	StateName (Idx index) const

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

void	ClearStateNames (void)

void	ClrStateName (Idx index)

void	ClrStateName (const std::string &rName)

bool	StateNamesEnabled (void) const

void	StateNamesEnabled (bool flag)

void	SetDefaultStateNames (void)

void	EnforceStateNames (const std::string &rTemplate)

std::string	UniqueStateName (const std::string &rName) const

Read Access to Core Members
EventSet::Iterator	AlphabetBegin (void) const

EventSet::Iterator	AlphabetEnd (void) const

bool	ExistsEvent (Idx index) const

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

EventSet::Iterator	FindEvent (Idx index) const

EventSet::Iterator	FindEvent (const std::string &rName) const

const EventSet &	Alphabet (void) const

StateSet::Iterator	StatesBegin (void) const

StateSet::Iterator	StatesEnd (void) const

bool	ExistsState (Idx index) const

bool	ExistsState (const std::string &name) const

StateSet::Iterator	FindState (Idx index) const

StateSet::Iterator	FindState (const std::string &rName) const

const StateSet &	States (void) const

Idx	InitState (void) const

StateSet::Iterator	InitStatesBegin (void) const

StateSet::Iterator	InitStatesEnd (void) const

bool	ExistsInitState (Idx index) const

StateSet::Iterator	FindInitState (Idx index) const

const StateSet &	InitStates (void) const

StateSet::Iterator	MarkedStatesBegin (void) const

StateSet::Iterator	MarkedStatesEnd (void) const

bool	ExistsMarkedState (Idx index) const

StateSet::Iterator	FindMarkedState (Idx index) const

const StateSet &	MarkedStates (void) const

TransSet::Iterator	TransRelBegin (void) const

TransSet::Iterator	TransRelEnd (void) const

TransSet::Iterator	TransRelBegin (Idx x1) const

TransSet::Iterator	TransRelEnd (Idx x1) const

TransSet::Iterator	TransRelBegin (Idx x1, Idx ev) const

TransSet::Iterator	TransRelEnd (Idx x1, Idx ev) const

TransSet::Iterator	FindTransition (const std::string &rX1, const std::string &rEv, const std::string &rX2) const

TransSet::Iterator	FindTransition (Idx x1, Idx ev, Idx x2) const

TransSet::Iterator	FindTransition (const Transition &rTrans) const

bool	ExistsTransition (const std::string &rX1, const std::string &rEv, const std::string &rX2) const

bool	ExistsTransition (Idx x1, Idx ev, Idx x2) const

bool	ExistsTransition (const Transition &rTrans) const

bool	ExistsTransition (Idx x1, Idx ev) const

bool	ExistsTransition (Idx x1) const

const TransSet &	TransRel (void) const

void	TransRel (TransSetX1EvX2 &res) const

void	TransRel (TransSetEvX1X2 &res) const

void	TransRel (TransSetEvX2X1 &res) const

void	TransRel (TransSetX2EvX1 &res) const

void	TransRel (TransSetX2X1Ev &res) const

void	TransRel (TransSetX1X2Ev &res) const

Transition	TransitionByNames (const std::string &rX1, const std::string &rEv, const std::string &rX2) const

Write Access to Core Members
bool	InsEvent (Idx index)

Idx	InsEvent (const std::string &rName)

void	InsEvents (const EventSet &events)

bool	DelEvent (Idx index)

bool	DelEvent (const std::string &rName)

void	DelEvents (const EventSet &rEvents)

bool	DelEventFromAlphabet (Idx index)

void	InjectAlphabet (const EventSet &rNewalphabet)

virtual void	RestrictAlphabet (const EventSet &rNewalphabet)

Idx	InsState (void)

bool	InsState (Idx index)

Idx	InsState (const std::string &rName)

void	InsStates (const StateSet &rStates)

bool	DelState (Idx index)

bool	DelState (const std::string &rName)

void	DelStates (const StateSet &rDelStates)

bool	DelStateFromStates (Idx index)

StateSet::Iterator	DelStateFromStates (StateSet::Iterator pos)

virtual void	RestrictStates (const StateSet &rStates)

void	InjectState (Idx index)

void	InjectStates (const StateSet &rNewStates)

Idx	InsInitState (void)

bool	InsInitState (Idx index)

Idx	InsInitState (const std::string &rName)

void	InsInitStates (const StateSet &rStates)

Idx	InsMarkedState (void)

bool	InsMarkedState (Idx index)

Idx	InsMarkedState (const std::string &rName)

void	InsMarkedStates (const StateSet &rStates)

void	SetInitState (Idx index)

void	SetInitState (const std::string &rName)

void	InjectInitStates (const StateSet &rNewInitStates)

void	ClrInitState (Idx index)

void	ClrInitState (const std::string &rName)

StateSet::Iterator	ClrInitState (StateSet::Iterator pos)

void	ClearInitStates (void)

void	SetMarkedState (Idx index)

void	SetMarkedState (const std::string &rName)

void	ClrMarkedState (Idx index)

void	ClrMarkedState (const std::string &rName)

StateSet::Iterator	ClrMarkedState (StateSet::Iterator pos)

void	ClearMarkedStates (void)

void	InjectMarkedStates (const StateSet &rNewMarkedStates)

bool	SetTransition (Idx x1, Idx ev, Idx x2)

bool	SetTransition (const std::string &rX1, const std::string &rEv, const std::string &rX2)

bool	SetTransition (const Transition &rTransition)

void	ClrTransition (Idx x1, Idx ev, Idx x2)

void	ClrTransition (const Transition &rTrans)

TransSet::Iterator	ClrTransition (TransSet::Iterator it)

void	ClrTransitions (Idx x1, Idx ev)

void	ClrTransitions (Idx x1)

void	ClearTransRel (void)

void	InjectTransition (const Transition &rTrans)

void	InjectTransRel (const TransSet &rNewtransrel)

Attributes
virtual void	ClearAttributes (void)

virtual bool	UpdateAttributes (void)

virtual void	ClearEventAttributes (void)

virtual void	ClrEventAttribute (Idx index)

virtual void	EventAttribute (Idx index, const Type &rAttr)

virtual void	EventAttributes (const EventSet &rEventSet)

virtual const AttributeVoid &	EventAttribute (Idx index) const

virtual const AttributeVoid &	EventAttribute (const std::string &rName) const

virtual AttributeVoid *	EventAttributep (Idx index)

virtual AttributeVoid *	EventAttributep (const std::string &rName)

virtual void	ClearStateAttributes (void)

virtual void	ClrStateAttribute (Idx index)

virtual void	StateAttribute (Idx index, const Type &rAttr)

virtual const AttributeVoid &	StateAttribute (Idx index) const

virtual AttributeVoid *	StateAttributep (Idx index)

virtual void	ClearTransAttributes (void)

virtual void	TransAttribute (const Transition &rTrans, const Type &rAttr)

virtual void	ClrTransAttribute (const Transition &rTrans)

virtual const AttributeVoid &	TransAttribute (const Transition &rTrans) const

virtual AttributeVoid *	TransAttributep (const Transition &rTrans)

virtual void	ClearGlobalAttribute (void)

virtual void	GlobalAttribute (const Type &rAttr)

virtual void	GlobalAttributeTry (const Type &rAttr)

virtual const AttributeVoid &	GlobalAttribute (void) const

virtual AttributeVoid *	GlobalAttributep (void)

Reachability
StateSet	AccessibleSet (void) const

bool	Accessible (void)

bool	IsAccessible (void) const

StateSet	CoaccessibleSet (void) const

bool	Coaccessible (void)

bool	IsCoaccessible (void) const

StateSet	BlockingStates (void) const

StateSet	TerminalStates (void) const

StateSet	TerminalStates (const StateSet &rStates) const

bool	IsComplete (void) const

bool	IsComplete (const StateSet &rStates) const

bool	IsComplete (const EventSet &rSigmaO) const

bool	Complete (void)

bool	Complete (const EventSet &rSigmaO)

StateSet	TrimSet (void) const

bool	Trim (void)

bool	IsTrim (void) const

Misc
EventSet	UsedEvents (void) const

EventSet	UnusedEvents (void) const

void	MinimizeAlphabet (void)

EventSet	ActiveEventSet (Idx x1) const

TransSet	ActiveTransSet (Idx x1) const

StateSet	TransRelStates (void) const

Idx	SuccessorState (Idx x1, Idx ev) const

StateSet	SuccessorStates (Idx x1) const

StateSet	SuccessorStates (Idx x1, Idx ev) const

bool	IsDeterministic (void) const

void	SetMinStateIndexMap (void) const

void	ClearMinStateIndexMap (void) const

Idx	MinStateIndex (Idx index) const

void	MinStateIndex (void)

Idx	MaxStateIndex (void) const

const std::map< Idx, Idx > &	MinStateIndexMap (void) const

std::string	EStr (Idx index) const

std::string	SStr (Idx index) const

std::string	TStr (const Transition &rTrans) const

void	GraphWrite (const std::string &rFileName, const std::string &rOutFormat="", const std::string &rDotExec="dot") const

bool	operator< (const vGenerator &rOtherGen) 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)

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)

virtual bool	IsDefault (void) const

Type &	operator= (const 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)

Type &	operator= (const 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)

Static Public Member Functions
static SymbolTable *	GlobalEventSymbolTablep (void)

static void	StateNamesEnabledDefault (bool flag)

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

Protected Member Functions
virtual void	NewCore (void)

virtual void	DeleteCore (void)

virtual void	UpdateCore (void)

void	ConfigureAttributeTypes (const AttributeVoid pNewGlobalPrototype, const StateSet pNewStatesPrototype, const EventSet pNewAlphabetPrototype, const TransSet pNewTransRelPrototype)

void	DoAssign (const vGenerator &rSrc)

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

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

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

virtual void	DoSWrite (TokenWriter &rTw) const

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

void	ReadAlphabet (TokenReader &rTr)

void	WriteStates (TokenWriter &rTw) const

void	ReadStates (TokenReader &rTr)

void	XReadStateSet (TokenReader &rTr, StateSet &rStateSet, const std::string &rLabel="") const

void	ReadTransRel (const std::string &rFileName)

void	ReadTransRel (TokenReader &rTr)

void	XReadTransRel (TokenReader &rTr)

void	XWriteTransRel (TokenWriter &rTw) const

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

bool	DoEqual (const AttrType &rOther) const

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

bool	DoEqual (const Type &rOther) const

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

Static Protected Member Functions
static const EventSet &	AlphabetVoid (void)

static const StateSet &	StatesVoid (void)

static const TransSet &	TransRelVoid (void)

static const AttributeVoid &	GlobalVoid (void)

Protected Attributes
Idx	mId

SymbolTable	mStateSymbolTable

SymbolTable *	mpStateSymbolTable

SymbolTable *	mpEventSymbolTable

bool	mStateNamesEnabled

bool	mReindexOnWrite

EventSet *	mpAlphabet

StateSet *	mpStates

TransSet *	mpTransRel

AttributeVoid *	mpGlobalAttribute

const EventSet *	pAlphabetPrototype

const StateSet *	pStatesPrototype

const TransSet *	pTransRelPrototype

const AttributeVoid *	pGlobalPrototype

StateSet	mInitStates

StateSet	mMarkedStates

std::map< Idx, Idx >	mMinStateIndexMap

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

std::string	mElementTagDef

std::string	mObjectName

Static Protected Attributes
static Idx	msObjectCount = 0

static bool	msStateNamesEnabledDefault = true

static bool	msReindexOnWriteDefault = false

File IO
void	WriteAlphabet (void) const

std::string	AlphabetToString (void) const

void	WriteAlphabet (TokenWriter &rTw) const

void	WriteStateSet (const StateSet &rStateSet) const

std::string	StateSetToString (const StateSet &rStateSet) const

std::string	StateSetToText (const StateSet &rStateSet) const

void	WriteStateSet (TokenWriter &rTw, const StateSet &rStateSet, const std::string &rLabel="") const

void	XWriteStateSet (TokenWriter &rTw, const StateSet &rStateSet, const std::string &rLabel="") const

void	DWriteStateSet (TokenWriter &rTw, const StateSet &rStateSet) const

std::string	StatesToString (void) const

std::string	StatesToText (void) const

std::string	MarkedStatesToString (void) const

std::string	InitStatesToString (void) const

void	WriteTransRel (void) const

std::string	TransRelToString (void) const

std::string	TransRelToText (void) const

void	WriteTransRel (TokenWriter &rTw) const

void	DWriteTransRel (TokenWriter &rTw) const

virtual void	DotWrite (const std::string &rFileName) const

virtual void	DDotWrite (const std::string &rFileName) const

virtual void	XDotWrite (const std::string &rFileName) const

void	ReadStateSet (TokenReader &rTr, const std::string &rLabel, StateSet &rStateSet) const

bool	ReindexOnWrite (void) const

void	ReindexOnWrite (bool flag)

static void	ReindexOnWriteDefault (bool flag)

static bool	ReindexOnWriteDefault (void)

Constructor & Destructor Documentation

◆ vGenerator() [1/3]

faudes::vGenerator::vGenerator ( void )

doxygen group Default constructor

Definition at line 66 of file cfl_generator.cpp.

◆ vGenerator() [2/3]

faudes::vGenerator::vGenerator ( const vGenerator & rOtherGen )

Copy-constructror

Definition at line 101 of file cfl_generator.cpp.

◆ vGenerator() [3/3]

faudes::vGenerator::vGenerator ( const std::string & rFileName )

Construct from file. This constructor effectively uses the DoRead(TokenReader&) function to read.

Parameters

rFileName Name of file

Exceptions

Exception

IO errors (id 1)
Token mismatch (id 50, 51, 52, 80, 85)

Definition at line 135 of file cfl_generator.cpp.

◆ ~vGenerator()

faudes::vGenerator::~vGenerator ( void )

virtual

Destructor

Definition at line 202 of file cfl_generator.cpp.

Member Function Documentation

◆ Accessible()

bool faudes::vGenerator::Accessible ( void )

Make generator accessible.

Returns: True if generator contains at least one initial state

Definition at line 2027 of file cfl_generator.cpp.

◆ AccessibleSet()

StateSet faudes::vGenerator::AccessibleSet ( void ) const

doxygen group Compute set of accessible states

Definition at line 1995 of file cfl_generator.cpp.

◆ ActiveEventSet()

EventSet faudes::vGenerator::ActiveEventSet ( Idx x1 ) const

Return active event set at state x1

Parameters

x1	Index of x1

Returns: EventSet

Definition at line 1935 of file cfl_generator.cpp.

◆ ActiveTransSet()

TransSet faudes::vGenerator::ActiveTransSet ( Idx x1 ) const

Return active transition set at state x1

Parameters

x1	Index of x1

Returns: EventSet

Definition at line 1945 of file cfl_generator.cpp.

◆ Alphabet()

const EventSet & faudes::vGenerator::Alphabet ( void ) const

Return const reference to alphabet

Returns: EventSet Reference to mpAlphabet

Definition at line 1875 of file cfl_generator.cpp.

◆ AlphabetBegin()

EventSet::Iterator faudes::vGenerator::AlphabetBegin ( void ) const

doxygen group Iterator to Begin() of alphabet

Returns: Iterator to begin of mpAlphabet

Definition at line 1044 of file cfl_generator.cpp.

◆ AlphabetEmpty()

bool faudes::vGenerator::AlphabetEmpty ( void ) const

Check if alphabet is Empty

Returns: True if mpAlphabet is empty

Definition at line 645 of file cfl_generator.cpp.

◆ AlphabetEnd()

EventSet::Iterator faudes::vGenerator::AlphabetEnd ( void ) const

Iterator to End() of alphabet

Returns: Iterator to end of mpAlphabet

Definition at line 1049 of file cfl_generator.cpp.

◆ AlphabetSize()

Idx faudes::vGenerator::AlphabetSize ( void ) const

Get number of events in alphabet

Returns: Number of events

Definition at line 569 of file cfl_generator.cpp.

◆ AlphabetToString()

std::string faudes::vGenerator::AlphabetToString ( void ) const

Write generators alphabet to string

Returns: std::string

Exceptions

Exception

IO errors (id 2)

Definition at line 2489 of file cfl_generator.cpp.

◆ AlphabetVoid()

const EventSet & faudes::vGenerator::AlphabetVoid ( void )

staticprotected

Static default alphabet prototype (incl. attribute type)

Definition at line 45 of file cfl_generator.cpp.

◆ Assign()

vGenerator & faudes::vGenerator::Assign ( const Type & rSrc )

virtual

doxygen group Copy from other faudes type. The current implementation tests whether the source object can be casted to a generator and then performs the according assignment.

Parameters

rSrc	Source to copy from.

Reimplemented from faudes::Type.

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >, faudes::TmtcGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::TcGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::TpGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TrGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 295 of file cfl_generator.cpp.

◆ AssignWithoutAttributes()

vGenerator & faudes::vGenerator::AssignWithoutAttributes ( const vGenerator & rGen )

virtual

Copy from other vGenerator, ignore attributes.

Parameters

rGen	Source to copy from.

Definition at line 311 of file cfl_generator.cpp.

◆ BlockingStates()

StateSet faudes::vGenerator::BlockingStates ( void ) const

Compute set of blocking states.

A state is considered blocking if it is accessible but not coaccessible.

Definition at line 2145 of file cfl_generator.cpp.

◆ Cast()

const Type * faudes::vGenerator::Cast ( const Type * pOther ) const

virtual

Type test. Uses C++ dynamic cast to test whether the specified object casts to a vGenerator.

Returns: vGenerator reference if dynamic cast succeeds, else NULL

Reimplemented from faudes::Type.

Reimplemented in faudes::TcGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >, faudes::TtGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::TpGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::TrGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TlhaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 196 of file cfl_generator.cpp.

◆ Clear()

void faudes::vGenerator::Clear ( void )

virtual

Clear generator data. Clears state set, alphabet and transitionrealtion. Behavioural flags eg StateNamesEnabled are maintained.

Reimplemented from faudes::Type.

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >, faudes::Executor, and faudes::TpGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 579 of file cfl_generator.cpp.

◆ ClearAttributes()

void faudes::vGenerator::ClearAttributes ( void )

virtual

doxygen group Clear Attributes

Definition at line 612 of file cfl_generator.cpp.

◆ ClearEventAttributes()

void faudes::vGenerator::ClearEventAttributes ( void )

virtual

Clear event attributes

Definition at line 602 of file cfl_generator.cpp.

◆ ClearGlobalAttribute()

void faudes::vGenerator::ClearGlobalAttribute ( void )

virtual

Clear global attribute

Definition at line 592 of file cfl_generator.cpp.

◆ ClearInitStates()

void faudes::vGenerator::ClearInitStates ( void )

Clear all mInitStates

Definition at line 1499 of file cfl_generator.cpp.

◆ ClearMarkedStates()

void faudes::vGenerator::ClearMarkedStates ( void )

Clear all marked states

Definition at line 1574 of file cfl_generator.cpp.

◆ ClearMinStateIndexMap()

void faudes::vGenerator::ClearMinStateIndexMap ( void ) const

Clear minimal index map for 1:1 file io

Definition at line 671 of file cfl_generator.cpp.

◆ ClearStateAttributes()

void faudes::vGenerator::ClearStateAttributes ( void )

virtual

Clear state attributes

Reimplemented in faudes::TmtcGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 597 of file cfl_generator.cpp.

◆ ClearStateNames()

void faudes::vGenerator::ClearStateNames ( void )

Remove all names from generator's StateSymbolTable

Definition at line 967 of file cfl_generator.cpp.

◆ ClearStates()

void faudes::vGenerator::ClearStates ( void )

Clear all states and transitions, maintain alphabet.

Definition at line 621 of file cfl_generator.cpp.

◆ ClearTransAttributes()

void faudes::vGenerator::ClearTransAttributes ( void )

virtual

Clear transition attributes

Definition at line 607 of file cfl_generator.cpp.

◆ ClearTransRel()

void faudes::vGenerator::ClearTransRel ( void )

Clear all transitions

Definition at line 1714 of file cfl_generator.cpp.

◆ ClrEventAttribute()

void faudes::vGenerator::ClrEventAttribute ( Idx index )

virtual

Clear attribute for existing event

Parameters

index Event index

Definition at line 1734 of file cfl_generator.cpp.

◆ ClrInitState() [1/3]

void faudes::vGenerator::ClrInitState ( const std::string & rName )

Unset an existing state as initial state by name

Parameters

rName State name

Exceptions

Exception

State name not known in generator (id 90)

Definition at line 1479 of file cfl_generator.cpp.

◆ ClrInitState() [2/3]

void faudes::vGenerator::ClrInitState ( Idx index )

Unset an existing state as initial state by index

Define FAUDES_CHECKED for consistency checks.

Parameters

index State index

Exceptions

Exception

State index not found in generator (id 91)

Definition at line 1465 of file cfl_generator.cpp.

◆ ClrInitState() [3/3]

StateSet::Iterator faudes::vGenerator::ClrInitState ( StateSet::Iterator pos )

Unset an existing state as initial state by iterator

Parameters

pos	StateSet::iterator

Returns: Iterator to next init state

Definition at line 1493 of file cfl_generator.cpp.

◆ ClrMarkedState() [1/3]

void faudes::vGenerator::ClrMarkedState ( const std::string & rName )

Unset an existing state as marked state by name

Parameters

rName State name

Exceptions

Exception

State index not found in generator (id 91)

Definition at line 1554 of file cfl_generator.cpp.

◆ ClrMarkedState() [2/3]

void faudes::vGenerator::ClrMarkedState ( Idx index )

Unset an existing state as marked state by index

Parameters

index State index

Exceptions

Exception

State index not found in generator (id 91)

Definition at line 1540 of file cfl_generator.cpp.

◆ ClrMarkedState() [3/3]

StateSet::Iterator faudes::vGenerator::ClrMarkedState ( StateSet::Iterator pos )

Unset an existing state as marked state by iterator

Parameters

pos	StateSet::iterator

Returns: Iterator to next marked state

Definition at line 1568 of file cfl_generator.cpp.

◆ ClrStateAttribute()

void faudes::vGenerator::ClrStateAttribute ( Idx index )

virtual

Clear attribute for existing state

Parameters

index State index

Definition at line 1747 of file cfl_generator.cpp.

◆ ClrStateName() [1/2]

void faudes::vGenerator::ClrStateName ( const std::string & rName )

Clear name for individual state

Parameters

rName State name

Definition at line 988 of file cfl_generator.cpp.

◆ ClrStateName() [2/2]

void faudes::vGenerator::ClrStateName ( Idx index )

Clear name for individual state

Parameters

index State index

Exceptions

Exception

state does not exist in generator (id 90)

Definition at line 974 of file cfl_generator.cpp.

◆ ClrTransAttribute()

void faudes::vGenerator::ClrTransAttribute ( const Transition & rTrans )

virtual

Clear attribute for existing transition

Parameters

rTrans transition

Definition at line 1708 of file cfl_generator.cpp.

◆ ClrTransition() [1/3]

void faudes::vGenerator::ClrTransition ( const Transition & rTrans )

Remove a transition by transition object

Parameters

rTrans Transition object

Definition at line 1664 of file cfl_generator.cpp.

◆ ClrTransition() [2/3]

void faudes::vGenerator::ClrTransition	(	Idx	x1,
		Idx	ev,
		Idx	x2
	)

Remove a transition by indices

Parameters

x1	Predecessor state index
ev	Event index
x2	Successor state index

Definition at line 1657 of file cfl_generator.cpp.

◆ ClrTransition() [3/3]

TransSet::Iterator faudes::vGenerator::ClrTransition ( TransSet::Iterator it )

Remove a transition by iterator

Parameters

it	TransSet::iterator

Returns: Iterator to next transition

Definition at line 1670 of file cfl_generator.cpp.

◆ ClrTransitions() [1/2]

void faudes::vGenerator::ClrTransitions ( Idx x1 )

Remove a transitions by state

Parameters

x1	Predecessor state index

Definition at line 1683 of file cfl_generator.cpp.

◆ ClrTransitions() [2/2]

void faudes::vGenerator::ClrTransitions	(	Idx	x1,
		Idx	ev
	)

Remove a transitions by state and event

Parameters

x1	Predecessor state index
ev	Event index

Definition at line 1676 of file cfl_generator.cpp.

◆ Coaccessible()

bool faudes::vGenerator::Coaccessible ( void )

Make generator Coaccessible

Returns: True if generator contains at least one marked state

Definition at line 2086 of file cfl_generator.cpp.

◆ CoaccessibleSet()

StateSet faudes::vGenerator::CoaccessibleSet ( void ) const

Compute set of Coaccessible states

Definition at line 2051 of file cfl_generator.cpp.

◆ Complete() [1/2]

bool faudes::vGenerator::Complete ( const EventSet & rSigmaO )

Make generator Complete w.r.t. an alphabet

This procedure removes all states that conflict with completes w.r.t. the specified alphabet Sigma_o until a fixpoint is reached. The current implementation consists of an outer iteration to restrict a domain of states and an inner iteration for abcakwar reachability analyis.

THIS IS EXPERIMENTAL / NEEDS TESTING

Parameters

rSigmaO Specified alphabet Sigma_o

Returns: True if generator contains at least one initial state

Definition at line 2243 of file cfl_generator.cpp.

◆ Complete() [2/2]

bool faudes::vGenerator::Complete ( void )

Make generator Complete.

This procedure removes all states that are guaranteed to evolve into a terminal state within a finite number of transitios. The current implementations is initialized by the set of terminal states and then performs a backward reachability analysis.

Returns: True if generator contains at least one initial state

Definition at line 2213 of file cfl_generator.cpp.

◆ ConfigureAttributeTypes()

void faudes::vGenerator::ConfigureAttributeTypes	(	const AttributeVoid *	pNewGlobalPrototype,
		const StateSet *	pNewStatesPrototype,
		const EventSet *	pNewAlphabetPrototype,
		const TransSet *	pNewTransRelPrototype
	)

protected

Configure attribute types

Definition at line 209 of file cfl_generator.cpp.

◆ Copy()

vGenerator * faudes::vGenerator::Copy ( void ) const

virtual

Construct copy on heap. Technically not a constructor, this function creates a vGenerator with the same event symboltable. It is the callers responsebilty to delete the object when no longer needed. Derived classes must reimplement this function to create an object of the same class and the same event symboltable.

Returns: New vGenerator

Reimplemented from faudes::Type.

Definition at line 188 of file cfl_generator.cpp.

◆ DDotWrite()

void faudes::vGenerator::DDotWrite ( const std::string & rFileName ) const

virtual

Writes generator to dot input format (no re-indexing). Variant of DotWrite() without re-indexing.

Parameters

rFileName File to write

Exceptions

Exception

IO errors (id 2)

Definition at line 3030 of file cfl_generator.cpp.

◆ DeleteCore()

void faudes::vGenerator::DeleteCore ( void )

protectedvirtual

Free my heap members (attribute dependent types)

Definition at line 247 of file cfl_generator.cpp.

◆ DelEvent() [1/2]

bool faudes::vGenerator::DelEvent ( const std::string & rName )

Delete event from generator by name. mpEventSymbolTable stays untouched. Transitions containing event will be removed too.

Parameters

rName Name of event

Returns: True, if event was in alphabet

Definition at line 1219 of file cfl_generator.cpp.

◆ DelEvent() [2/2]

bool faudes::vGenerator::DelEvent ( Idx index )

Delete event from generator by index. mpEventSymbolTable stays untouched. Transitions containing event will be removed too.

Parameters

index Index of event

Returns: True, if event was in alphabet

Definition at line 1212 of file cfl_generator.cpp.

◆ DelEventFromAlphabet()

bool faudes::vGenerator::DelEventFromAlphabet ( Idx index )

Delete event from alphabet without consistency check. The event is only deleted from mpAlphabet but not from transition relation.

Parameters

index Index of event

Returns: True, if event was in alphabet

Definition at line 1237 of file cfl_generator.cpp.

◆ DelEvents()

void faudes::vGenerator::DelEvents ( const EventSet & rEvents )

Delete a set of events from generator. mpEventSymbolTable stays untouched. Transitions containing events will be removed too.

Parameters

rEvents EventSet containing events to remove

Definition at line 1227 of file cfl_generator.cpp.

◆ DelState() [1/2]

bool faudes::vGenerator::DelState ( const std::string & rName )

Delete a state from generator by name. Cleans mpStates, mInitStates, mMarkedStates, mpTransRel and mpStateSymbolTable.

Parameters

rName Name of state to delete. Will be erased in mpStateSymbolTable too

Returns: True, if state was in stateset

Exceptions

Exception

Symbolic name not known (id 90)

Definition at line 1362 of file cfl_generator.cpp.

◆ DelState() [2/2]

bool faudes::vGenerator::DelState ( Idx index )

Delete a state from generator by index. Cleans mpStates, mInitStates, mMarkedStates, mpTransRel and mpStateSymbolTable.

Parameters

index Index of state to delete.

Returns: True, if state was in stateset

Definition at line 1347 of file cfl_generator.cpp.

◆ DelStateFromStates() [1/2]

bool faudes::vGenerator::DelStateFromStates ( Idx index )

Delete a state from generator without consistency check. This removes the state from mpStates and mpStateSymbolTable but doesn't touch mpTransRel, mInitStates and mMarkedStates.

Parameters

index Index of state to delete.

Returns: True, if state was in stateset

Definition at line 1396 of file cfl_generator.cpp.

◆ DelStateFromStates() [2/2]

StateSet::Iterator faudes::vGenerator::DelStateFromStates ( StateSet::Iterator pos )

Delete a state from generator without consistency check. This removes the state from mpStates and mpStateSymbolTable but doesn't touch mpTransRel, mInitStates and mMarkedStates. Index to delete is given by iterator.

Parameters

pos	StateSet::Iterator

Returns: Iteraror to next state

Definition at line 1403 of file cfl_generator.cpp.

◆ DelStates()

void faudes::vGenerator::DelStates ( const StateSet & rDelStates )

Delete a set of states Cleans mpStates, mInitStates, mMarkedStates, mpTransrel, and mpStateSymboltable

Parameters

rDelStates StateSet containing states aka indicees to delete

Definition at line 1378 of file cfl_generator.cpp.

◆ DoAssign()

void faudes::vGenerator::DoAssign ( const vGenerator & rSrc )

protected

Assignment for matching type

Definition at line 263 of file cfl_generator.cpp.

◆ DoDWrite()

void faudes::vGenerator::DoDWrite	(	TokenWriter &	rTw,
		const std::string &	rLabel = `""`,
		const Type *	pContext = `0`
	)		const

protectedvirtual

Write generator in debugging format to TokenWriter, see Type::DWrite for public wrappers.

Reimplement this method in derived classes to provide the std token io interface defined in the public section of Type.

Parameters

rTw	Reference to TokenWriter
rLabel	Label of section to write
pContext	Write context to provide contextual information (ignored)

Exceptions

Exception

IO errors (id 2)

Reimplemented from faudes::Type.

Definition at line 2419 of file cfl_generator.cpp.

◆ DoRead()

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

protectedvirtual

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

Virtual function for std token io interface. Context is ignored, label defaults to "Generator".

Parameters

rTr	TokenReader to read from
rLabel	Section to read
pContext	Read context to provide contextual information (ignored)

Exceptions

Exception

token mismatch (id 50, 51, 52, 80, 85)
IO error (id 1)

Reimplemented from faudes::Type.

Reimplemented in faudes::Executor, and faudes::TlhaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 3122 of file cfl_generator.cpp.

◆ DoSWrite()

void faudes::vGenerator::DoSWrite ( TokenWriter & rTw ) const

protectedvirtual

Write generator statistics as comment to TokenWriter, see Type::SWrite for public wrappers.

Reimplement this method in derived classes to provide the std token io interface defined in the public section of Type.

Parameters

rTw	Reference to TokenWriter

Exceptions

Exception

IO errors (id 2)

Reimplemented from faudes::Type.

Reimplemented in faudes::TmtcGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 2953 of file cfl_generator.cpp.

◆ DotWrite()

void faudes::vGenerator::DotWrite ( const std::string & rFileName ) const

virtual

Writes generator to dot input format. The dot file format is specified by the graphiz package; see http://www.graphviz.org. The package includes the dot command line tool to generate a graphical representation of the generators graph. See also GraphWrite(). This functions sets the re-indexing to minimal indices.

Parameters

rFileName File to write

Exceptions

Exception

IO errors (id 2)

Reimplemented in faudes::TrGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::TmtcGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 2969 of file cfl_generator.cpp.

◆ DoWrite()

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

protectedvirtual

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

Virtual function for std token io interface. Context is ignored, label defaults to "Generator". If the tokenwriter writes to a file, state indices will be re-indext to start from 1.

Parameters

rTw	Reference to TokenWriter
rLabel	Label of section to write
pContext	Write context to provide contextual information (ignored)

Exceptions

Exception

IO errors (id 2)

Reimplemented from faudes::Type.

Reimplemented in faudes::Executor, and faudes::TlhaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 2379 of file cfl_generator.cpp.

◆ DoXWrite()

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

protectedvirtual

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

Virtual function for std token io interface. Context is ignored, label defaults to "Generator".

Parameters

rTw	Reference to TokenWriter
rLabel	Label of section to write
pContext	Write context to provide contextual information (ignored)

Exceptions

Exception

IO errors (id 2)

Reimplemented from faudes::Type.

Definition at line 2449 of file cfl_generator.cpp.

◆ DWriteStateSet()

void faudes::vGenerator::DWriteStateSet	(	TokenWriter &	rTw,
		const StateSet &	rStateSet
	)		const

Write a stateset to TokenWriter (debug version, no re-indexing)

Parameters

rTw	Reference to TokenWriter
rStateSet	Reference to stateset

Exceptions

Exception

IO errors (id 2)

Definition at line 2705 of file cfl_generator.cpp.

◆ DWriteTransRel()

void faudes::vGenerator::DWriteTransRel ( TokenWriter & rTw ) const

Write transition relation to tokenwriter (debug version)

Parameters

rTw	Reference to TokenWriter

Exceptions

Exception

IO errors (id 2)

Definition at line 2873 of file cfl_generator.cpp.

◆ Empty()

bool faudes::vGenerator::Empty ( void ) const

Check if generator is empty (no states)

Returns: True if state set is empty

Definition at line 650 of file cfl_generator.cpp.

◆ EnforceStateNames()

void faudes::vGenerator::EnforceStateNames ( const std::string & rTemplate )

For all states without a symbolic name, assign a name based on suggested template and the index.

Parameters

rTemplate Basis for name generation

Definition at line 1024 of file cfl_generator.cpp.

◆ EStr()

std::string faudes::vGenerator::EStr ( Idx index ) const

Pretty printable event name for index (eg for debugging).

Parameters

index Event index

Returns: std::string

Definition at line 3885 of file cfl_generator.cpp.

◆ EventAttribute() [1/3]

const AttributeVoid & faudes::vGenerator::EventAttribute ( const std::string & rName ) const

virtual

Event attribute lookup. In a context where the attribute type is known, you may prefer the TaGenerator method.

Parameters

rName

Returns: reference to attribute

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1823 of file cfl_generator.cpp.

◆ EventAttribute() [2/3]

const AttributeVoid & faudes::vGenerator::EventAttribute ( Idx index ) const

virtual

Event attribute lookup. In a context where the attribute type is known, you may prefer the TaGenerator method.

Parameters

index

Returns: reference to attribute

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1813 of file cfl_generator.cpp.

◆ EventAttribute() [3/3]

void faudes::vGenerator::EventAttribute	(	Idx	index,
		const Type &	rAttr
	)

virtual

Set attribute for existing event. This version uses a dynamic cast to test the actual type of the provided attribute. An exception is thrown for an invalid attribute type. In a context where the attribute type is known, you may prefer the TaGenerator method.

Parameters

index	Event index
rAttr	New attribute

Exceptions

Exception

Index not found in alphabet (id 60)
Cannot cast attribute (id 63)

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1719 of file cfl_generator.cpp.

◆ EventAttributep() [1/2]

AttributeVoid * faudes::vGenerator::EventAttributep ( const std::string & rName )

virtual

Event attribute pointer to access Attribute methods. If there are no attributes (plain vGenerator) this method returs 0. If there are attributes, an explicit default value may be inserted. In a context where the attribute type is known, you may prefer the TaGenerator method.

Parameters

rName

Returns: pointer to attribute

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1828 of file cfl_generator.cpp.

◆ EventAttributep() [2/2]

AttributeVoid * faudes::vGenerator::EventAttributep ( Idx index )

virtual

Event attribute pointer to access Attribute methods. If there are no attributes (plain vGenerator) this method returs 0. If there are attributes, an explicit default value may be inserted. In a context where the attribute type is known, you may prefer the TaGenerator method.

Parameters

index

Returns: pointer to attribute

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1818 of file cfl_generator.cpp.

◆ EventAttributes()

void faudes::vGenerator::EventAttributes ( const EventSet & rEventSet )

virtual

Set attributes for existing events. This version uses a dynamic cast to test the actual type of the provided attributes. An exception is thrown for an invalid attribute type.

Parameters

rEventSet Set of attributed events

Exceptions

Exception

Element not found in alphabet (id 60)
Cannot cast attribute (id 63)

Definition at line 1727 of file cfl_generator.cpp.

◆ EventIndex()

Idx faudes::vGenerator::EventIndex ( const std::string & rName ) const

Event index lookup

Parameters

rName Name of event to lookup

Returns: Valid index or 0 if name unknown to symboltable

Definition at line 831 of file cfl_generator.cpp.

◆ EventName() [1/2]

std::string faudes::vGenerator::EventName ( Idx index ) const

Event name lookup

Parameters

index Index of event to look up

Returns: Name or empty std::string if non-existent

Definition at line 836 of file cfl_generator.cpp.

◆ EventName() [2/2]

void faudes::vGenerator::EventName	(	Idx	index,
		const std::string &	rName
	)

Set name for existing event

Note: since the event symboltable is global, this affect all generators that refer to the specified event.

Parameters

index	Event index
rName	New name

Exceptions

Exception

index not found in EventSymbolMap (id 42)
name already associated with another index (id 44)
event does not exist in generator (id 89)

Definition at line 841 of file cfl_generator.cpp.

◆ EventRename() [1/2]

bool faudes::vGenerator::EventRename	(	const std::string &	rOldName,
		const std::string &	rNewName
	)

Rename event in this generator. Convenience wrapper for EventRename(Idx, const std::string&).

Parameters

rOldName	Event to rename
rNewName	New name

Returns: True, if the new name did already exist

Exceptions

Exception

specified event does not exist (id 89)

Definition at line 909 of file cfl_generator.cpp.

◆ EventRename() [2/2]

bool faudes::vGenerator::EventRename	(	Idx	event,
		const std::string &	rNewName
	)

Rename event in this generator. This method renames the specified event. It does so by removing and adding transitions. This does not effect other generators.

Parameters

event	Event to rename
rNewName	New name

Returns: True, if the new name did already exist

Exceptions

Exception

specified event does not exist (id 89)

Definition at line 864 of file cfl_generator.cpp.

◆ EventSymbolTablep() [1/3]

void faudes::vGenerator::EventSymbolTablep ( const vGenerator & rOtherGen )

virtual

Set EventSymbolTable as given by rOtherGen. This function sets the reference to the event symboltable. The current implementation clears the generator, future versions may implement a re-indexing.

Parameters

rOtherGen Other generator

Definition at line 826 of file cfl_generator.cpp.

◆ EventSymbolTablep() [2/3]

void faudes::vGenerator::EventSymbolTablep ( SymbolTable * pSymTab )

virtual

Set EventSymbolTable to be used by this vGenerator. This function sets the reference to the event symboltable. The current implementation in derived classes clears the generator, future versions may implement a re-indexing.

Parameters

pSymTab Pointer to SymbolTable

Definition at line 820 of file cfl_generator.cpp.

◆ EventSymbolTablep() [3/3]

SymbolTable * faudes::vGenerator::EventSymbolTablep ( void ) const

doxygen group Get Pointer to EventSymbolTable currently used by this vGenerator.

Returns: Pointer to EventSymbolTable

Definition at line 810 of file cfl_generator.cpp.

◆ ExistsEvent() [1/2]

bool faudes::vGenerator::ExistsEvent ( const std::string & rName ) const

Test existence of event in alphabet

Parameters

rName Event name

Returns: True / false

Definition at line 1758 of file cfl_generator.cpp.

◆ ExistsEvent() [2/2]

bool faudes::vGenerator::ExistsEvent ( Idx index ) const

Test existence of event in alphabet

Parameters

index Event index

Returns: True / false

Definition at line 1753 of file cfl_generator.cpp.

◆ ExistsInitState()

bool faudes::vGenerator::ExistsInitState ( Idx index ) const

Test existence of state in mInitStates

Parameters

index State index

Returns: true / false

Definition at line 1793 of file cfl_generator.cpp.

◆ ExistsMarkedState()

bool faudes::vGenerator::ExistsMarkedState ( Idx index ) const

Test existence of state in mMarkedStates

Parameters

index State index

Returns: true / false

Definition at line 1803 of file cfl_generator.cpp.

◆ ExistsState() [1/2]

bool faudes::vGenerator::ExistsState ( const std::string & name ) const

Test existence of state in state set

Parameters

name	State name

Returns: true / false

Definition at line 1778 of file cfl_generator.cpp.

◆ ExistsState() [2/2]

bool faudes::vGenerator::ExistsState ( Idx index ) const

Test existence of state in state set

Parameters

index State index

Returns: true / false

Definition at line 1773 of file cfl_generator.cpp.

◆ ExistsTransition() [1/5]

bool faudes::vGenerator::ExistsTransition	(	const std::string &	rX1,
		const std::string &	rEv,
		const std::string &	rX2
	)		const

Test for transition given by x1, ev, x2

Parameters

rX1	name of Predecessor state
rEv	name of Event
rX2	name of Successor state

Returns: true / false

Definition at line 1121 of file cfl_generator.cpp.

◆ ExistsTransition() [2/5]

bool faudes::vGenerator::ExistsTransition ( const Transition & rTrans ) const

test for transition

Parameters

rTrans transition

Returns: true / false

Definition at line 1111 of file cfl_generator.cpp.

◆ ExistsTransition() [3/5]

bool faudes::vGenerator::ExistsTransition ( Idx x1 ) const

Test for transition given by x1

Parameters

x1	Predecessor state

Returns: true / false

Definition at line 1133 of file cfl_generator.cpp.

◆ ExistsTransition() [4/5]

bool faudes::vGenerator::ExistsTransition	(	Idx	x1,
		Idx	ev
	)		const

Test for transition given by x1, ev

Parameters

x1	Predecessor state
ev	Event

Returns: true / false

Definition at line 1128 of file cfl_generator.cpp.

◆ ExistsTransition() [5/5]

bool faudes::vGenerator::ExistsTransition	(	Idx	x1,
		Idx	ev,
		Idx	x2
	)		const

Test for transition given by x1, ev, x2

Parameters

x1	Predecessor state
ev	Event
x2	Successor state

Returns: true / false

Definition at line 1116 of file cfl_generator.cpp.

◆ FindEvent() [1/2]

EventSet::Iterator faudes::vGenerator::FindEvent ( const std::string & rName ) const

Returns a iterator to event index in alphabet

Parameters

rName Event name of index to find

Returns: Iterator to event index

Definition at line 1768 of file cfl_generator.cpp.

◆ FindEvent() [2/2]

EventSet::Iterator faudes::vGenerator::FindEvent ( Idx index ) const

Returns a iterator to event index in alphabet

Parameters

index Index to find

Returns: Iterator to event index

Definition at line 1763 of file cfl_generator.cpp.

◆ FindInitState()

StateSet::Iterator faudes::vGenerator::FindInitState ( Idx index ) const

Iterator to state index in mInitStates

Parameters

index Index to find

Returns: StateSet::Iterator to state index

Definition at line 1798 of file cfl_generator.cpp.

◆ FindMarkedState()

StateSet::Iterator faudes::vGenerator::FindMarkedState ( Idx index ) const

Returns a iterator to state index in mMarkedStates

Parameters

index Index to find

Returns: StateSet::Iterator to state index

Definition at line 1808 of file cfl_generator.cpp.

◆ FindState() [1/2]

StateSet::Iterator faudes::vGenerator::FindState ( const std::string & rName ) const

Returns a iterator to state with specified name

Parameters

rName name of state to find

Returns: StateSet::Iterator to state

Definition at line 1783 of file cfl_generator.cpp.

◆ FindState() [2/2]

StateSet::Iterator faudes::vGenerator::FindState ( Idx index ) const

Returns a iterator to state index in state set

Parameters

index Index to find

Returns: StateSet::Iterator to state index

Definition at line 1788 of file cfl_generator.cpp.

◆ FindTransition() [1/3]

TransSet::Iterator faudes::vGenerator::FindTransition	(	const std::string &	rX1,
		const std::string &	rEv,
		const std::string &	rX2
	)		const

iterator to transition given by x1, ev, x2

Parameters

rX1	name of Predecessor state
rEv	name of Event
rX2	name of Successor state

Returns: iterator to transition or end() if not exists

Definition at line 1104 of file cfl_generator.cpp.

◆ FindTransition() [2/3]

TransSet::Iterator faudes::vGenerator::FindTransition ( const Transition & rTrans ) const

Iterator to transition

Parameters

rTrans transition

Returns: iterator to transition or end() if not exists

Definition at line 1094 of file cfl_generator.cpp.

◆ FindTransition() [3/3]

TransSet::Iterator faudes::vGenerator::FindTransition	(	Idx	x1,
		Idx	ev,
		Idx	x2
	)		const

Iterator to transition given by x1, ev, x2

Parameters

x1	Predecessor state
ev	Event
x2	Successor state

Returns: iterator to transition or End() if not exists

Definition at line 1099 of file cfl_generator.cpp.

◆ GlobalAttribute() [1/2]

void faudes::vGenerator::GlobalAttribute ( const Type & rAttr )

virtual

Set global attribute. The vGenerator does not have attributes, so this function throws an exception for any specified attribute different to AttributeVoid. The TaGenarator provides a re-implementation to actually set the global attribute.

Parameters

rAttr Attribute

Exceptions

Exception

Cannot cast attribute (id 63)

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1843 of file cfl_generator.cpp.

◆ GlobalAttribute() [2/2]

const AttributeVoid & faudes::vGenerator::GlobalAttribute ( void ) const

virtual

Global attribute lookup. In a context where the attribute type is known, you may prefer the TaGenerator method.

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1862 of file cfl_generator.cpp.

◆ GlobalAttributep()

AttributeVoid * faudes::vGenerator::GlobalAttributep ( void )

virtual

Get attribute pointer The global attribute allways exits. For the vGenerator its of type AttributeVoid, the TaGenerator sets a nontrivial type. In a context where the attribute type is known, you may prefer the TaGenerator method.

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1868 of file cfl_generator.cpp.

◆ GlobalAttributeTry()

void faudes::vGenerator::GlobalAttributeTry ( const Type & rAttr )

virtual

Set global attribute. The vGenerator does not have attributes, so this function does nothing. The TaGenarator provides a re-implementation to actually set the global attribute.

Parameters

rAttr Attribute

Definition at line 1855 of file cfl_generator.cpp.

◆ GlobalEventSymbolTablep()

SymbolTable * faudes::vGenerator::GlobalEventSymbolTablep ( void )

static

Get Pointer to global EventSymbolTable. This is a static member of SymbolTable and used as default for all derived generator classes and instantiated objects.

Returns: Pointer to global EventSymbolTable

Definition at line 815 of file cfl_generator.cpp.

◆ GlobalVoid()

const AttributeVoid & faudes::vGenerator::GlobalVoid ( void )

staticprotected

Static default global attribute prototype (configures global attribute type)

Definition at line 57 of file cfl_generator.cpp.

◆ GraphWrite()

void faudes::vGenerator::GraphWrite	(	const std::string &	rFileName,
		const std::string &	rOutFormat = `""`,
		const std::string &	rDotExec = `"dot"`
	)		const

Produce graphical representation of this generator. This method calls the generator's DotWrite function and then processes the output with the dot tool from graphiz package. If no output format is given, try to guess from filename extension. See also ProcessDot().

Parameters

rFileName	Name of output file
rOutFormat	Graphics file format, eg "png", "jpg", "svg"
rDotExec	path/name of executable

Exceptions

Exception

IO errors (id 2)
error during systemcall for dot (id 3)

Definition at line 3904 of file cfl_generator.cpp.

◆ InitState()

Idx faudes::vGenerator::InitState ( void ) const

Return initial state

If the initial state is not unique, this function returns 0.

Returns: Index of initial state

Definition at line 1139 of file cfl_generator.cpp.

◆ InitStates()

const StateSet & faudes::vGenerator::InitStates ( void ) const

Const ref to initial states

Returns: StateSet

Definition at line 1905 of file cfl_generator.cpp.

◆ InitStatesBegin()

StateSet::Iterator faudes::vGenerator::InitStatesBegin ( void ) const

Iterator to Begin() of mInitStates

Returns: Iterator to begin of mInitStates

Definition at line 1147 of file cfl_generator.cpp.

◆ InitStatesEmpty()

bool faudes::vGenerator::InitStatesEmpty ( void ) const

Check if set of initial states are empty

Returns: True if mInitStates is empty

Definition at line 660 of file cfl_generator.cpp.

◆ InitStatesEnd()

StateSet::Iterator faudes::vGenerator::InitStatesEnd ( void ) const

Iterator to End() of mInitStates

Returns: Iterator to end of mInitStates

Definition at line 1152 of file cfl_generator.cpp.

◆ InitStatesSize()

Idx faudes::vGenerator::InitStatesSize ( void ) const

Get number of initial states

Returns: Number of initial states

Definition at line 635 of file cfl_generator.cpp.

◆ InitStatesToString()

std::string faudes::vGenerator::InitStatesToString ( void ) const

Write set of initial states to a string (no re-indexing)

Returns: std::string

Exceptions

Exception

IO errors (id 2)

Definition at line 2798 of file cfl_generator.cpp.

◆ InjectAlphabet()

void faudes::vGenerator::InjectAlphabet ( const EventSet & rNewalphabet )

Set mpAlphabet without consistency check. Sets the alphabet incl attributes, if provided.

Parameters

rNewalphabet EventSet with new alphabet

Definition at line 1167 of file cfl_generator.cpp.

◆ InjectInitStates()

void faudes::vGenerator::InjectInitStates ( const StateSet & rNewInitStates )

Replace mInitStates with StateSet given as parameter without consistency checks.

Parameters

rNewInitStates StateSet containing new mInitStates

Definition at line 1457 of file cfl_generator.cpp.

◆ InjectMarkedStates()

void faudes::vGenerator::InjectMarkedStates ( const StateSet & rNewMarkedStates )

Replace mMarkedStates with StateSet given as parameter without consistency checks.

Parameters

rNewMarkedStates StateSet containing new marked states

Definition at line 1532 of file cfl_generator.cpp.

◆ InjectState()

void faudes::vGenerator::InjectState ( Idx index )

Inject an existing state index into generators mStates Use with care! For use in performance optimized functions.

Parameters

index State index to inject

Definition at line 1269 of file cfl_generator.cpp.

◆ InjectStates()

void faudes::vGenerator::InjectStates ( const StateSet & rNewStates )

Inject a complete state set without consistency checks (without attributes)

Parameters

rNewStates StateSet

Definition at line 1275 of file cfl_generator.cpp.

◆ InjectTransition()

void faudes::vGenerator::InjectTransition ( const Transition & rTrans )

Set transition without consistency check.

Parameters

rTrans Transition to insert

Definition at line 1579 of file cfl_generator.cpp.

◆ InjectTransRel()

void faudes::vGenerator::InjectTransRel ( const TransSet & rNewtransrel )

Set transition relation without consistency check (no attributes)

Parameters

rNewtransrel TransRel to insert

Definition at line 1585 of file cfl_generator.cpp.

◆ InsEvent() [1/2]

Idx faudes::vGenerator::InsEvent ( const std::string & rName )

Add named event to generator. An entry in the mpEventSymbolTable will be made if event name is not known so far.

Parameters

rName Name of the event to add

Returns: New unique index

Definition at line 1201 of file cfl_generator.cpp.

◆ InsEvent() [2/2]

bool faudes::vGenerator::InsEvent ( Idx index )

doxygen group Add an existing event to alphabet by index. It is an error to insert an event index that is not known to the mpEventSymbolTable.

Parameters

index Event index

Returns: True, if event was new to alphabet

Definition at line 1195 of file cfl_generator.cpp.

◆ InsEvents()

void faudes::vGenerator::InsEvents ( const EventSet & events )

Add new named events to generator. If the event allready exists, the attribute is maintained.

Parameters

events EventSet

Definition at line 1207 of file cfl_generator.cpp.

◆ InsInitState() [1/3]

Idx faudes::vGenerator::InsInitState ( const std::string & rName )

Create a new named state and set as initial state

Parameters

rName Name of the state to add

Returns: Index of new unique state

Definition at line 1293 of file cfl_generator.cpp.

◆ InsInitState() [2/3]

bool faudes::vGenerator::InsInitState ( Idx index )

Add (perhaps new) state to generator and turn it into a initial state.

Parameters

index State to insert

Returns: True to indicate that state was new to generator

Definition at line 1302 of file cfl_generator.cpp.

◆ InsInitState() [3/3]

Idx faudes::vGenerator::InsInitState ( void )

Create new anonymous state and set as initial state

Returns: Index of new unique

Definition at line 1284 of file cfl_generator.cpp.

◆ InsInitStates()

void faudes::vGenerator::InsInitStates ( const StateSet & rStates )

Add (perhaps new) anonymous initial states to generator

Parameters

rStates Set of states to add

Definition at line 1309 of file cfl_generator.cpp.

◆ InsMarkedState() [1/3]

Idx faudes::vGenerator::InsMarkedState ( const std::string & rName )

Create a new named state and set as marked state

Parameters

rName Name of the state to add

Returns: Index of new unique state

Definition at line 1331 of file cfl_generator.cpp.

◆ InsMarkedState() [2/3]

bool faudes::vGenerator::InsMarkedState ( Idx index )

Add (perhaps new) state to generator and turn it into a marked state.

Parameters

index State to insert

Returns: True to indicate that state was new to generator

Definition at line 1324 of file cfl_generator.cpp.

◆ InsMarkedState() [3/3]

Idx faudes::vGenerator::InsMarkedState ( void )

Create new anonymous state and set as marked state

Returns: Index of new unique state

Definition at line 1315 of file cfl_generator.cpp.

◆ InsMarkedStates()

void faudes::vGenerator::InsMarkedStates ( const StateSet & rStates )

Add (perhaps new/anonymous) marked states to generator

Parameters

rStates Set of states to add

Definition at line 1340 of file cfl_generator.cpp.

◆ InsState() [1/3]

Idx faudes::vGenerator::InsState ( const std::string & rName )

Add new named state to generator.

Parameters

rName Name of the state to add

Returns: Index of new unique state

Exceptions

Exception Name already exists (id 44)

Definition at line 1256 of file cfl_generator.cpp.

◆ InsState() [2/3]

bool faudes::vGenerator::InsState ( Idx index )

Add (perhaps new) state to generator

Returns: True to indicate that state was new to generator

Definition at line 1250 of file cfl_generator.cpp.

◆ InsState() [3/3]

Idx faudes::vGenerator::InsState ( void )

Add new anonymous state to generator

Returns: Index of new unique state

Definition at line 1244 of file cfl_generator.cpp.

◆ InsStates()

void faudes::vGenerator::InsStates ( const StateSet & rStates )

Add anonymous states to generator

Parameters

rStates Set of states to add

Definition at line 1264 of file cfl_generator.cpp.

◆ IsAccessible()

bool faudes::vGenerator::IsAccessible ( void ) const

Check if generator is accessible

Returns: True if generator is accesssible

Definition at line 2041 of file cfl_generator.cpp.

◆ IsCoaccessible()

bool faudes::vGenerator::IsCoaccessible ( void ) const

Check if generator is Coaccessible

Returns: True if generator is coaccessible

Definition at line 2100 of file cfl_generator.cpp.

◆ IsComplete() [1/3]

bool faudes::vGenerator::IsComplete ( const EventSet & rSigmaO ) const

Check if generator is complete w.r.t. an alphabet

A generator is considered complete w.r.t. an alphabet Sigma_o, if each state can be continued to a state in which a symbol of Sigma_c is enabled.

If the generator is accessible, completeness w.r.t. Sigma_o is equivalent to:

forall s in L(G) there exists t in (Sigma*)Sigma_u such that st in L(G)

Parameters

rSigmaO Specified alphabet Sigma_o

Returns: True if generator is complete

Definition at line 2171 of file cfl_generator.cpp.

◆ IsComplete() [2/3]

bool faudes::vGenerator::IsComplete ( const StateSet & rStates ) const

Check if generator is complete.

Same as IsComplete(void), however, only the specified states are considered. The rational is to e.g. apply the test to accessible (resp. trim) states only. Then, test is equivalent to completeness of the generated (resp. marked) language.

Parameters

rStates Set of state indices to restrict the completeness test

Returns: True if generator is relatively complete

Definition at line 2154 of file cfl_generator.cpp.

◆ IsComplete() [3/3]

bool faudes::vGenerator::IsComplete ( void ) const

Check if generator is complete.

A generator is considered complete, if each state has at least one successor state.

If the generator is accessible, completeness is equivalent to completeness of the generated language, ie forall s in L(G) there exists r>s such that r in L(G)

If the generator is trim, completeness is equivalent to completeness of the markede language, ie forall s in Lm(G) there exists r>s such that r in Lm(G)

Returns: True if generator is complete

Definition at line 2208 of file cfl_generator.cpp.

◆ IsDeterministic()

bool faudes::vGenerator::IsDeterministic ( void ) const

Check if generator is deterministic.

We require the transition relation to be a partial function and at most one initial state.

Note: pre 2.19 libFAUDES also insisted in exactly one initial state.

Returns: True if generator is deterministic

Definition at line 2333 of file cfl_generator.cpp.

◆ IsTrim()

bool faudes::vGenerator::IsTrim ( void ) const

Check if generator is trim.

Returns true if all states are rechable and coreachale.

Returns: True if generator is trim

Definition at line 2135 of file cfl_generator.cpp.

◆ MarkedStates()

const StateSet & faudes::vGenerator::MarkedStates ( void ) const

Return const ref of marked states

Returns: StateSet

Definition at line 1910 of file cfl_generator.cpp.

◆ MarkedStatesBegin()

StateSet::Iterator faudes::vGenerator::MarkedStatesBegin ( void ) const

Iterator to Begin() of mMarkedStates

Returns: iterator to Begin of mMarkedStates

Definition at line 1157 of file cfl_generator.cpp.

◆ MarkedStatesEmpty()

bool faudes::vGenerator::MarkedStatesEmpty ( void ) const

Check if set of marked states are empty

Returns: True if mMarkedStates is empty

Definition at line 665 of file cfl_generator.cpp.

◆ MarkedStatesEnd()

StateSet::Iterator faudes::vGenerator::MarkedStatesEnd ( void ) const

Iterator to End() of mMarkedStates

Returns: iterator to End of mMarkedStates

Definition at line 1162 of file cfl_generator.cpp.

◆ MarkedStatesSize()

Idx faudes::vGenerator::MarkedStatesSize ( void ) const

Get number of marked states

Returns: Number of marked states

Definition at line 640 of file cfl_generator.cpp.

◆ MarkedStatesToString()

std::string faudes::vGenerator::MarkedStatesToString ( void ) const

Write set of marked states to a string (no re-indexing)

Returns: std::string

Exceptions

Exception

IO errors (id 2)

Definition at line 2793 of file cfl_generator.cpp.

◆ MaxStateIndex()

Idx faudes::vGenerator::MaxStateIndex ( void ) const

Get maximum state index used in this generator. Returns 0 if no states at all.

Returns: maximal index

Definition at line 751 of file cfl_generator.cpp.

◆ MinimizeAlphabet()

void faudes::vGenerator::MinimizeAlphabet ( void )

Set the alphabet to used events

Definition at line 1915 of file cfl_generator.cpp.

◆ MinStateIndex() [1/2]

Idx faudes::vGenerator::MinStateIndex ( Idx index ) const

Get state index as is it will be written to file.

Parameters

index state index

Returns: minimal index

Definition at line 740 of file cfl_generator.cpp.

◆ MinStateIndex() [2/2]

void faudes::vGenerator::MinStateIndex ( void )

Re-enumerate states.

This method re-enumerates states such that the resulting state set consist of consecutive indexes; i.e. Size()=MaxStateIndex(). The current implementation sets up the minimal-state-index map used for file i/o and applies it to the state set and the transition relation.

Note: libFAUDES does not maintain consecutive state indices. This was a design decision and it comes pros and cons. The method MinStateIndex() was implemented to provide some limited support for the implementation of algorithms in a consecutive state enumeration paradigm. However, mixing both paradigms most likely involves an overall performace penalty.

Definition at line 757 of file cfl_generator.cpp.

◆ MinStateIndexMap()

const std::map< Idx, Idx > & faudes::vGenerator::MinStateIndexMap ( void ) const

Get state index translation map

Returns: minimal index map

Definition at line 679 of file cfl_generator.cpp.

◆ Move()

void faudes::vGenerator::Move ( vGenerator & rGen )

virtual

Destructive copy to other vGenerator. Copy method with increased performance at the cost of invalidating the source data. If attribute types of source and destination differ, a std copy is invoked.

Parameters

rGen	Destination for copy operation.

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 341 of file cfl_generator.cpp.

◆ New()

vGenerator * faudes::vGenerator::New ( void ) const

virtual

Construct on heap. Technically not a constructor, this function creates a vGenerator with the same event symboltable. It is the callers responsebilty to delete the object when no longer needed. Derived classes must reimplement this function to create an object of the same class and the same event symboltable.

Returns: New vGenerator

Reimplemented from faudes::Type.

Definition at line 176 of file cfl_generator.cpp.

◆ NewCore()

void faudes::vGenerator::NewCore ( void )

protectedvirtual

Allocate my heap members (attribute dependent types)

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 231 of file cfl_generator.cpp.

◆ NewEventSet()

EventSet faudes::vGenerator::NewEventSet ( void ) const

Create EventSet with generator's EventSymbolTable (on stack).

Returns: New empty EventSet on stack

Definition at line 915 of file cfl_generator.cpp.

◆ NewEventSetp()

EventSet * faudes::vGenerator::NewEventSetp ( void ) const

Create EventSet with generator's EventSymbolTable (on heap).

Returns: Pointer to new empty EventSet on heap

Definition at line 922 of file cfl_generator.cpp.

◆ operator<()

bool faudes::vGenerator::operator< ( const vGenerator & rOtherGen ) const

inline

Order for sorting containers of generators

Definition at line 2882 of file cfl_generator.h.

◆ operator=()

vGenerator & faudes::vGenerator::operator= ( const vGenerator & rOtherGen )

Assignment operator (uses Assign method)

Note: you must reimplement this operator in derived classes in order to handle internal pointers correctly.

Parameters

rOtherGen Other generator

Definition at line 401 of file cfl_generator.cpp.

◆ ReadAlphabet()

void faudes::vGenerator::ReadAlphabet ( TokenReader & rTr )

protected

Read the generator's alphabet from a TokenReader. As of 2.24e, this method returns silently if no alphabet-tag is found.

Parameters

rTr	Reference to TokenReader

Exceptions

Exception

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

Definition at line 3220 of file cfl_generator.cpp.

◆ ReadStates()

void faudes::vGenerator::ReadStates ( TokenReader & rTr )

protected

Read the generator's stateset from a TokenReader. This sets up the StateSymbolTable. As of 2.24e, this method returns silently if no alphabet-tag is found.

Parameters

rTr	Reference to TokenReader

Exceptions

Exception

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

Definition at line 3233 of file cfl_generator.cpp.

◆ ReadStateSet()

void faudes::vGenerator::ReadStateSet	(	TokenReader &	rTr,
		const std::string &	rLabel,
		StateSet &	rStateSet
	)		const

Read a state set. Refer to the generators state symboltable while reading a state set. Ignore any attributes.

Parameters

rTr	Reference to TokenReader
rLabel	Label of set in source
rStateSet	Destination state set

Exceptions

Exception

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

Definition at line 3362 of file cfl_generator.cpp.

◆ ReadTransRel() [1/2]

void faudes::vGenerator::ReadTransRel ( const std::string & rFileName )

protected

Read the generator's transition relation from a file.

Parameters

rFileName File to read from

Exceptions

Exception

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

◆ ReadTransRel() [2/2]

void faudes::vGenerator::ReadTransRel ( TokenReader & rTr )

protected

Read the generator's transition relation from a TokenReader.

Parameters

rTr	Reference to TokenReader

Exceptions

Exception

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

Definition at line 3676 of file cfl_generator.cpp.

◆ ReindexOnWrite() [1/2]

void faudes::vGenerator::ReindexOnWrite ( bool flag )

Enable/disable minimal state indicees for file-i/o.

Parameters

flag	True enables reindexing.

Definition at line 2362 of file cfl_generator.cpp.

◆ ReindexOnWrite() [2/2]

bool faudes::vGenerator::ReindexOnWrite ( void ) const

Test whether file-i/o uses minimal state indicees.

Returns: True when minimal state indicees are enabled

Definition at line 2357 of file cfl_generator.cpp.

◆ ReindexOnWriteDefault() [1/2]

void faudes::vGenerator::ReindexOnWriteDefault ( bool flag )

static

Enable/disable reindexing states for file-i/o.

Set default value for re-indexing. Initially, the default is set to "false".

Parameters

flag	True enables reindexing.

Definition at line 2367 of file cfl_generator.cpp.

◆ ReindexOnWriteDefault() [2/2]

bool faudes::vGenerator::ReindexOnWriteDefault ( void )

static

Enable/disable reindexing states for file-i/o.

Set default value for re-indexing.

Returns: True for reindexing enabled.

Definition at line 2372 of file cfl_generator.cpp.

◆ RestrictAlphabet()

void faudes::vGenerator::RestrictAlphabet ( const EventSet & rNewalphabet )

virtual

Restricts mpAlphabet incl removing resp. transition. Maintains attributes if any.

Note: before libFAUDES 2.23, this method did not remove transitions. Use InjectAlphabet(const EventSet&) for direct write acces to the alphabet.

Parameters

rNewalphabet EventSet with alphabet

Definition at line 1181 of file cfl_generator.cpp.

◆ RestrictStates()

void faudes::vGenerator::RestrictStates ( const StateSet & rStates )

virtual

Restrict states Cleans mpStates, mInitStates, mMarkedStates, mpTransrel, and mpStateSymboltable

Parameters

rStates StateSet containing valid states

Reimplemented in faudes::TrGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 1409 of file cfl_generator.cpp.

◆ SetDefaultStateNames()

void faudes::vGenerator::SetDefaultStateNames ( void )

Assign each state a default name based on its index.

Definition at line 1012 of file cfl_generator.cpp.

◆ SetInitState() [1/2]

void faudes::vGenerator::SetInitState ( const std::string & rName )

Set an existing state as initial state by name.

Parameters

rName Name of state to set as initial state

Exceptions

Exception

State name not known in generator (id 90)

Definition at line 1443 of file cfl_generator.cpp.

◆ SetInitState() [2/2]

void faudes::vGenerator::SetInitState ( Idx index )

Set an existing state as initial state by index.

Parameters

index Index of state to set as initial state

Exceptions

Exception

State index not found in generator (id 91)

Definition at line 1429 of file cfl_generator.cpp.

◆ SetMarkedState() [1/2]

void faudes::vGenerator::SetMarkedState ( const std::string & rName )

Set an existing state as marked state by name.

Parameters

rName Name of state to set as marked state

Exceptions

Exception

State name not known in generator (id 90)

Definition at line 1518 of file cfl_generator.cpp.

◆ SetMarkedState() [2/2]

void faudes::vGenerator::SetMarkedState ( Idx index )

Set an existing state as marked state by index

Parameters

index Index of state to set as initial state

Exceptions

Exception

State index not found in generator (id 91)

Definition at line 1504 of file cfl_generator.cpp.

◆ SetMinStateIndexMap()

void faudes::vGenerator::SetMinStateIndexMap ( void ) const

Set minimal index map for file io of generator states

This function is implemented as fake-const to allow for const Write function.

Definition at line 685 of file cfl_generator.cpp.

◆ SetTransition() [1/3]

bool faudes::vGenerator::SetTransition	(	const std::string &	rX1,
		const std::string &	rEv,
		const std::string &	rX2
	)

Add a transition to generator by names. Statename and eventname must already exist.

Parameters

rX1	Predecessor state name
rEv	Event name
rX2	Successor state name

Returns: True, if the transition was new the generator

Exceptions

Exception

state or event not in generator (id 95)
state name not known (id 90)
event name not known (id 66)

Definition at line 1592 of file cfl_generator.cpp.

◆ SetTransition() [2/3]

bool faudes::vGenerator::SetTransition ( const Transition & rTransition )

Add a transition to generator. States and event must already exist.

Parameters

rTransition Transition

Returns: True, if the transition was new the generator

Exceptions

Exception

state or event not in generator (id 95)

Definition at line 1628 of file cfl_generator.cpp.

◆ SetTransition() [3/3]

bool faudes::vGenerator::SetTransition	(	Idx	x1,
		Idx	ev,
		Idx	x2
	)

Add a transition to generator by indices. States and event must already exist.

Parameters

x1	Predecessor state index
ev	Event index
x2	Successor state index

Returns: True, if the transition was new the generator

Exceptions

Exception

state or event not in generator (id 95)

Definition at line 1623 of file cfl_generator.cpp.

◆ Size()

Idx faudes::vGenerator::Size ( void ) const

Get generator size (number of states)

Returns: Number of states

Definition at line 574 of file cfl_generator.cpp.

◆ SStr()

std::string faudes::vGenerator::SStr ( Idx index ) const

Return pretty printable state name for index (eg for debugging)

Parameters

index State index

Returns: std::string

Definition at line 3891 of file cfl_generator.cpp.

◆ StateAttribute() [1/2]

const AttributeVoid & faudes::vGenerator::StateAttribute ( Idx index ) const

virtual

State attribute lookup. In a context where the attribute type is known, you may prefer the TaGenerator method.

Parameters

index State index

Returns: Ref to attribute of state

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1833 of file cfl_generator.cpp.

◆ StateAttribute() [2/2]

void faudes::vGenerator::StateAttribute	(	Idx	index,
		const Type &	rAttr
	)

virtual

Set attribute for existing state. This version uses a dynamic cast to test the actual type of the provided attribute. An exception is thrown for an invalid attribute type. In a context where the attribute type is known, you may prefer the TaGenerator method.

Parameters

index	State index
rAttr	New attribute

Exceptions

Exception

Index not found in Stateset (id 60)
Cannot cast attribute (id 63)

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1740 of file cfl_generator.cpp.

◆ StateAttributep()

AttributeVoid * faudes::vGenerator::StateAttributep ( Idx index )

virtual

State attribute pointer to access Attribute methods. If there are no attributes (plain vGenerator) this method returns 0. If there are attributes, an explicit default value may be inserted. In a context where the attribute type is known, you may prefer the TaGenerator method.

Parameters

index State index

Returns: Pointer to attribute of state

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1838 of file cfl_generator.cpp.

◆ StateIndex()

Idx faudes::vGenerator::StateIndex ( const std::string & rName ) const

State index lookup.

Parameters

rName

Returns: Valid index (or 0 for non-existent)

Definition at line 941 of file cfl_generator.cpp.

◆ StateName() [1/2]

std::string faudes::vGenerator::StateName ( Idx index ) const

State name lookup

Parameters

index

Returns: name (or empty string if no such exists)

Definition at line 946 of file cfl_generator.cpp.

◆ StateName() [2/2]

void faudes::vGenerator::StateName	(	Idx	index,
		const std::string &	rName
	)

Set name of state

Parameters

index	Index
rName	Name

Exceptions

Exception

name already associated with another index (id 44)
state does not exist in generator (id 90)

Definition at line 951 of file cfl_generator.cpp.

◆ StateNamesEnabled() [1/2]

void faudes::vGenerator::StateNamesEnabled ( bool flag )

Enable/disable libFAUEDS functions to automatically generate state names. Disabling state name generation implies ClearStateNames().

Parameters

flag	True enables statenames / false disables them

Definition at line 1001 of file cfl_generator.cpp.

◆ StateNamesEnabled() [2/2]

bool faudes::vGenerator::StateNamesEnabled ( void ) const

Whether libFAUEDS functions are requested to generate state names. Most libFAUDES functions that introduce new states to a generator can be enabled to also assign (more or less sensible) names to those states. This feature is purely cosmetic and may be disabled for performance reasons.

Returns: True, if generation of statenames is enabled.

Definition at line 996 of file cfl_generator.cpp.

◆ StateNamesEnabledDefault()

void faudes::vGenerator::StateNamesEnabledDefault ( bool flag )

static

Sets the default for automatic state name generation. This flag takes effect only on generators newly created by the default constructor. The copy constructor copies the state name flag from the source generator. See also StateNamesEnabled(bool).

Parameters

flag	True enables statenames / false disables them

Definition at line 1007 of file cfl_generator.cpp.

◆ States()

const StateSet & faudes::vGenerator::States ( void ) const

Return reference to state set

Returns: StateSet reference incl actual attribute type

Definition at line 1880 of file cfl_generator.cpp.

◆ StatesBegin()

StateSet::Iterator faudes::vGenerator::StatesBegin ( void ) const

Iterator to Begin() of state set

Returns: Iterator to begin of state set

Definition at line 1054 of file cfl_generator.cpp.

◆ StatesEnd()

StateSet::Iterator faudes::vGenerator::StatesEnd ( void ) const

Iterator to End() of state set

Returns: Iterator to end of state set

Definition at line 1059 of file cfl_generator.cpp.

◆ StateSetToString()

std::string faudes::vGenerator::StateSetToString ( const StateSet & rStateSet ) const

Write a stateset to string (no re-indexing). Uses WriteStateSet(TokenWriter& rTw, const StateSet&) const to write the specified state set to a string referring to this generators state names.

Parameters

rStateSet Reference to stateset

Returns: std::string

Exceptions

Exception

IO errors (id 2)

Definition at line 2507 of file cfl_generator.cpp.

◆ StateSetToText()

std::string faudes::vGenerator::StateSetToText ( const StateSet & rStateSet ) const

Write a stateset to formated text (no re-indexing). Uses WriteStateSet(TokenWriter& rTw, const StateSet&) const to write the specified state set to a string referring to this generators state names.

Parameters

rStateSet Reference to stateset

Returns: std::string

Exceptions

Exception

IO errors (id 2)

Definition at line 2514 of file cfl_generator.cpp.

◆ StatesToString()

std::string faudes::vGenerator::StatesToString ( void ) const

Write stateset of this generator to a string (no re-indexing)

Returns: std::string

Exceptions

Exception

IO errors (id 2)

Definition at line 2783 of file cfl_generator.cpp.

◆ StatesToText()

std::string faudes::vGenerator::StatesToText ( void ) const

Write stateset of this generator to formated text (no re-indexing)

Returns: std::string

Exceptions

Exception

IO errors (id 2)

Definition at line 2788 of file cfl_generator.cpp.

◆ StatesVoid()

const StateSet & faudes::vGenerator::StatesVoid ( void )

staticprotected

Static default state set prototype (incl. attribute type)

Definition at line 49 of file cfl_generator.cpp.

◆ StateSymbolTable() [1/2]

void faudes::vGenerator::StateSymbolTable ( const SymbolTable & rSymTab )

Set StateSymbolTable.

By convention, state names and indices are local to the respective generator. It is most unlikely that you want to use this function.

Definition at line 935 of file cfl_generator.cpp.

◆ StateSymbolTable() [2/2]

const SymbolTable & faudes::vGenerator::StateSymbolTable ( void ) const

doxygen group Get StateSymbolTable.

Returns: ref to state-symboltable

Definition at line 930 of file cfl_generator.cpp.

◆ SuccessorState()

Idx faudes::vGenerator::SuccessorState	(	Idx	x1,
		Idx	ev
	)		const

Return the successor state of state x1 with event ev. If no such transition exists, return 0. If multiple such transitions exit, through expection.

A more egeneral set valued interface is provided by TransSet

Returns: next state

Exceptions

Exception

Successor state does not exist uniquely (id 92)

Definition at line 1977 of file cfl_generator.cpp.

◆ SuccessorStates() [1/2]

StateSet faudes::vGenerator::SuccessorStates ( Idx x1 ) const

Return the successor states of state x1

Returns: StateSet

Definition at line 1966 of file cfl_generator.cpp.

◆ SuccessorStates() [2/2]

StateSet faudes::vGenerator::SuccessorStates	(	Idx	x1,
		Idx	ev
	)		const

Return the successor states of state x1 with event ev

Returns: StateSet

Definition at line 1971 of file cfl_generator.cpp.

◆ TerminalStates() [1/2]

StateSet faudes::vGenerator::TerminalStates ( const StateSet & rStates ) const

Compute set of terminal states.

A terminal state is a state with no successor state. This function returns the the set terminal states contained in the specified state ste.

Parameters

rStates Set of state indices to restrict the search

Returns: Set of terminal states.

Definition at line 2305 of file cfl_generator.cpp.

◆ TerminalStates() [2/2]

StateSet faudes::vGenerator::TerminalStates ( void ) const

Compute set of terminal states.

A terminal state is a state with no successor state. If and only if the set of terminal states is empty, the generator is complete.

Returns: Set of terminal states.

Definition at line 2325 of file cfl_generator.cpp.

◆ TransAttribute() [1/2]

const AttributeVoid & faudes::vGenerator::TransAttribute ( const Transition & rTrans ) const

virtual

Transition attribute lookup. In a context where the attribute type is known, you may prefer the TaGenerator method.

Returns: Attribute

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1703 of file cfl_generator.cpp.

◆ TransAttribute() [2/2]

void faudes::vGenerator::TransAttribute	(	const Transition &	rTrans,
		const Type &	rAttr
	)

virtual

Set attribute for existing transition. This version uses a dynamic cast to test the actual type of the provided attribute. An exception is thrown for an invalid attribute type. In a context where the attribute type is known, you may prefer the TaGenerator method.

Parameters

rTrans	Transition
rAttr	New attribute

Exceptions

Exception

Transition not found in transition relation(id 60)
Cannot cast attribute (id 63)

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1690 of file cfl_generator.cpp.

◆ TransAttributep()

AttributeVoid * faudes::vGenerator::TransAttributep ( const Transition & rTrans )

virtual

Transition attribute pointer to access Attribute methods. If there are no attributes (plain vGenerator) this method returns 0. If there are attributes, an explicit default value may be inserted. In a context where the attribute type is known, you may prefer the TaGenerator method.

Returns: Attribute pointer

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 1697 of file cfl_generator.cpp.

◆ TransitionByNames()

Transition faudes::vGenerator::TransitionByNames	(	const std::string &	rX1,
		const std::string &	rEv,
		const std::string &	rX2
	)		const

Convebience function.

Parameters

rX1	Name of Predecessor state
rEv	Name of Event
rX2	Name of Successor state

Returns: Transition as specified.

Definition at line 1899 of file cfl_generator.cpp.

◆ TransRel() [1/7]

void faudes::vGenerator::TransRel ( TransSetEvX1X2 & res ) const

Definition at line 1892 of file cfl_generator.cpp.

◆ TransRel() [2/7]

void faudes::vGenerator::TransRel ( TransSetEvX2X1 & res ) const

◆ TransRel() [3/7]

void faudes::vGenerator::TransRel ( TransSetX1EvX2 & res ) const

Get copy of trantision relation sorted by other compare operator, e.g. "x2,ev,x1"

Parameters

res	resulting transition relation

Definition at line 1891 of file cfl_generator.cpp.

◆ TransRel() [4/7]

void faudes::vGenerator::TransRel ( TransSetX1X2Ev & res ) const

◆ TransRel() [5/7]

void faudes::vGenerator::TransRel ( TransSetX2EvX1 & res ) const

Definition at line 1894 of file cfl_generator.cpp.

◆ TransRel() [6/7]

void faudes::vGenerator::TransRel ( TransSetX2X1Ev & res ) const

◆ TransRel() [7/7]

const TransSet & faudes::vGenerator::TransRel ( void ) const

Return reference to transition relation

Returns: TransRel

Definition at line 1885 of file cfl_generator.cpp.

◆ TransRelBegin() [1/3]

TransSet::Iterator faudes::vGenerator::TransRelBegin ( Idx x1 ) const

Iterator to begin of transitions with x1 as predecessor state.

Parameters

x1	Predecessor state

Returns: iterator to begin of transitions with x1

Definition at line 1074 of file cfl_generator.cpp.

◆ TransRelBegin() [2/3]

TransSet::Iterator faudes::vGenerator::TransRelBegin	(	Idx	x1,
		Idx	ev
	)		const

iterator to begin of transitions with x1 as predecessor state and event ev.

Parameters

x1	Predecessor state
ev	Event

Returns: iterator to begin of transitions with x1 and ev

Definition at line 1084 of file cfl_generator.cpp.

◆ TransRelBegin() [3/3]

TransSet::Iterator faudes::vGenerator::TransRelBegin ( void ) const

Iterator to Begin() of transition relation

Returns: Iterator to Begin of mpTransRel

Definition at line 1064 of file cfl_generator.cpp.

◆ TransRelEmpty()

bool faudes::vGenerator::TransRelEmpty ( void ) const

Check if transition relation is empty

Returns: True if transition relation is empty

Definition at line 655 of file cfl_generator.cpp.

◆ TransRelEnd() [1/3]

TransSet::Iterator faudes::vGenerator::TransRelEnd ( Idx x1 ) const

iterator to end of transitions with x1 as predecessor state.

Note: Set the End(x1) iterator to a variable, so it won't be recalculated every iteration.

Parameters

x1	Predecessor state

Returns: iterator to end of transitions with x1 (one after last matching transition)

Definition at line 1079 of file cfl_generator.cpp.

◆ TransRelEnd() [2/3]

TransSet::Iterator faudes::vGenerator::TransRelEnd	(	Idx	x1,
		Idx	ev
	)		const

Iterator to end of transitions with x1 as predecessor state and event ev.

Note: Set the End(x1,ev) iterator to a variable, so it won't be recalculated every iteration.

Parameters

x1	Predecessor state
ev	Event

Returns: iterator to end of transitions with x1 and ev (one after last matching transition)

Definition at line 1089 of file cfl_generator.cpp.

◆ TransRelEnd() [3/3]

TransSet::Iterator faudes::vGenerator::TransRelEnd ( void ) const

Iterator to End() of transition relation

Returns: Iterator to End of mpTransRel

Definition at line 1069 of file cfl_generator.cpp.

◆ TransRelSize()

Idx faudes::vGenerator::TransRelSize ( void ) const

Get number of transitions

Returns: Number of transitions

Definition at line 630 of file cfl_generator.cpp.

◆ TransRelStates()

StateSet faudes::vGenerator::TransRelStates ( void ) const

Return the states covered by transitions

Returns: StateSet

Definition at line 1955 of file cfl_generator.cpp.

◆ TransRelToString()

std::string faudes::vGenerator::TransRelToString ( void ) const

Write transition relation to string (no re-indexing)

Definition at line 2810 of file cfl_generator.cpp.

◆ TransRelToText()

std::string faudes::vGenerator::TransRelToText ( void ) const

Write transition relation to formated text (no re-indexing)

Definition at line 2817 of file cfl_generator.cpp.

◆ TransRelVoid()

const TransSet & faudes::vGenerator::TransRelVoid ( void )

staticprotected

Static default transition relation prototype (incl. attribute type)

Definition at line 53 of file cfl_generator.cpp.

◆ Trim()

bool faudes::vGenerator::Trim ( void )

Make generator trim

This function removes all states are not accessible or not coaccessible. In other words: only those states are kept, that contribute to that marked language.

Returns: True if resulting generator contains at least one initial state and at least one marked state.

Definition at line 2119 of file cfl_generator.cpp.

◆ TrimSet()

StateSet faudes::vGenerator::TrimSet ( void ) const

Compute set of trim states

Definition at line 2110 of file cfl_generator.cpp.

◆ TStr()

std::string faudes::vGenerator::TStr ( const Transition & rTrans ) const

Return pretty printable transition (eg for debugging)

Parameters

rTrans Transition

Returns: std::string

Definition at line 3898 of file cfl_generator.cpp.

◆ UniqueEventName()

std::string faudes::vGenerator::UniqueEventName ( const std::string & rName ) const

Create a new unique symbolic event name. See also SymbolTable::UniqueSymbol().

Parameters

rName suggestion for new state name

Definition at line 856 of file cfl_generator.cpp.

◆ UniqueStateName()

std::string faudes::vGenerator::UniqueStateName ( const std::string & rName ) const

Create a new unique symbolic state name. See also SymbolTable::UniqueSymbol().

Parameters

rName suggestion for new state name

Definition at line 1036 of file cfl_generator.cpp.

◆ UnusedEvents()

EventSet faudes::vGenerator::UnusedEvents ( void ) const

Return unused events

Returns: EventSet

Definition at line 1930 of file cfl_generator.cpp.

◆ UpdateAttributes()

virtual bool faudes::vGenerator::UpdateAttributes ( void )

inlinevirtual

Updates internal attributes. This method does nothing and may be reimplemented by a any class that adds semantics to attributes Eg. you may set a particular state flag, if this state is reachable.

Returns: True if value changed

Reimplemented in faudes::TtGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::TioGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::TlhaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::THioPlant< AttributeVoid, HioStateFlags, HioEventFlags, AttributeVoid >, faudes::THioEnvironment< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::THioEnvironment< AttributeVoid, HioStateFlags, HioEventFlags, AttributeVoid >, faudes::THioController< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::THioController< AttributeVoid, HioStateFlags, HioEventFlags, AttributeVoid >, faudes::THioConstraint< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::THioConstraint< AttributeVoid, HioStateFlags, HioEventFlags, AttributeVoid >.

Definition at line 1881 of file cfl_generator.h.

◆ UpdateCore()

void faudes::vGenerator::UpdateCore ( void )

protectedvirtual

Callback for core update

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, and faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >.

Definition at line 221 of file cfl_generator.cpp.

◆ UsedEvents()

EventSet faudes::vGenerator::UsedEvents ( void ) const

doxygen group Return used events (executed in transitions)

Returns: EventSet

Definition at line 1920 of file cfl_generator.cpp.

◆ Valid()

bool faudes::vGenerator::Valid ( void ) const

virtual

doxygen group Check if generator is valid. Performs internal consistency tests, This method is intendend to test generators that have been manipulated by methods without consistency tests, eg InjectAlphabet.

Returns: True for success

Reimplemented in faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::TaGenerator< AttributeVoid, StateRef, AttributeVoid, AttributeVoid >, faudes::TtGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >, faudes::Executor, and faudes::TlhaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 534 of file cfl_generator.cpp.

◆ Version() [1/3]

void faudes::vGenerator::Version	(	const std::string &	rPattern,
		const std::string &	rReplacement,
		vGenerator &	rResGen
	)		const

virtual

Create another version of this generator. Assembles a copy of this generator, however, with versioned events. The new event names are created by replacing all substrings matching a specified string pattern by a replacement string. State names and indices as well as any attributes are maintained.

Parameters

rPattern	String value to be replaced in event names
rReplacement	String value to be inserted in event names in place of rPattern
rResGen	Resulting versioned generator

Exceptions

Exception

Source must not match destination (id 96)

Definition at line 460 of file cfl_generator.cpp.

◆ Version() [2/3]

void faudes::vGenerator::Version	(	const std::string &	rVersion,
		vGenerator &	rResGen
	)		const

virtual

Create another version of this generator. Assembles a copy of this generator, however, with versioned events. The new event names are created by appending an underscore and a specified string. State names and indices as well as any attributes are maintained.

Parameters

rVersion	String value to be appended to event names
rResGen	Resulting versioned generator

Exceptions

Exception

Source must not match destination (id 96)

Definition at line 416 of file cfl_generator.cpp.

◆ Version() [3/3]

void faudes::vGenerator::Version	(	Idx	version,
		vGenerator &	rResGen
	)		const

virtual

Create another version of this generator. Assembles a copy of this generator, however, with versioned events. The new event names are created by appending an underscore and a numeric index. State names and indices as well as any attributes are maintained.

Parameters

version	Numeric value to be appended to event names
rResGen	Resulting versioned generator

Exceptions

Exception

Source must not match destination (id 96)

Definition at line 408 of file cfl_generator.cpp.

◆ WriteAlphabet() [1/2]

void faudes::vGenerator::WriteAlphabet ( TokenWriter & rTw ) const

Write generators alphabet to tokenwriter

Parameters

rTw	Reference to TokenWriter

Exceptions

Exception

IO errors (id 2)

Definition at line 2496 of file cfl_generator.cpp.

◆ WriteAlphabet() [2/2]

void faudes::vGenerator::WriteAlphabet ( void ) const

doxygen group Write generators alphabet to console

Definition at line 2483 of file cfl_generator.cpp.

◆ WriteStates()

void faudes::vGenerator::WriteStates ( TokenWriter & rTw ) const

protected

Write generators stateset to TokenWriter.

This method differs from the general purpos version WriteStateSet(TokenWriter&, const StateSet&) in that it can optionally write an explicit symbol table for state names. This will happen whenever writing is done without re-indexing states.

Parameters

rTw	Reference to TokenWriter

Exceptions

Exception

IO errors (id 2)

Definition at line 2523 of file cfl_generator.cpp.

◆ WriteStateSet() [1/2]

void faudes::vGenerator::WriteStateSet ( const StateSet & rStateSet ) const

Write a stateset to console (no re-indexing). Uses WriteStateSet(TokenWriter& rTw, const StateSet&) const to write the specified state set to console referring to this generators state names.

Parameters

rStateSet Reference to stateset

Definition at line 2501 of file cfl_generator.cpp.

◆ WriteStateSet() [2/2]

void faudes::vGenerator::WriteStateSet	(	TokenWriter &	rTw,
		const StateSet &	rStateSet,
		const std::string &	rLabel = `""`
	)		const

Write a stateset to TokenWriter. All native output of external state sets done with this function. Technically, a StateSet is a set of plain indices with no references to symbolic names. Thus, it is only the context of a Generator that provides the symbolic names for file output.

Output of state sets always uses the mMinStateIndexMap to re-index states. However, this map is only set up automatically for file output. If You require re-indexed output to e.g. a string, you must set up the map by calling SetMinStateIndexMap(). To ensure that no re-indexing takes place, call ClearMinStateIndexMap().

Parameters

rTw	Reference to TokenWriter
rStateSet	Reference to stateset
rLabel	Optional outer tag, defaults to name of the set

Exceptions

Exception

IO errors (id 2)

Definition at line 2616 of file cfl_generator.cpp.

◆ WriteTransRel() [1/2]

void faudes::vGenerator::WriteTransRel ( TokenWriter & rTw ) const

Write transition relation to tokenwriter. Re-indexing and symbolic state names are handled in the same way as with state sets: this function refers to the generators state symboltable to obtain state names and uses the mMinStateIndexMap to re-index the output.

Parameters

rTw	Reference to TokenWriter

Exceptions

Exception

IO errors (id 2)

Definition at line 2825 of file cfl_generator.cpp.

◆ WriteTransRel() [2/2]

void faudes::vGenerator::WriteTransRel ( void ) const

Write transition relation to console (no re-indexing)

Definition at line 2804 of file cfl_generator.cpp.

◆ XDotWrite()

void faudes::vGenerator::XDotWrite ( const std::string & rFileName ) const

virtual

Writes generator to dot input format for export to VioLib. Variant of DotWrite() using strategic state and event names to simplify import to VioLib (qt widget for graphical representation of FAUDES generators).

Parameters

rFileName File to write

Exceptions

Exception

IO errors (id 2)

Definition at line 3081 of file cfl_generator.cpp.

◆ XReadStateSet()

void faudes::vGenerator::XReadStateSet	(	TokenReader &	rTr,
		StateSet &	rStateSet,
		const std::string &	rLabel = `""`
	)		const

protected

Read a stateset from TokenReader in XML format.

This version for file IO supports the XML format introduced with libFAUDES 2.20. Note that for Generators and derived classes, the native libFAUDES token format is considered the default. To read XML fromated data, use the XRead() interface.

Parameters

rTr	Reference to TokenReader
rStateSet	Reference to stateset
rLabel	Section name, defaults to name of set

Exceptions

Exception

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

Definition at line 3543 of file cfl_generator.cpp.

◆ XReadTransRel()

void faudes::vGenerator::XReadTransRel ( TokenReader & rTr )

protected

Read the generator's transition relation from a TokenReader.

Parameters

rTr	Reference to TokenReader

Exceptions

Exception

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

Definition at line 3789 of file cfl_generator.cpp.

◆ XWriteStateSet()

void faudes::vGenerator::XWriteStateSet	(	TokenWriter &	rTw,
		const StateSet &	rStateSet,
		const std::string &	rLabel = `""`
	)		const

Write a stateset to TokenWriter in XML format.

This version for file IO supports the XML format introduced with libFAUDES 2.20. Note that for Generators and derived classes, the native libFAUDES token format is considered the default. To obtain XML fromated output of a Generator, use the XWrite() interface.

Parameters

rTw	Reference to TokenWriter
rStateSet	Reference to stateset
rLabel	Section name, defaults to name of set

Exceptions

Exception

IO errors (id 2)

Definition at line 2718 of file cfl_generator.cpp.

◆ XWriteTransRel()

void faudes::vGenerator::XWriteTransRel ( TokenWriter & rTw ) const

protected

Write transition relation to tokenwriter in XML format.

This version for file IO supports the XML format introduced with libFAUDES 2.20. Note that for Generators and derived classes, the native libFAUDES token format is considered the default. To obtain XML fromated output of a Generator, use the XWrite() interface.

Parameters

rTw	Reference to TokenWriter

Exceptions

Exception

IO errors (id 2)

Definition at line 2915 of file cfl_generator.cpp.

Member Data Documentation

◆ mId

Idx faudes::vGenerator::mId

protected

Number of generator

Definition at line 2893 of file cfl_generator.h.

◆ mInitStates

StateSet faudes::vGenerator::mInitStates

protected

Initial states

Definition at line 2956 of file cfl_generator.h.

◆ mMarkedStates

StateSet faudes::vGenerator::mMarkedStates

protected

Marked states

Definition at line 2959 of file cfl_generator.h.

◆ mMinStateIndexMap

std::map<Idx,Idx> faudes::vGenerator::mMinStateIndexMap

protected

Map State indices to consecutive indices

Definition at line 2962 of file cfl_generator.h.

◆ mpAlphabet

EventSet* faudes::vGenerator::mpAlphabet

protected

Pointer to alphabet (actual type depends on attributes)

Definition at line 2920 of file cfl_generator.h.

◆ mpEventSymbolTable

SymbolTable* faudes::vGenerator::mpEventSymbolTable

protected

Pointer to Event symbol table

Definition at line 2905 of file cfl_generator.h.

◆ mpGlobalAttribute

AttributeVoid* faudes::vGenerator::mpGlobalAttribute

protected

Pointer to lobal attribute (actual type depends on attributes)

Definition at line 2929 of file cfl_generator.h.

◆ mpStates

StateSet* faudes::vGenerator::mpStates

protected

Pointer to state set (actual type depends on attributes)

Definition at line 2923 of file cfl_generator.h.

◆ mpStateSymbolTable

SymbolTable* faudes::vGenerator::mpStateSymbolTable

protected

Pointer to State symbol table

Definition at line 2902 of file cfl_generator.h.

◆ mpTransRel

TransSet* faudes::vGenerator::mpTransRel

protected

Pointer to ransition relation (actual type depends on attributes)

Definition at line 2926 of file cfl_generator.h.

◆ mReindexOnWrite

bool faudes::vGenerator::mReindexOnWrite

protected

Reindex states on file-i/o

Definition at line 2914 of file cfl_generator.h.

◆ msObjectCount

Idx faudes::vGenerator::msObjectCount = 0

staticprotected

Number of generator objects

Definition at line 2896 of file cfl_generator.h.

◆ msReindexOnWriteDefault

bool faudes::vGenerator::msReindexOnWriteDefault = false

staticprotected

Default for automatic statenames

Definition at line 2917 of file cfl_generator.h.

◆ msStateNamesEnabledDefault

bool faudes::vGenerator::msStateNamesEnabledDefault = true

staticprotected

Default for automatic statenames

Definition at line 2911 of file cfl_generator.h.

◆ mStateNamesEnabled

bool faudes::vGenerator::mStateNamesEnabled

protected

Automatic state names

Definition at line 2908 of file cfl_generator.h.

◆ mStateSymbolTable

SymbolTable faudes::vGenerator::mStateSymbolTable

protected

State symbol table (local per Generator)

Definition at line 2899 of file cfl_generator.h.

◆ pAlphabetPrototype

const EventSet* faudes::vGenerator::pAlphabetPrototype

protected

Pointer to alphabet prototype (incl. attribute type)

Definition at line 2932 of file cfl_generator.h.

◆ pGlobalPrototype

const AttributeVoid* faudes::vGenerator::pGlobalPrototype

protected

Pointer to global attribute prototype (configures global attribute type)

Definition at line 2941 of file cfl_generator.h.

◆ pStatesPrototype

const StateSet* faudes::vGenerator::pStatesPrototype

protected

Pointer to state set prototype (incl. attribute type)

Definition at line 2935 of file cfl_generator.h.

◆ pTransRelPrototype

const TransSet* faudes::vGenerator::pTransRelPrototype

protected

Pointer to transition relation prototype (incl. attribute type)

Definition at line 2938 of file cfl_generator.h.

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

Detailed Description

Overview

Events Versus States

File I/O (default format)

File I/O (XML file-format)

Attributes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

File IO

Constructor & Destructor Documentation

◆ vGenerator() [1/3]

◆ vGenerator() [2/3]

◆ vGenerator() [3/3]

◆ ~vGenerator()

Member Function Documentation

◆ Accessible()

◆ AccessibleSet()

◆ ActiveEventSet()

◆ ActiveTransSet()

◆ Alphabet()

◆ AlphabetBegin()

◆ AlphabetEmpty()

◆ AlphabetEnd()

◆ AlphabetSize()

◆ AlphabetToString()

◆ AlphabetVoid()

◆ Assign()

◆ AssignWithoutAttributes()

◆ BlockingStates()

◆ Cast()

◆ Clear()

◆ ClearAttributes()

◆ ClearEventAttributes()

◆ ClearGlobalAttribute()

◆ ClearInitStates()

◆ ClearMarkedStates()

◆ ClearMinStateIndexMap()

◆ ClearStateAttributes()

◆ ClearStateNames()

◆ ClearStates()

◆ ClearTransAttributes()

◆ ClearTransRel()

◆ ClrEventAttribute()

◆ ClrInitState() [1/3]

◆ ClrInitState() [2/3]

◆ ClrInitState() [3/3]

◆ ClrMarkedState() [1/3]

◆ ClrMarkedState() [2/3]

◆ ClrMarkedState() [3/3]

◆ ClrStateAttribute()

◆ ClrStateName() [1/2]

◆ ClrStateName() [2/2]

◆ ClrTransAttribute()

◆ ClrTransition() [1/3]

◆ ClrTransition() [2/3]

◆ ClrTransition() [3/3]

◆ ClrTransitions() [1/2]

◆ ClrTransitions() [2/2]

◆ Coaccessible()

◆ CoaccessibleSet()

◆ Complete() [1/2]

◆ Complete() [2/2]

◆ ConfigureAttributeTypes()

◆ Copy()

◆ DDotWrite()

◆ DeleteCore()

◆ DelEvent() [1/2]

◆ DelEvent() [2/2]

◆ DelEventFromAlphabet()

◆ DelEvents()

◆ DelState() [1/2]

◆ DelState() [2/2]

◆ DelStateFromStates() [1/2]

◆ DelStateFromStates() [2/2]

◆ DelStates()

◆ DoAssign()