Simbody  3.6
SimTK::HandleEventsResults Class Reference

Results returned by the handleEvent() method. More...

Public Types

enum  Status {
  Invalid = -1,
  Succeeded = 0,
  ShouldTerminate = 1,
  Failed = 2
}
 

Public Member Functions

 HandleEventsResults ()
 
HandleEventsResultsclear ()
 Restore this object to its default-constructed state, with the return status set to Invalid. More...
 
bool isValid () const
 
Status getExitStatus () const
 
bool getAnyChangeMade () const
 
Stage getLowestModifiedStage () const
 
const StringgetMessage () const
 
HandleEventsResultssetExitStatus (Status status)
 
HandleEventsResultssetAnyChangeMade (bool changeMade)
 
HandleEventsResultssetLowestModifiedStage (Stage stage)
 
HandleEventsResultssetMessage (const String &message)
 

Detailed Description

Results returned by the handleEvent() method.

In addition to return status, this records the lowest stage in the state that was modified by the handler. The caller can use this to determine how much reinitialization is required before time stepping can proceed.

Member Enumeration Documentation

◆ Status

Enumerator
Invalid 

This object has not been filled in yet and holds no results.

Succeeded 

The handleEvent() operation was successful and time stepping may continue.

ShouldTerminate 

The handleEvent() call was successful but the event requires time stepping to terminate.

An explanation may have been placed in the message argument.

Failed 

The handleEvent() call was unable to successfully handle the event.

This is likely to be a fatal error. A human-readable explanation is in the message argument.

Constructor & Destructor Documentation

◆ HandleEventsResults()

SimTK::HandleEventsResults::HandleEventsResults ( )
inline

Member Function Documentation

◆ clear()

HandleEventsResults& SimTK::HandleEventsResults::clear ( )
inline

Restore this object to its default-constructed state, with the return status set to Invalid.

◆ isValid()

bool SimTK::HandleEventsResults::isValid ( ) const
inline

◆ getExitStatus()

Status SimTK::HandleEventsResults::getExitStatus ( ) const
inline

◆ getAnyChangeMade()

bool SimTK::HandleEventsResults::getAnyChangeMade ( ) const
inline

◆ getLowestModifiedStage()

Stage SimTK::HandleEventsResults::getLowestModifiedStage ( ) const
inline

◆ getMessage()

const String& SimTK::HandleEventsResults::getMessage ( ) const
inline

◆ setExitStatus()

HandleEventsResults& SimTK::HandleEventsResults::setExitStatus ( Status  status)
inline

◆ setAnyChangeMade()

HandleEventsResults& SimTK::HandleEventsResults::setAnyChangeMade ( bool  changeMade)
inline

◆ setLowestModifiedStage()

HandleEventsResults& SimTK::HandleEventsResults::setLowestModifiedStage ( Stage  stage)
inline

◆ setMessage()

HandleEventsResults& SimTK::HandleEventsResults::setMessage ( const String message)
inline

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