ECF 1.5
Public Member Functions | Protected Attributes | List of all members

Termination operator: terminates on a given elapsed time. More...

#include <TermMaxTimeOp.h>

Inheritance diagram for TermMaxTimeOp:
Operator

Public Member Functions

void registerParameters (StateP)
 Register parameters with the Registry. Called before Operator::initialize. More...
 
bool initialize (StateP)
 Perform initialization. Called before Operator::operate. By default, if the return value is false, the operator will not be used! More...
 
bool operate (StateP)
 perform the designated operation More...
 
- Public Member Functions inherited from Operator
virtual bool operate (StateP)=0
 perform the designated operation More...
 
virtual bool initialize (StateP)
 Perform initialization. Called before Operator::operate. By default, if the return value is false, the operator will not be used! More...
 
virtual void registerParameters (StateP)
 Register parameters with the Registry. Called before Operator::initialize. More...
 
virtual void write (XMLNode &)
 Write operator state to XMLNode or the Registry. Called after Operator::initialize. More...
 
virtual void read (XMLNode &)
 Read operator state from XMLNode or the Registry. Called after Operator::initialize. More...
 

Protected Attributes

uint maxTime_
 

Detailed Description

Termination operator: terminates on a given elapsed time.

Definition at line 8 of file TermMaxTimeOp.h.

Member Function Documentation

◆ initialize()

bool TermMaxTimeOp::initialize ( StateP  )
virtual

Perform initialization. Called before Operator::operate. By default, if the return value is false, the operator will not be used!

Returns
initialization success

Reimplemented from Operator.

Definition at line 13 of file TermMaxTimeOp.cpp.

◆ operate()

bool TermMaxTimeOp::operate ( StateP  )
virtual

perform the designated operation

Implements Operator.

Definition at line 25 of file TermMaxTimeOp.cpp.

◆ registerParameters()

void TermMaxTimeOp::registerParameters ( StateP  )
virtual

Register parameters with the Registry. Called before Operator::initialize.

Reimplemented from Operator.

Definition at line 5 of file TermMaxTimeOp.cpp.

Member Data Documentation

◆ maxTime_

uint TermMaxTimeOp::maxTime_
protected

Definition at line 15 of file TermMaxTimeOp.h.


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