faudes::AttributeSimCondition Class Reference
[Simulation Condition Attributes]

Attribute for a simulation condition. More...

#include <sp_simconditionset.h>

List of all members.

Public Types

typedef std::vector< StateSet >
::iterator 
Iterator
 Convenience typedef.
typedef std::vector< StateSet >
::const_iterator 
CIterator

Public Member Functions

 AttributeSimCondition (void)
 Default constructor.
 AttributeSimCondition (const AttributeSimCondition &rOther)
 Copy constructor.
virtual bool IsDefault (void) const
 Test for default value.
bool IsStateCondition (void) const
 Test for state condition.
bool IsEventCondition (void) const
 Test for event condition.
bool Breakpoint (void) const
 Test for break condition.
bool Enabled (void) const
 Test whether condition is enabled.
void StateCondition (const SimStateCondition &rStateConditionAttribute)
 Set state condition attribute.
void EventCondition (const SimEventCondition &rEventConditionAttribute)
 Set event condition attribute.
void Breakpoint (bool on)
 Set break flag.
void Enabled (bool on)
 Set enabled flag.
const SimEventConditionEventCondition (void) const
 Get event condition.
const SimStateConditionStateCondition (void) const
 Get state condition.
void Reset (void)
 Reset conditions execution state.
bool Satisfied (void) const
 Test whether the condition is currently satisfied.
void Satisfied (bool on, tpTime::Type now)
 Set the condition to be satisfied.

Public Attributes

SampledDensityFunction mSamplesPeriod
 Sampled period, at which this condition becomes satisfied.
SampledDensityFunction mSamplesDuration
 Sampled durations, for which this condition remains satisfied.

Static Public Attributes

static const fType mEnabledFlag = 0x01
static const fType mBreakpointFlag = 0x02

Protected Member Functions

void DoAssign (const AttributeSimCondition &rSrcAttr)
 Assignment method.
bool DoEqual (const AttributeSimCondition &rAttr) const
 Equality method.
virtual void DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 Reads the attribute from TokenReader, see AttributeVoid for public wrappers.
virtual void DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Writes the attribute to TokenWriter, see AttributeVoid for public wrappers.

Protected Attributes

bool mEventCondition
 Indicate precense of a event condition.
bool mStateCondition
 Indicate precense of a state condition.
SimEventCondition mEventConditionAttribute
 Event based condition data.
SimStateCondition mStateConditionAttribute
 State based condition data.
bool mSatisfied
 Condotion state: recorded as satisfied.
tpTime::Type mActivationTime
 Condition state: when last satisfied became true.

Static Private Attributes

static const fType mDefSCFlags = 0x01
 Overall default value.
static const fType mAllSCFlags = 0x03
 All flags used by CFlags.

Detailed Description

Attribute for a simulation condition.

In order to extract statistical data from a simulation by a LoggingExecutor or some derived class, so called simulation conditions are defined. At any instance of time, a condition is satisfied or dissatisfied. Statistical data can then be requested regarding the period and duration of each condition. Currently, two types of conditions are available:

A Condition may be flagged as a break condition to halt simulation when satisfied. A condition may be enabled for tracking or not.

The class AttributeSimCondition summarizes all data to represent faudes simulation conditions. It also holds some state of the condition wrt execution and provides an interface for sampling. The latter may be seperated to a different class in a future revision. The class AttributeSimCondition does, however, not implement any test whether or not a condition is satisfied. This is done by the LoggingExecutor.

As a faudes attribute, conditions can be referenced by names via the std faudes container TaNameSet. For token io, a ParallelExecutor should be provided as context to access symbolic state names. The file format of a set of events equipped with condition attributes is illustrated by the below example to monitor some performance aspects of one simple machine:

 <Conditions>

 % monitor when the machine is idle
 "IdleCond"      
 <StateCondition>
 <StateSet> "idle" </StateSet>
 </StateCondition>

 % halt simulation  when the machine is down
 % however, the condition is disabled
 "DownCond"      
 +Break+     
 +Disabled+     
 <StateCondition>
 <StateSet> "down" </StateSet>
 </StateCondition>

 % monitor how long the prozessing one work piece takes
 "OperationCond"     
 <EventCondition>
 <StartEvents>  "alpha" </StartEvents>
 <StopEvents>   "beta"  </StopEvents>
 </EventCondition>

 </Conditions>

Definition at line 134 of file sp_simconditionset.h.


Member Typedef Documentation

typedef std::vector<StateSet>::const_iterator faudes::AttributeSimCondition::CIterator

Definition at line 142 of file sp_simconditionset.h.

typedef std::vector<StateSet>::iterator faudes::AttributeSimCondition::Iterator

Convenience typedef.

Definition at line 141 of file sp_simconditionset.h.


Constructor & Destructor Documentation

faudes::AttributeSimCondition::AttributeSimCondition ( void   ) 

Default constructor.

Constructs a AttributeSimCondition of with no type ie neither state condition nor event condition.

Definition at line 34 of file sp_simconditionset.cpp.

faudes::AttributeSimCondition::AttributeSimCondition ( const AttributeSimCondition rOther  ) 

Copy constructor.

with no type ie neither state condition nor event condition.

Definition at line 45 of file sp_simconditionset.cpp.


Member Function Documentation

void faudes::AttributeSimCondition::Breakpoint ( bool  on  )  [inline]

Set break flag.

Parameters:
on True, to indicate that this condition halts simulation.

Definition at line 227 of file sp_simconditionset.h.

bool faudes::AttributeSimCondition::Breakpoint ( void   )  const [inline]

Test for break condition.

Returns:
True, if this condition halts simulation.

Definition at line 188 of file sp_simconditionset.h.

void faudes::AttributeSimCondition::DoAssign ( const AttributeSimCondition rSrcAttr  )  [protected]

Assignment method.

Parameters:
rSrcAttr Source to assign from

Definition at line 55 of file sp_simconditionset.cpp.

bool faudes::AttributeSimCondition::DoEqual ( const AttributeSimCondition rAttr  )  const [protected]

Equality method.

Parameters:
rAttr Source to compare with

Definition at line 72 of file sp_simconditionset.cpp.

void faudes::AttributeSimCondition::DoRead ( TokenReader rTr,
const std::string &  rLabel = "",
const Type pContext = 0 
) [protected, virtual]

Reads the attribute from TokenReader, see AttributeVoid for public wrappers.

If the current token indicates a condition section, the method reads the condition data from that section. Else it does nothing. Exceptions may only be thrown on invalid data within the condition section. The label argiment is ignored, we use hardcoded labled "EventCondition" and "StateCondition" to figure the type of condition. When a ParallelExecutor is provided as context, it is used to interpret symbolc state names of a state condition.

Parameters:
rTr TokenReader to read from
rLabel Section to read
pContext Read context to provide contextual information
Exceptions:
Exception 
  • IO error (id 1)

Reimplemented from faudes::AttributeFlags.

Definition at line 134 of file sp_simconditionset.cpp.

void faudes::AttributeSimCondition::DoWrite ( TokenWriter rTw,
const std::string &  rLabel = "",
const Type pContext = 0 
) const [protected, virtual]

Writes the attribute to TokenWriter, see AttributeVoid for public wrappers.

Writes a condition section to include data on state- or event-condition. The label argument is ignored, we use hardcoded keywords "EventCondition" and StateCondition". When a ParallelExecutor is provided as context, it state conditions are written with symbolic state names.

Parameters:
rTw TokenWriter to write to
rLabel Section to write
pContext Read context to provide contextual information
Exceptions:
Exception 
  • IO error (id 2)

Reimplemented from faudes::AttributeFlags.

Definition at line 86 of file sp_simconditionset.cpp.

void faudes::AttributeSimCondition::Enabled ( bool  on  )  [inline]

Set enabled flag.

Parameters:
on True, to indicate that this condition is to be monitored during simulation.

Definition at line 235 of file sp_simconditionset.h.

bool faudes::AttributeSimCondition::Enabled ( void   )  const [inline]

Test whether condition is enabled.

Returns:
True, if this condition is monitored during simulation.

Definition at line 196 of file sp_simconditionset.h.

const SimEventCondition& faudes::AttributeSimCondition::EventCondition ( void   )  const [inline]

Get event condition.

Note that the attribute can only return meaningful data if it actually is an event condition.

Returns:
Defining data of this attribute's event condition.

Definition at line 245 of file sp_simconditionset.h.

void faudes::AttributeSimCondition::EventCondition ( const SimEventCondition rEventConditionAttribute  )  [inline]

Set event condition attribute.

Define this attribute to represent the specified event condition.

Parameters:
rEventConditionAttribute Define event condition

Definition at line 218 of file sp_simconditionset.h.

virtual bool faudes::AttributeSimCondition::IsDefault ( void   )  const [inline, virtual]

Test for default value.

Returns:
True, if this attribute has its default value

Reimplemented from faudes::AttributeFlags.

Definition at line 162 of file sp_simconditionset.h.

bool faudes::AttributeSimCondition::IsEventCondition ( void   )  const [inline]

Test for event condition.

Returns:
True, if this attribute defines an event condition

Definition at line 180 of file sp_simconditionset.h.

bool faudes::AttributeSimCondition::IsStateCondition ( void   )  const [inline]

Test for state condition.

Returns:
True, if this attribute defines a state condition

Definition at line 172 of file sp_simconditionset.h.

void faudes::AttributeSimCondition::Reset ( void   )  [inline]

Reset conditions execution state.

The execution state of a condition consists of all data accumulated during simulation eg statistical data and whether or not the condition is currently satisfied. The execution state resides in the attribute for pragmatic reasons only.

Definition at line 263 of file sp_simconditionset.h.

void faudes::AttributeSimCondition::Satisfied ( bool  on,
tpTime::Type  now 
)

Set the condition to be satisfied.

This is part of the condition execution state. Since it is the executor that determines whether a condition is satisfied, and since the condition state resides in the attribute, the executor is meant to notify state changes.

Parameters:
on True, if the conditions is considered satisfied
now Time at which the state change occures

Definition at line 251 of file sp_simconditionset.cpp.

bool faudes::AttributeSimCondition::Satisfied ( void   )  const [inline]

Test whether the condition is currently satisfied.

This is part of the condition execution state.

Returns:
True, if the conditions is considered satisfied

Definition at line 273 of file sp_simconditionset.h.

const SimStateCondition& faudes::AttributeSimCondition::StateCondition ( void   )  const [inline]

Get state condition.

Note that the attribute can only return meaningful data if it actually is an state condition.

Returns:
Defining data of this attribute's state condition.

Definition at line 255 of file sp_simconditionset.h.

void faudes::AttributeSimCondition::StateCondition ( const SimStateCondition rStateConditionAttribute  )  [inline]

Set state condition attribute.

Define this attribute to represent the specified state condition.

Parameters:
rStateConditionAttribute Define state condition

Definition at line 205 of file sp_simconditionset.h.


Member Data Documentation

Condition state: when last satisfied became true.

Definition at line 321 of file sp_simconditionset.h.

const fType faudes::AttributeSimCondition::mAllSCFlags = 0x03 [static, private]

All flags used by CFlags.

Definition at line 390 of file sp_simconditionset.h.

Definition at line 301 of file sp_simconditionset.h.

const fType faudes::AttributeSimCondition::mDefSCFlags = 0x01 [static, private]

Overall default value.

Definition at line 387 of file sp_simconditionset.h.

Definition at line 300 of file sp_simconditionset.h.

Indicate precense of a event condition.

Definition at line 306 of file sp_simconditionset.h.

Event based condition data.

Definition at line 312 of file sp_simconditionset.h.

Sampled durations, for which this condition remains satisfied.

Definition at line 297 of file sp_simconditionset.h.

Sampled period, at which this condition becomes satisfied.

Definition at line 292 of file sp_simconditionset.h.

Condotion state: recorded as satisfied.

Definition at line 318 of file sp_simconditionset.h.

Indicate precense of a state condition.

Definition at line 309 of file sp_simconditionset.h.

State based condition data.

Definition at line 315 of file sp_simconditionset.h.


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

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