libFAUDES

Sections

Index

faudes::ElemConstraint Class Reference
[Timed Automata PlugIn]

#include <tp_timeconstraint.h>

List of all members.


Detailed Description

Model of an elementary clock constraint formula.

The constraint consists of an index of a clock, a comperative operator and a constant time value. Semantically, an elementary contraint is satisfied at a time t if at that time the clock value compares true with the constant time. The clock index 0 is used to indicate an invalid contraint. It is only the context of the more general TimeContraint that provides a reference to a clock SymbolTable.

Parameters:
mClock Clock index
mCompOperator Symbolic integer value for comperative operator
mTimeConstant Time constant for comparison

Public Types

enum  Operator { GreaterEqual, GreaterThan, LessThan, LessEqual }
 Typedef for comparison operators in elementary clock constraints. More...

Public Member Functions

 ElemConstraint (void)
 Construct an (invalid) elementary clock constraint (clockindex 0).
 ElemConstraint (Idx clockindex, Operator op, tpTime::Type timeconst)
 Construct an elementary clock constraint from values.
void Set (Idx clockindex, Operator op, tpTime::Type timeconst)
 Set all values.
Idx Clock (Idx newClock)
 Set clock by index.
Idx Clock (void) const
 Get clock by index.
void CompOperator (Operator newOp)
 Set operator.
Operator CompOperator (void) const
 Get operator.
void TimeConstant (tpTime::Type newTimeConst)
 Set time constant.
tpTime::Type TimeConstant (void) const
 Get time constant.
std::string Str (void) const
 Writes ElemConstraint to std::string.
bool operator== (const ElemConstraint &otherElemConstraint) const
 Check for equality.
bool operator< (const ElemConstraint &otherElemConstraint) const
 Less operator for ordering in container classes.

Static Public Member Functions

static std::string OperatorName (Operator op)
 Conversion from symbolic operator to string.

Protected Attributes

Idx mClockIndex
 Index of clock.
Operator mCompOperator
 Comparative operator.
tpTime::Type mTimeConstant
 Time constant to compare with clock value.

Member Enumeration Documentation

Typedef for comparison operators in elementary clock constraints.

Enumerator:
GreaterEqual 
GreaterThan 
LessThan 
LessEqual 


Constructor & Destructor Documentation

faudes::ElemConstraint::ElemConstraint ( void   ) 

Construct an (invalid) elementary clock constraint (clockindex 0).

faudes::ElemConstraint::ElemConstraint ( Idx  clockindex,
Operator  op,
tpTime::Type  timeconst 
)

Construct an elementary clock constraint from values.

Parameters:
clockindex Clock by index.
op Symbolic value for operator
timeconst Value for time constant


Member Function Documentation

std::string faudes::ElemConstraint::OperatorName ( Operator  op  )  [static]

Conversion from symbolic operator to string.

void faudes::ElemConstraint::Set ( Idx  clockindex,
Operator  op,
tpTime::Type  timeconst 
)

Set all values.

Parameters:
clockindex Clock by index.
op Symbolic value for operator
timeconst Value for time constant

Idx faudes::ElemConstraint::Clock ( Idx  newClock  ) 

Set clock by index.

Idx faudes::ElemConstraint::Clock ( void   )  const

Get clock by index.

Returns:
clock index

void faudes::ElemConstraint::CompOperator ( Operator  newOp  ) 

Set operator.

Parameters:
newOp Symbolic value of new operator

ElemConstraint::Operator faudes::ElemConstraint::CompOperator ( void   )  const

Get operator.

Returns:
Operator

void faudes::ElemConstraint::TimeConstant ( tpTime::Type  newTimeConst  ) 

Set time constant.

Parameters:
newTimeConst Value of new time constant

tpTime::Type faudes::ElemConstraint::TimeConstant ( void   )  const

Get time constant.

Returns:
Time constant

std::string faudes::ElemConstraint::Str ( void   )  const

Writes ElemConstraint to std::string.

Returns:
std::string

bool faudes::ElemConstraint::operator== ( const ElemConstraint otherElemConstraint  )  const

Check for equality.

Parameters:
otherElemConstraint Other elementary constraint
Returns:
True if mClockIndex, mTimeConstant and mCompOperator are equal. Else false.

bool faudes::ElemConstraint::operator< ( const ElemConstraint otherElemConstraint  )  const

Less operator for ordering in container classes.

Parameters:
otherElemConstraint Other ElemConstraint
Returns:
True when clock index of left constraint is less than the one of right constraint. Else false.


Member Data Documentation

Index of clock.

Comparative operator.

Time constant to compare with clock value.


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

libFAUDES 2.13a c++ source docu by doxygen 1.5.6