cisst-saw
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes | List of all members
prmOperatingState Class Reference

#include <prmOperatingState.h>

Inheritance diagram for prmOperatingState:
mtsGenericObject cmnGenericObject

Public Types

enum  StateType {
  UNDEFINED , DISABLED , ENABLED , PAUSED ,
  FAULT
}
enum  CommandType {
  enable , disable , pause , resume ,
  home , unhome
}

Public Member Functions

 prmOperatingState (void)
 prmOperatingState (const prmOperatingState &other)
prmOperatingState & operator= (const prmOperatingState &other)
 ~prmOperatingState ()
void GetState (prmOperatingState::StateType &placeHolder) const
prmOperatingState::StateType GetState (void) const
void SetState (const prmOperatingState::StateType &newValue)
const prmOperatingState::StateType & State (void) const
prmOperatingState::StateType & State (void)
void GetSubState (std::string &placeHolder) const
std::string GetSubState (void) const
void SetSubState (const std::string &newValue)
const std::string & SubState (void) const
std::string & SubState (void)
void GetIsHomed (bool &placeHolder) const
bool GetIsHomed (void) const
void SetIsHomed (const bool &newValue)
const bool & IsHomed (void) const
bool & IsHomed (void)
void GetIsBusy (bool &placeHolder) const
bool GetIsBusy (void) const
void SetIsBusy (const bool &newValue)
const bool & IsBusy (void) const
bool & IsBusy (void)
bool IsEnabledHomedAndNotBusy (void) const
bool IsEnabledAndHomed (void) const
virtual bool ValidCommand (const CommandType &command, StateType &newOperatingState, std::string &humanReadableMessage)
void SerializeRaw (std::ostream &outputStream) const override
void DeSerializeRaw (std::istream &inputStream) override
void ToStream (std::ostream &outputStream) const override
void ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const override
void Copy (const prmOperatingState &source)
bool ScalarNumberIsFixed (void) const override
size_t ScalarNumber (void) const override
Public Member Functions inherited from mtsGenericObject
 mtsGenericObject (void)
 mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
 mtsGenericObject (const mtsGenericObject &other)
virtual ~mtsGenericObject (void)
mtsGenericObject & operator= (const mtsGenericObject &other)
bool SetTimestampIfAutomatic (double timestamp)
virtual bool FromStreamRaw (std::istream &inputStream, const char delimiter=' ')
Public Member Functions inherited from cmnGenericObject
virtual ~cmnGenericObject (void)
virtual const cmnClassServicesBase * Services (void) const =0
bool ReconstructFrom (const cmnGenericObject &other)
std::string ToString (void) const
virtual cmnLogger::StreamBufType * GetLogMultiplexer (void) const
virtual double Scalar (const size_t CMN_UNUSED(index)) const CISST_THROW(std
virtual std::string ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Static Public Member Functions

static const std::vector< std::string > & StateTypeVectorString (void)
static const std::vector< std::string > & CommandTypeVectorString (void)

Public Attributes

void SerializeBinary(std::ostream &outputStream) const CISST_THROW(std void DeSerializeBinary(std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std void SerializeText(std::ostream &outputStream, const char delimiter=',') const CISST_THROW(std std::string SerializeDescription (const char delimiter=',', const std::string &userDescription="") const
void DeSerializeText(std::istream &inputStream, const char delimiter=',') CISST_THROW(std std::string HumanReadable (void) const

Static Public Attributes

static std::string static StateTypeToString(const StateType &value) CISST_THROW(std StateType static StateTypeFromString(const std::string &value) CISST_THROW(std const std::vector< int > & StateTypeVectorInt (void)
static std::string static CommandTypeToString(const CommandType &value) CISST_THROW(std CommandType static CommandTypeFromString(const std::string &value) CISST_THROW(std const std::vector< int > & CommandTypeVectorInt (void)

Protected Attributes

prmOperatingState::StateType mState
std::string mSubState
bool mIsHomed
bool mIsBusy

Member Enumeration Documentation

◆ CommandType

enum prmOperatingState::CommandType
Enumerator
enable 
disable 
pause 
resume 
home 
unhome 

◆ StateType

enum prmOperatingState::StateType
Enumerator
UNDEFINED 
DISABLED 
ENABLED 
PAUSED 
FAULT 

Constructor & Destructor Documentation

◆ prmOperatingState() [1/2]

prmOperatingState::prmOperatingState ( void )

◆ prmOperatingState() [2/2]

prmOperatingState::prmOperatingState ( const prmOperatingState & other)

◆ ~prmOperatingState()

prmOperatingState::~prmOperatingState ( )

Member Function Documentation

◆ CommandTypeVectorString()

const std::vector< std::string > & prmOperatingState::CommandTypeVectorString ( void )
static

◆ Copy()

void prmOperatingState::Copy ( const prmOperatingState & source)

◆ DeSerializeRaw()

void prmOperatingState::DeSerializeRaw ( std::istream & inputStream)
overridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

◆ GetIsBusy() [1/2]

void prmOperatingState::GetIsBusy ( bool & placeHolder) const

◆ GetIsBusy() [2/2]

bool prmOperatingState::GetIsBusy ( void ) const
inline

◆ GetIsHomed() [1/2]

void prmOperatingState::GetIsHomed ( bool & placeHolder) const

◆ GetIsHomed() [2/2]

bool prmOperatingState::GetIsHomed ( void ) const
inline

◆ GetState() [1/2]

void prmOperatingState::GetState ( prmOperatingState::StateType & placeHolder) const

◆ GetState() [2/2]

prmOperatingState::StateType prmOperatingState::GetState ( void ) const
inline

◆ GetSubState() [1/2]

void prmOperatingState::GetSubState ( std::string & placeHolder) const

◆ GetSubState() [2/2]

std::string prmOperatingState::GetSubState ( void ) const
inline

◆ IsBusy() [1/2]

bool & prmOperatingState::IsBusy ( void )

◆ IsBusy() [2/2]

const bool & prmOperatingState::IsBusy ( void ) const

◆ IsEnabledAndHomed()

bool prmOperatingState::IsEnabledAndHomed ( void ) const
inline

◆ IsEnabledHomedAndNotBusy()

bool prmOperatingState::IsEnabledHomedAndNotBusy ( void ) const
inline

◆ IsHomed() [1/2]

bool & prmOperatingState::IsHomed ( void )

◆ IsHomed() [2/2]

const bool & prmOperatingState::IsHomed ( void ) const

◆ operator=()

prmOperatingState & prmOperatingState::operator= ( const prmOperatingState & other)

◆ ScalarNumber()

size_t prmOperatingState::ScalarNumber ( void ) const
overridevirtual

Methods for data visualization. Derived classes should override the following methods in order to be properly processed by the data visualizer of the global component manager.

Return a number of data (which can be visualized, i.e., type-casted to double)

Reimplemented from mtsGenericObject.

◆ ScalarNumberIsFixed()

bool prmOperatingState::ScalarNumberIsFixed ( void ) const
overridevirtual

Indicates if this object has a fixed number of scalars. This is used for arrays of object in order to optimize random access for a given scalar. When defining an object with a fixed number of scalars, overloading this method to return true allows some optimizations.

Reimplemented from mtsGenericObject.

◆ SerializeRaw()

void prmOperatingState::SerializeRaw ( std::ostream & outputStream) const
overridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetIsBusy()

void prmOperatingState::SetIsBusy ( const bool & newValue)

◆ SetIsHomed()

void prmOperatingState::SetIsHomed ( const bool & newValue)

◆ SetState()

void prmOperatingState::SetState ( const prmOperatingState::StateType & newValue)

◆ SetSubState()

void prmOperatingState::SetSubState ( const std::string & newValue)

◆ State() [1/2]

prmOperatingState::StateType & prmOperatingState::State ( void )

◆ State() [2/2]

const prmOperatingState::StateType & prmOperatingState::State ( void ) const

◆ StateTypeVectorString()

const std::vector< std::string > & prmOperatingState::StateTypeVectorString ( void )
static

◆ SubState() [1/2]

std::string & prmOperatingState::SubState ( void )

◆ SubState() [2/2]

const std::string & prmOperatingState::SubState ( void ) const

◆ ToStream()

void prmOperatingState::ToStream ( std::ostream & outputStream) const
overridevirtual

Human readable text output. This method only streams the data members of mtsGenericObject, i.e. the Timestamp and Valid flag. It should be called by any derived class re-implementing ToStream.

Reimplemented from mtsGenericObject.

◆ ToStreamRaw()

void prmOperatingState::ToStreamRaw ( std::ostream & outputStream,
const char delimiter = ' ',
bool headerOnly = false,
const std::string & headerPrefix = "" ) const
overridevirtual

Raw text output to stream

Reimplemented from mtsGenericObject.

◆ ValidCommand()

virtual bool prmOperatingState::ValidCommand ( const CommandType & command,
StateType & newOperatingState,
std::string & humanReadableMessage )
virtual

Member Data Documentation

◆ CommandTypeVectorInt

std::string static CommandTypeToString(const CommandType &value) CISST_THROW(std CommandType static CommandTypeFromString(const std::string &value) CISST_THROW(std const std::vector< int > & prmOperatingState::CommandTypeVectorInt(void)
static

◆ HumanReadable

void DeSerializeText(std::istream &inputStream, const char delimiter=',') CISST_THROW(std std::string prmOperatingState::HumanReadable(void) const

◆ mIsBusy

bool prmOperatingState::mIsBusy
protected

◆ mIsHomed

bool prmOperatingState::mIsHomed
protected

◆ mState

prmOperatingState::StateType prmOperatingState::mState
protected

◆ mSubState

std::string prmOperatingState::mSubState
protected

◆ SerializeDescription

void SerializeBinary(std::ostream &outputStream) const CISST_THROW(std void DeSerializeBinary(std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std void SerializeText(std::ostream &outputStream, const char delimiter=',') const CISST_THROW(std std::string prmOperatingState::SerializeDescription(const char delimiter=',', const std::string &userDescription="") const

◆ StateTypeVectorInt

std::string static StateTypeToString(const StateType &value) CISST_THROW(std StateType static StateTypeFromString(const std::string &value) CISST_THROW(std const std::vector< int > & prmOperatingState::StateTypeVectorInt(void)
static
The documentation for this class was generated from the following file:
Generated by doxygen 1.18.0