faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr > Class Template Reference
[Hierarchical I/O Systems PlugIn]

Generator with I/O-plant attributes. More...

#include <hio_plant.h>

List of all members.

Public Member Functions

 THioPlant (void)
 Creates an empty HioPlant object.
 THioPlant (const Generator &rOtherGen)
 HioPlant from a std Generator.
 THioPlant (const Generator &rOtherGen, const EventSet &rYp, const EventSet &rUp, const EventSet &rYe, const EventSet &rUe)
 HioPlant from a std Generator and event sets.
 THioPlant (const THioPlant &rOtherGen)
 HioPlant from a HioPlant.
 THioPlant (const std::string &rFileName)
 construct a HioPlant from file
virtual THioPlantNew (void) const
 Construct on heap.
virtual THioPlantCopy (void) const
 Construct copy on heap.
THioPlant NewHioPlant (void) const
 Create empty HioPlant with same symboltable as this.
virtual THioPlantoperator= (const THioPlant &rOtherGen)
 Assignment operator (uses copy ) Note: you must reimplement this operator in derived classes in order to handle internal pointers correctly.
virtual THioPlantoperator= (const Generator &rOtherGen)
 Assignment operator (uses copy ).
void InsYpEvent (Idx index)
 Add an existing Yp-event to generator.
Idx InsYpEvent (const std::string &rName)
 Add new named Yp-event to generator.
void InsUpEvent (Idx index)
 Add an existing Up-event to generator.
Idx InsUpEvent (const std::string &rName)
 Add new named Up-event to generator.
void SetYp (Idx index)
 Mark event as Yp-event (by index).
void SetYp (const std::string &rName)
 Mark event as Yp-event(by name).
void SetYp (const EventSet &rEvents)
 Mark set of events as Yp-events.
void SetUp (Idx index)
 Mark event Up-event(by index).
void SetUp (const std::string &rName)
 Mark event Up-event(by name).
void SetUp (const EventSet &rEvents)
 Mark set of events as Up-events.
bool IsYp (Idx index) const
 Is event Yp-event(by index).
bool IsYp (const std::string &rName) const
 Is event Yp-event(by name).
bool IsUp (Idx index) const
 Is event Up-event(by index).
bool IsUp (const std::string &rName) const
 Is event Up-event(by name).
EventSet YpEvents (void) const
 Get EventSet with Yp-events.
EventSet UpEvents (void) const
 Get EventSet with Up-events.
void InsYeEvent (Idx index)
 Add an existing Ye-event to generator.
Idx InsYeEvent (const std::string &rName)
 Add new named Ye-event to generator.
void InsUeEvent (Idx index)
 Add an existing Ue-event to generator.
Idx InsUeEvent (const std::string &rName)
 Add new named Ue-event to generator.
void SetYe (Idx index)
 Mark event as Ye-event (by index).
void SetYe (const std::string &rName)
 Mark event as Ye-event (by name).
void SetYe (const EventSet &rEvents)
 Mark set of events as Ye-events.
void SetUe (Idx index)
 Mark event as Ue-event (by index).
void SetUe (const std::string &rName)
 Mark event as Ue-event (by name).
void SetUe (const EventSet &rEvents)
 Mark set of events as Ue-events.
bool IsYe (Idx index) const
 Is event Ye-event (by index).
bool IsYe (const std::string &rName) const
 Is event Ye-event (by name).
bool IsUe (Idx index) const
 Is event Ue-event (by index).
bool IsUe (const std::string &rName) const
 Is event Ue-event (by name).
EventSet YeEvents (void) const
 Get EventSet with Ye-events.
EventSet UeEvents (void) const
 Get EventSet with Ue-events.
bool IsY (Idx index) const
 Is event Y-event? (by index).
bool IsY (const std::string &rName) const
 Is event Y-event? (by name).
EventSet YEvents (void) const
 Get EventSet with Y-events.
bool IsU (Idx index) const
 Is event U-event? (by index).
bool IsU (const std::string &rName) const
 Is event U-event? (by name).
EventSet UEvents (void) const
 Get EventSet with U-events.
bool IsP (Idx index) const
 Is event P-event? (by index).
bool IsP (const std::string &rName) const
 Is event P-event? (by name).
EventSet PEvents (void) const
 Get EventSet with P-events.
bool IsE (Idx index) const
 Is event E-event? (by index).
bool IsE (const std::string &rName) const
 Is event E-event? (by name).
EventSet EEvents (void) const
 Get EventSet with E-events.
void SetQYpYe (Idx index)
 Mark state as QYpYe-state (by index).
void SetQYpYe (const std::string &rName)
 Mark state as QYpYe-state (by name).
void SetQYpYe (const StateSet &rStates)
 Mark set of states as QYpYe-states.
void ClrQYpYe (Idx index)
 Mark state as NOT QYpYe-state (by index).
void ClrQYpYe (const std::string &rName)
 Mark state as NOT QYpYe-state (by name).
void ClrQYpYe (const StateSet &rStates)
 Mark set of states as NOT QYpYe-states (by index).
bool IsQYpYe (Idx index) const
 Is state QYpYe-state (by index).
bool IsQYpYe (const std::string &rName) const
 Is state QYpYe-state (by name).
StateSet QYpYeStates (void) const
 Get StateSet with QYpYe-states.
void SetQUp (Idx index)
 Mark state as QUp-state (by index).
void SetQUp (const std::string &rName)
 Mark state as QUp-state (by name).
void SetQUp (const StateSet &rStates)
 Mark set of states as QUp-states.
void ClrQUp (Idx index)
 Mark state as NOT QUp-state (by index).
void ClrQUp (const std::string &rName)
 Mark state as NOT QUp-state (by name).
void ClrQUp (const StateSet &rStates)
 Mark set of states as NOT QUp-states (by index).
bool IsQUp (Idx index) const
 Is state QUp-state (by index).
bool IsQUp (const std::string &rName) const
 Is state QUp-state (by name).
StateSet QUpStates (void) const
 Get StateSet with QUp-states.
void SetQUe (Idx index)
 Mark state as QUe-state (by index).
void SetQUe (const std::string &rName)
 Mark state as QUe-state (by name).
void SetQUe (const StateSet &rStates)
 Mark set of states as QUe-states.
void ClrQUe (Idx index)
 Mark state as NOT QUe-state (by index).
void ClrQUe (const std::string &rName)
 Mark state as NOT QUe-state (by name).
void ClrQUe (const StateSet &rStates)
 Mark set of states as NOT QUe-states (by index).
bool IsQUe (Idx index) const
 Is state QUe-state (by index).
bool IsQUe (const std::string &rName) const
 Is state QUe-state (by name).
StateSet QUeStates (void) const
 Get StateSet with QUe-states.
void SetErr (Idx index)
 Mark state as Err-state (by index).
void SetErr (const std::string &rName)
 Mark state as Err-state (by name).
void SetErr (const StateSet &rStates)
 Mark set of states as Err-states.
void ClrErr (Idx index)
 Mark state as NOT Err-state (by index).
void ClrErr (const std::string &rName)
 Mark state as NOT Err-state (by name).
void ClrErr (const StateSet &rStates)
 Mark set of states as NOT Err-states (by index).
bool IsErr (Idx index) const
 Is state Err-state (by index).
bool IsErr (const std::string &rName) const
 Is state Err-state (by name).
StateSet ErrStates (void) const
 Get StateSet with Err-states.
virtual bool UpdateAttributes (void)
 Updates internal attributes.

Detailed Description

template<class GlobalAttr, class StateAttr, class EventAttr, class TransAttr>
class faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >

Generator with I/O-plant attributes.

The HioPlant is a variant of the Generator to add an interface for events and states with I/O-plant attributes, built from HioEvent- and HioStateFlags

  • event attributes: YP = Y && P UP = U && P YE = Y && E UE = U && E
  • state attributes: QYpYe = QY && QP && QE QUp = QU && QP QUe = QU && QE

Technically, the construct is based on the specialized attribute classes faudes::HioEventFlags and faudes::HioStateFlags that provide attributes with semantics for hierarchical I/O properties. The THioPlant expects attribute template parameters with the minimum interface defined in HioEventFlags and HioStateFlags. Thus, you can add further semantics by deriving a class HioEventFlagsAndMore from HioEventFlags (same for HioStateFlags) and use this as event attribute parameter for THioPlant. To model a plain finite state machine plus I/O-plant properties, use THioPlant with HioEventFlags and HioStateFlags for the event and state attribute parameters and AttributeVoid for the other parameters. For convenience, this has been typedefed as HioPlant.

Definition at line 47 of file hio_plant.h.


Constructor & Destructor Documentation

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::THioPlant ( void   )  [inline]

Creates an empty HioPlant object.

Definition at line 899 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::THioPlant ( const Generator rOtherGen  )  [inline]

HioPlant from a std Generator.

Copy constructor

Parameters:
rOtherGen 

Definition at line 909 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::THioPlant ( const Generator rOtherGen,
const EventSet rYp,
const EventSet rUp,
const EventSet rYe,
const EventSet rUe 
) [inline]

HioPlant from a std Generator and event sets.

Copy constructor

Parameters:
rOtherGen Generator
rYp alphabet Yp
rUp alphabet Up
rYe alphabet Ye
rUe alphabet Ue

Definition at line 914 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::THioPlant ( const THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr > &  rOtherGen  )  [inline]

HioPlant from a HioPlant.

Copy constructor

Parameters:
rOtherGen 

Definition at line 904 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::THioPlant ( const std::string &  rFileName  )  [inline]

construct a HioPlant from file

Parameters:
rFileName Filename
Exceptions:
Exception If opening/reading fails an Exception object is thrown (id 1, 50, 51)

Definition at line 929 of file hio_plant.h.


Member Function Documentation

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ClrErr ( const StateSet rStates  )  [inline]

Mark set of states as NOT Err-states (by index).

Parameters:
rStates StateSet

Definition at line 1608 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ClrErr ( const std::string &  rName  )  [inline]

Mark state as NOT Err-state (by name).

Parameters:
rName State name

Definition at line 1601 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ClrErr ( Idx  index  )  [inline]

Mark state as NOT Err-state (by index).

Parameters:
index State index

Definition at line 1593 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ClrQUe ( const StateSet rStates  )  [inline]

Mark set of states as NOT QUe-states (by index).

Parameters:
rStates StateSet

Definition at line 1537 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ClrQUe ( const std::string &  rName  )  [inline]

Mark state as NOT QUe-state (by name).

Parameters:
rName State name

Definition at line 1530 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ClrQUe ( Idx  index  )  [inline]

Mark state as NOT QUe-state (by index).

Parameters:
index State index

Definition at line 1521 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ClrQUp ( const StateSet rStates  )  [inline]

Mark set of states as NOT QUp-states (by index).

Parameters:
rStates StateSet

Definition at line 1455 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ClrQUp ( const std::string &  rName  )  [inline]

Mark state as NOT QUp-state (by name).

Parameters:
rName State name

Definition at line 1448 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ClrQUp ( Idx  index  )  [inline]

Mark state as NOT QUp-state (by index).

Parameters:
index State index

Definition at line 1439 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ClrQYpYe ( const StateSet rStates  )  [inline]

Mark set of states as NOT QYpYe-states (by index).

Parameters:
rStates StateSet

Definition at line 1375 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ClrQYpYe ( const std::string &  rName  )  [inline]

Mark state as NOT QYpYe-state (by name).

Parameters:
rName State name

Definition at line 1368 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ClrQYpYe ( Idx  index  )  [inline]

Mark state as NOT QYpYe-state (by index).

Parameters:
index State index

Definition at line 1358 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr > * faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::Copy ( void   )  const [inline, virtual]

Construct copy on heap.

Returns:
new Generator

Reimplemented from faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 944 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
EventSet faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::EEvents ( void   )  const [inline]

Get EventSet with E-events.

Returns:
EventSet of E-events

Definition at line 1310 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
StateSet faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::ErrStates ( void   )  const [inline]

Get StateSet with Err-states.

Returns:
StateSet of Err-states

Definition at line 1629 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
Idx faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::InsUeEvent ( const std::string &  rName  )  [inline]

Add new named Ue-event to generator.

An entry in the global event table will be made if event is new.

Parameters:
rName Name of the event to add
Returns:
New global unique index

Definition at line 1168 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::InsUeEvent ( Idx  index  )  [inline]

Add an existing Ue-event to generator.

An entry in the global event table will be made.

Parameters:
index Event index

Definition at line 1159 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
Idx faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::InsUpEvent ( const std::string &  rName  )  [inline]

Add new named Up-event to generator.

An entry in the global event table will be made if event is new.

Parameters:
rName Name of the event to add
Returns:
New global unique index

Definition at line 1034 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::InsUpEvent ( Idx  index  )  [inline]

Add an existing Up-event to generator.

An entry in the global event table will be made.

Parameters:
index Event index

Definition at line 1025 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
Idx faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::InsYeEvent ( const std::string &  rName  )  [inline]

Add new named Ye-event to generator.

An entry in the global event table will be made if event is new.

Parameters:
rName Name of the event to add
Returns:
New global unique index

Definition at line 1150 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::InsYeEvent ( Idx  index  )  [inline]

Add an existing Ye-event to generator.

An entry in the global event table will be made.

Parameters:
index Event index

Definition at line 1141 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
Idx faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::InsYpEvent ( const std::string &  rName  )  [inline]

Add new named Yp-event to generator.

An entry in the global event table will be made if event is new.

Parameters:
rName Name of the event to add
Returns:
New global unique index

Definition at line 1016 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::InsYpEvent ( Idx  index  )  [inline]

Add an existing Yp-event to generator.

An entry in the global event table will be made.

Parameters:
index Event index

Definition at line 1007 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsE ( const std::string &  rName  )  const [inline]

Is event E-event? (by name).

Parameters:
rName Event name
Returns:
True / false

Definition at line 1293 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsE ( Idx  index  )  const [inline]

Is event E-event? (by index).

Parameters:
index Event index
Returns:
True / false

Definition at line 1287 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsErr ( const std::string &  rName  )  const [inline]

Is state Err-state (by name).

Parameters:
rName State name
Returns:
True / false

Definition at line 1623 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsErr ( Idx  index  )  const [inline]

Is state Err-state (by index).

Parameters:
index State index
Returns:
True / false

Definition at line 1617 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsP ( const std::string &  rName  )  const [inline]

Is event P-event? (by name).

Parameters:
rName Event name
Returns:
True / false

Definition at line 1281 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsP ( Idx  index  )  const [inline]

Is event P-event? (by index).

Parameters:
index Event index
Returns:
True / false

Definition at line 1275 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsQUe ( const std::string &  rName  )  const [inline]

Is state QUe-state (by name).

Parameters:
rName State name
Returns:
True / false

Definition at line 1552 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsQUe ( Idx  index  )  const [inline]

Is state QUe-state (by index).

Parameters:
index State index
Returns:
True / false

Definition at line 1546 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsQUp ( const std::string &  rName  )  const [inline]

Is state QUp-state (by name).

Parameters:
rName State name
Returns:
True / false

Definition at line 1470 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsQUp ( Idx  index  )  const [inline]

Is state QUp-state (by index).

Parameters:
index State index
Returns:
True / false

Definition at line 1464 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsQYpYe ( const std::string &  rName  )  const [inline]

Is state QYpYe-state (by name).

Parameters:
rName State name
Returns:
True / false

Definition at line 1390 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsQYpYe ( Idx  index  )  const [inline]

Is state QYpYe-state (by index).

Parameters:
index State index
Returns:
True / false

Definition at line 1384 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsU ( const std::string &  rName  )  const [inline]

Is event U-event? (by name).

Parameters:
rName Event name
Returns:
True / false

Definition at line 977 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsU ( Idx  index  )  const [inline]

Is event U-event? (by index).

Parameters:
index Event index
Returns:
True / false

Definition at line 971 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsUe ( const std::string &  rName  )  const [inline]

Is event Ue-event (by name).

Parameters:
rName Event name
Returns:
True / false

Definition at line 1245 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsUe ( Idx  index  )  const [inline]

Is event Ue-event (by index).

Parameters:
index Event index
Returns:
True / false

Definition at line 1239 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsUp ( const std::string &  rName  )  const [inline]

Is event Up-event(by name).

Parameters:
rName Event name
Returns:
True / false

Definition at line 1111 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsUp ( Idx  index  )  const [inline]

Is event Up-event(by index).

Parameters:
index Event index
Returns:
True / false

Definition at line 1105 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsY ( const std::string &  rName  )  const [inline]

Is event Y-event? (by name).

Parameters:
rName Event name
Returns:
True / false

Definition at line 965 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsY ( Idx  index  )  const [inline]

Is event Y-event? (by index).

Parameters:
index Event index
Returns:
True / false

Definition at line 959 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsYe ( const std::string &  rName  )  const [inline]

Is event Ye-event (by name).

Parameters:
rName Event name
Returns:
True / false

Definition at line 1233 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsYe ( Idx  index  )  const [inline]

Is event Ye-event (by index).

Parameters:
index Event index
Returns:
True / false

Definition at line 1227 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsYp ( const std::string &  rName  )  const [inline]

Is event Yp-event(by name).

Parameters:
rName Event name
Returns:
True / false

Definition at line 1099 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::IsYp ( Idx  index  )  const [inline]

Is event Yp-event(by index).

Parameters:
index Event index
Returns:
True / false

Definition at line 1093 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr > * faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::New ( void   )  const [inline, virtual]

Construct on heap.

Returns:
new Generator

Reimplemented from faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 934 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr > faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::NewHioPlant ( void   )  const [inline]

Create empty HioPlant with same symboltable as this.

Returns:
New Generator

Definition at line 949 of file hio_plant.h.

template<class GlobalAttr, class StateAttr, class EventAttr, class TransAttr>
virtual THioPlant& faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::operator= ( const Generator rOtherGen  )  [inline, virtual]

Assignment operator (uses copy ).

Parameters:
rOtherGen Other generator

Reimplemented from faudes::TaGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 141 of file hio_plant.h.

template<class GlobalAttr, class StateAttr, class EventAttr, class TransAttr>
virtual THioPlant& faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::operator= ( const THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr > &  rOtherGen  )  [inline, virtual]

Assignment operator (uses copy ) Note: you must reimplement this operator in derived classes in order to handle internal pointers correctly.

Parameters:
rOtherGen Other generator

Definition at line 133 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
EventSet faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::PEvents ( void   )  const [inline]

Get EventSet with P-events.

Returns:
EventSet of P-events

Definition at line 1299 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
StateSet faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::QUeStates ( void   )  const [inline]

Get StateSet with QUe-states.

Returns:
StateSet of QUe-states

Definition at line 1558 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
StateSet faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::QUpStates ( void   )  const [inline]

Get StateSet with QUp-states.

Returns:
StateSet of QUp-states

Definition at line 1476 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
StateSet faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::QYpYeStates ( void   )  const [inline]

Get StateSet with QYpYe-states.

Returns:
StateSet of QYpYe-states

Definition at line 1396 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetErr ( const StateSet rStates  )  [inline]

Mark set of states as Err-states.

Parameters:
rStates StateSet

Definition at line 1584 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetErr ( const std::string &  rName  )  [inline]

Mark state as Err-state (by name).

Parameters:
rName State name

Definition at line 1577 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetErr ( Idx  index  )  [inline]

Mark state as Err-state (by index).

Parameters:
index State index

Definition at line 1569 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetQUe ( const StateSet rStates  )  [inline]

Mark set of states as QUe-states.

Parameters:
rStates StateSet

Definition at line 1512 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetQUe ( const std::string &  rName  )  [inline]

Mark state as QUe-state (by name).

Parameters:
rName State name

Definition at line 1505 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetQUe ( Idx  index  )  [inline]

Mark state as QUe-state (by index).

Parameters:
index State index

Definition at line 1490 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetQUp ( const StateSet rStates  )  [inline]

Mark set of states as QUp-states.

Parameters:
rStates StateSet

Definition at line 1430 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetQUp ( const std::string &  rName  )  [inline]

Mark state as QUp-state (by name).

Parameters:
rName State name

Definition at line 1423 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetQUp ( Idx  index  )  [inline]

Mark state as QUp-state (by index).

Parameters:
index State index

Definition at line 1408 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetQYpYe ( const StateSet rStates  )  [inline]

Mark set of states as QYpYe-states.

Parameters:
rStates StateSet

Definition at line 1349 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetQYpYe ( const std::string &  rName  )  [inline]

Mark state as QYpYe-state (by name).

Parameters:
rName State name

Definition at line 1342 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetQYpYe ( Idx  index  )  [inline]

Mark state as QYpYe-state (by index).

Parameters:
index State index

Definition at line 1327 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetUe ( const EventSet rEvents  )  [inline]

Mark set of events as Ue-events.

Parameters:
rEvents EventSet

Definition at line 1218 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetUe ( const std::string &  rName  )  [inline]

Mark event as Ue-event (by name).

Parameters:
rName Event name

Definition at line 1211 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetUe ( Idx  index  )  [inline]

Mark event as Ue-event (by index).

Parameters:
index Event index

Definition at line 1202 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetUp ( const EventSet rEvents  )  [inline]

Mark set of events as Up-events.

Parameters:
rEvents EventSet

Definition at line 1084 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetUp ( const std::string &  rName  )  [inline]

Mark event Up-event(by name).

Parameters:
rName Event name

Definition at line 1077 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetUp ( Idx  index  )  [inline]

Mark event Up-event(by index).

Parameters:
index Event index

Definition at line 1068 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetYe ( const EventSet rEvents  )  [inline]

Mark set of events as Ye-events.

Parameters:
rEvents EventSet

Definition at line 1193 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetYe ( const std::string &  rName  )  [inline]

Mark event as Ye-event (by name).

Parameters:
rName Event name

Definition at line 1186 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetYe ( Idx  index  )  [inline]

Mark event as Ye-event (by index).

Parameters:
index Event index

Definition at line 1177 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetYp ( const EventSet rEvents  )  [inline]

Mark set of events as Yp-events.

Parameters:
rEvents EventSet

Definition at line 1059 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetYp ( const std::string &  rName  )  [inline]

Mark event as Yp-event(by name).

Parameters:
rName Event name

Definition at line 1052 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetYp ( Idx  index  )  [inline]

Mark event as Yp-event (by index).

Parameters:
index Event index

Definition at line 1043 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
EventSet faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::UeEvents ( void   )  const [inline]

Get EventSet with Ue-events.

Returns:
EventSet of Ue-events

Definition at line 1262 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
EventSet faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::UEvents ( void   )  const [inline]

Get EventSet with U-events.

Returns:
EventSet of U-events

Definition at line 994 of file hio_plant.h.

template<class GlobalAttr, class StateAttr, class EventAttr, class TransAttr>
virtual bool faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::UpdateAttributes ( void   )  [inline, virtual]

Updates internal attributes.

This method sets the state partition attributes.

Returns:
True if value changed

Reimplemented from faudes::vGenerator.

Definition at line 881 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
EventSet faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::UpEvents ( void   )  const [inline]

Get EventSet with Up-events.

Returns:
EventSet of Up-events

Definition at line 1128 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
EventSet faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::YeEvents ( void   )  const [inline]

Get EventSet with Ye-events.

Returns:
EventSet of Ye-events

Definition at line 1251 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
EventSet faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::YEvents ( void   )  const [inline]

Get EventSet with Y-events.

Returns:
EventSet of Y-events

Definition at line 983 of file hio_plant.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
EventSet faudes::THioPlant< GlobalAttr, StateAttr, EventAttr, TransAttr >::YpEvents ( void   )  const [inline]

Get EventSet with Yp-events.

Returns:
EventSet of Yp-events

Definition at line 1117 of file hio_plant.h.


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

libFAUDES 2.23h --- 2014.04.03 --- c++ api documentaion by doxygen