mtsExecutionResult Class Reference

#include <mtsExecutionResult.h>

Public Types
enum	Enum {   UNDEFINED , COMMAND_SUCCEEDED , COMMAND_QUEUED , FUNCTION_NOT_BOUND ,   COMMAND_HAS_NO_MAILBOX , COMMAND_DISABLED , INTERFACE_COMMAND_MAILBOX_FULL , COMMAND_ARGUMENT_QUEUE_FULL ,   INVALID_INPUT_TYPE , METHOD_OR_FUNCTION_FAILED , INVALID_COMMAND_ID , ARGUMENT_DYNAMIC_CREATION_FAILED ,   SERIALIZATION_ERROR , DESERIALIZATION_ERROR , NO_FINISHED_EVENT }
typedef mtsExecutionResult	ThisType

Public Member Functions
	mtsExecutionResult (void)
	mtsExecutionResult (const mtsExecutionResult &other)
mtsExecutionResult &	operator= (const mtsExecutionResult &other)
	~mtsExecutionResult ()
void	GetValue (mtsExecutionResult::Enum &placeHolder) const
mtsExecutionResult::Enum	GetValue (void) const
void	SetValue (const mtsExecutionResult::Enum &newValue)
const mtsExecutionResult::Enum &	Value (void) const
mtsExecutionResult::Enum &	Value (void)
const ThisType &	operator= (const Enum &value)
bool	operator== (const ThisType &state) const
bool	operator!= (const ThisType &state) const
Enum	GetResult (void) const
bool	IsOK (void) const
	operator bool (void) const
	mtsExecutionResult (const mtsExecutionResult::Enum &newValue)
void	SerializeRaw (std::ostream &outputStream) const
void	DeSerializeRaw (std::istream &inputStream)
void	ToStream (std::ostream &outputStream) const
void	ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const
void	Copy (const mtsExecutionResult &source)
bool	ScalarNumberIsFixed (void) const
size_t	ScalarNumber (void) const

Static Public Member Functions
static const std::vector< std::string > &	EnumVectorString (void)
static const std::string	ToString (const Enum &value)

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 EnumToString(const Enum &value) CISST_THROW(std Enum static EnumFromString(const std::string &value) CISST_THROW(std const std::vector< int > &	EnumVectorInt (void)

Protected Attributes
mtsExecutionResult::Enum	mValue

Member Typedef Documentation

ThisType

typedef mtsExecutionResult mtsExecutionResult::ThisType

Member Enumeration Documentation

Enum

enum mtsExecutionResult::Enum

Enumerator
UNDEFINED
COMMAND_SUCCEEDED
COMMAND_QUEUED
FUNCTION_NOT_BOUND
COMMAND_HAS_NO_MAILBOX
COMMAND_DISABLED
INTERFACE_COMMAND_MAILBOX_FULL
COMMAND_ARGUMENT_QUEUE_FULL
INVALID_INPUT_TYPE
METHOD_OR_FUNCTION_FAILED
INVALID_COMMAND_ID
ARGUMENT_DYNAMIC_CREATION_FAILED
SERIALIZATION_ERROR
DESERIALIZATION_ERROR
NO_FINISHED_EVENT

Constructor & Destructor Documentation

mtsExecutionResult() [1/3]

mtsExecutionResult::mtsExecutionResult

(

void

)

mtsExecutionResult() [2/3]

mtsExecutionResult::mtsExecutionResult

(

const mtsExecutionResult &

other

)

~mtsExecutionResult()

mtsExecutionResult::~mtsExecutionResult

(

)

mtsExecutionResult() [3/3]

mtsExecutionResult::mtsExecutionResult

(

const mtsExecutionResult::Enum &

newValue

)

Member Function Documentation

Copy()

void mtsExecutionResult::Copy

(

const mtsExecutionResult &

source

)

DeSerializeRaw()

void mtsExecutionResult::DeSerializeRaw

(

std::istream &

inputStream

)

EnumVectorString()

const std::vector< std::string > & mtsExecutionResult::EnumVectorString ( void )

static

GetResult()

Enum mtsExecutionResult::GetResult ( void ) const

inline

Getter of current state (for backward compatibility)

GetValue() [1/2]

void mtsExecutionResult::GetValue

(

mtsExecutionResult::Enum &

placeHolder

)

const

GetValue() [2/2]

mtsExecutionResult::Enum mtsExecutionResult::GetValue ( void ) const

inline

IsOK()

bool mtsExecutionResult::IsOK

(

void

)

const

Test if the result is considered OK

operator bool()

mtsExecutionResult::operator bool

(

void

)

const

Downcast to bool to allow code such as if (!myFunction) { ... }

operator!=()

bool mtsExecutionResult::operator!=

(

const ThisType &

state

)

const

operator=() [1/2]

const ThisType & mtsExecutionResult::operator=

(

const Enum &

value

)

Assignment operator.

operator=() [2/2]

mtsExecutionResult & mtsExecutionResult::operator=

(

const mtsExecutionResult &

other

)

operator==()

bool mtsExecutionResult::operator==

(

const ThisType &

state

)

const

Equality operators

ScalarNumber()

size_t mtsExecutionResult::ScalarNumber

(

void

)

const

ScalarNumberIsFixed()

bool mtsExecutionResult::ScalarNumberIsFixed

(

void

)

const

SerializeRaw()

void mtsExecutionResult::SerializeRaw

(

std::ostream &

outputStream

)

const

SetValue()

void mtsExecutionResult::SetValue

(

const mtsExecutionResult::Enum &

newValue

)

ToStream()

void mtsExecutionResult::ToStream

(

std::ostream &

outputStream

)

const

ToStreamRaw()

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

ToString()

const std::string mtsExecutionResult::ToString ( const Enum & value )

static

Get a human readable description for any state (for backward compatibility)

Value() [1/2]

mtsExecutionResult::Enum & mtsExecutionResult::Value

(

void

)

Value() [2/2]

const mtsExecutionResult::Enum & mtsExecutionResult::Value

(

void

)

const

Member Data Documentation

EnumVectorInt

std::string static EnumToString(const Enum &value) CISST_THROW(std Enum static EnumFromString(const std::string &value) CISST_THROW(std const std::vector< int > & mtsExecutionResult::EnumVectorInt(void)

static

HumanReadable

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

mValue

mtsExecutionResult::Enum mtsExecutionResult::mValue

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 mtsExecutionResult::SerializeDescription(const char delimiter=',', const std::string &userDescription="") const

---

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

• tmp/cisst-saw/build/cisst/include/cisstMultiTask/mtsExecutionResult.h