| |
libFAUDES
Sections
Index
|
faudes::SimEventAttribute Class Reference |
Public Member Functions | |
SimEventAttribute (void) | |
Default constructor. | |
virtual SimEventAttribute * | New (void) const |
Construct on heap. | |
virtual bool | IsDefault (void) const |
Test for default value. | |
bool | IsStochastic (void) const |
Test for stochastic property. | |
bool | IsPriority (void) const |
Test for priority property. | |
void | Stochastic (const SimStochasticEventAttribute &rStochasticAttribute) |
Set stochastic behaviour. | |
void | Priority (const SimPriorityEventAttribute &rPriorityAttribute) |
Set priority behaviour. | |
const SimPriorityEventAttribute & | Priority (void) const |
Get priority attribute. | |
const SimStochasticEventAttribute & | Stochastic (void) const |
Get stochastic attribute. | |
Public Attributes | |
tpTime::Type | mScheduledFor |
Next scheduled occurence of this event relative to current time. | |
tpTime::Type | mExpiresAt |
Time at which the recent schedule expires. | |
tpTime::Type | mDelayFor |
Amount of time to defer the event. | |
TimeInterval | mReferenceInterval |
Time domain on which the recent schedule was computed. | |
Protected Member Functions | |
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 | mStochastic |
Indicate precense of stochastic behaviour. | |
bool | mPriority |
Indicate precense of priority property. | |
SimPriorityEventAttribute | mPriorityAttribute |
Priority definition data. | |
SimStochasticEventAttribute | mStochasticAttribute |
Stochastic definition data. |
faudes::SimEventAttribute::SimEventAttribute | ( | void | ) | [inline] |
Default constructor.
Construct a SimEventAttribute with priority 0.
virtual SimEventAttribute* faudes::SimEventAttribute::New | ( | void | ) | const [inline, virtual] |
Construct on heap.
Technically not a constructor, this function creates an object with the same type. It is the callers reponsabilty to delete the object when no longer needed.
Reimplemented from faudes::AttributeCFlags.
virtual bool faudes::SimEventAttribute::IsDefault | ( | void | ) | const [inline, virtual] |
Test for default value.
Reimplemented from faudes::AttributeCFlags.
bool faudes::SimEventAttribute::IsStochastic | ( | void | ) | const [inline] |
Test for stochastic property.
bool faudes::SimEventAttribute::IsPriority | ( | void | ) | const [inline] |
Test for priority property.
void faudes::SimEventAttribute::Stochastic | ( | const SimStochasticEventAttribute & | rStochasticAttribute | ) | [inline] |
Set stochastic behaviour.
Define this attribute to indicate the specified stochastic bahaviour.
rStochasticAttribute | Define stochastic behaviour |
void faudes::SimEventAttribute::Priority | ( | const SimPriorityEventAttribute & | rPriorityAttribute | ) | [inline] |
Set priority behaviour.
Define this attribute to indicate execution with the specified priority.
rPriorityAttribute | Define stochastic behaviour |
const SimPriorityEventAttribute& faudes::SimEventAttribute::Priority | ( | void | ) | const [inline] |
Get priority attribute.
Note that the return value is only meaningful if the attribute actually is a priority attribute.
const SimStochasticEventAttribute& faudes::SimEventAttribute::Stochastic | ( | void | ) | const [inline] |
Get stochastic attribute.
Note that the return value is only meaningful if the attribute defines stochastic behaviour.
void faudes::SimEventAttribute::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 simulation event section, the method reads all consecutive simulation attributes. Else it does nothing. Exceptions may only be thrown on invalid data within the section. The label argument is ignored, we use hardcoded keywords for the four attributes. The context argument is ignored.
rTr | TokenReader to read from | |
rLabel | Section to read | |
pContext | Read context to provide contextual information |
Exception |
|
Reimplemented from faudes::AttributeCFlags.
void faudes::SimEventAttribute::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 all present simulation event attributes to include the defining data. The label argument is ignored, we use hardcoded keywords. The context argument is ignored.
rTw | TokenWriter to write to | |
rLabel | Section to write | |
pContext | Read context to provide contextual information |
Exception |
|
Reimplemented from faudes::AttributeCFlags.
Next scheduled occurence of this event relative to current time.
This is part of the execution state. It indicates the instance of time for which the respective event is scheduled to occur. Schedules, however, may expire or otherwise become invalid.
Time at which the recent schedule expires.
This is part of the execution state. Once a schedule expires, the event is re-scheduled.
Amount of time to defer the event.
This is part of the execution state. It is used for events of delay type and is a count down type alarm to trigger the event.
Time domain on which the recent schedule was computed.
This is part of the execution state. It is used to invalidate schedules for events of trigger type.
bool faudes::SimEventAttribute::mStochastic [protected] |
Indicate precense of stochastic behaviour.
bool faudes::SimEventAttribute::mPriority [protected] |
Indicate precense of priority property.
Priority definition data.
Stochastic definition data.
libFAUDES 2.13a c++ source docu by doxygen 1.5.6