EngineState
maintains the state of the engine.
For example, its location and what the user may do next.
Public Types | |
Types | |
enum | EnEngineState { enEngineState_readyForInit = 0, enEngineState_readyForProcessOrReconfigOrDeinit = 1, enEngineState_readyForDeletion = 2 } |
Public Member Functions | |
Constructors | |
EngineState (void) | |
Create a new state object with initial value: enEngineState_ctor. | |
Properties | |
EnEngineState | getState (void) const |
Return the current state. | |
Match operations | |
bool | operator== (EnEngineState enState) const |
Return TRUE, if this state matches the specified state. | |
bool | operator!= (EnEngineState enState) const |
Return TRUE, if this state does not match the specified state. | |
bool | operator> (EnEngineState enState) const |
Return TRUE, if this state is higher than the specified state. | |
bool | operator>= (EnEngineState enState) const |
Return TRUE, if this state is higher or equal to the specified state. | |
bool | operator< (EnEngineState enState) const |
Return TRUE, if this state is lower than the specified state. | |
bool | operator<= (EnEngineState enState) const |
Return TRUE, if this state is lower or equal to the specified state. | |
bool | isReadyToAddDocParts (void) const |
Return TRUE, if this state indicates that no documents have been added so far. | |
bool | isAllowedToAddDocParts (void) const |
Return TRUE, if this state indicates that documents may be added at this time. | |
void | assertMatch (EnEngineState enState) const |
Check that this state matches the specified state - this function is for debugging purposes only. | |
Miscellaneous | |
void | setToState (EnEngineState enState) |
Set this state to the specified state. |
uima::EngineState::EngineState | ( | void | ) | [inline] |
Create a new state object with initial value: enEngineState_ctor.
EnEngineState uima::EngineState::getState | ( | void | ) | const [inline] |
Return the current state.
bool uima::EngineState::operator== | ( | EnEngineState | enState | ) | const [inline] |
Return TRUE, if this state matches the specified state.
bool uima::EngineState::operator!= | ( | EnEngineState | enState | ) | const [inline] |
Return TRUE, if this state does not match the specified state.
bool uima::EngineState::operator> | ( | EnEngineState | enState | ) | const [inline] |
Return TRUE, if this state is higher than the specified state.
bool uima::EngineState::operator>= | ( | EnEngineState | enState | ) | const [inline] |
Return TRUE, if this state is higher or equal to the specified state.
bool uima::EngineState::operator< | ( | EnEngineState | enState | ) | const [inline] |
Return TRUE, if this state is lower than the specified state.
bool uima::EngineState::operator<= | ( | EnEngineState | enState | ) | const [inline] |
Return TRUE, if this state is lower or equal to the specified state.
bool uima::EngineState::isReadyToAddDocParts | ( | void | ) | const |
Return TRUE, if this state indicates that no documents have been added so far.
For example, the document buffer is empty.
bool uima::EngineState::isAllowedToAddDocParts | ( | void | ) | const |
Return TRUE, if this state indicates that documents may be added at this time.
void uima::EngineState::assertMatch | ( | EnEngineState | enState | ) | const [inline] |
Check that this state matches the specified state - this function is for debugging purposes only.
References _TEXT, and assertWithMsg.
void uima::EngineState::setToState | ( | EnEngineState | enState | ) | [inline] |
Set this state to the specified state.