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, NETWORK_ERROR, 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 ()
void	GetValue (mtsExecutionResult::Enum &placeHolder) 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)
void	SerializeBinary (std::ostream &outputStream) const throw (std::runtime_error)
void	DeSerializeBinary (std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) throw (std::runtime_error)
void	SerializeText (std::ostream &outputStream, const char delimiter= ',') const throw (std::runtime_error)
std::string	SerializeDescription (const char delimiter= ',', const std::string &userDescription="") const
void	DeSerializeText (std::istream &inputStream, const char delimiter= ',') throw (std::runtime_error)
std::string	HumanReadable (void) const
bool	ScalarNumberIsFixed (void) const
size_t	ScalarNumber (void) const
double	Scalar (const size_t index) const throw (std::out_of_range)
std::string	ScalarDescription (const size_t index, const std::string &userDescription="") const throw (std::out_of_range)

Static Public Member Functions
static std::string	EnumToString (const Enum &value) throw (std::runtime_error)
static Enum	EnumFromString (const std::string &value) throw (std::runtime_error)
static const std::string	ToString (const Enum &value)

Protected Attributes
mtsExecutionResult::Enum	mValue

Member Typedef Documentation

typedef mtsExecutionResult mtsExecutionResult::ThisType

Member Enumeration Documentation

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
NETWORK_ERROR
INVALID_COMMAND_ID
ARGUMENT_DYNAMIC_CREATION_FAILED
SERIALIZATION_ERROR
DESERIALIZATION_ERROR
NO_FINISHED_EVENT

Constructor & Destructor Documentation

mtsExecutionResult::mtsExecutionResult

(

void

)

mtsExecutionResult::mtsExecutionResult

(

const mtsExecutionResult &

other

)

mtsExecutionResult::~mtsExecutionResult

(

)

mtsExecutionResult::mtsExecutionResult

(

const mtsExecutionResult::Enum &

newValue

)

Member Function Documentation

void mtsExecutionResult::Copy

(

const mtsExecutionResult &

source

)

void mtsExecutionResult::DeSerializeBinary	(	std::istream &	inputStream,
		const cmnDataFormat &	localFormat,
		const cmnDataFormat &	remoteFormat
	)
throw	(	std::runtime_error
	)

void mtsExecutionResult::DeSerializeRaw

(

std::istream &

inputStream

)

void mtsExecutionResult::DeSerializeText	(	std::istream &	inputStream,
		const char	delimiter = ','
	)
throw	(	std::runtime_error
	)

static Enum mtsExecutionResult::EnumFromString ( const std::string &  value ) throw ( std::runtime_error )

static

static std::string mtsExecutionResult::EnumToString ( const Enum &  value ) throw ( std::runtime_error )

static

Enum mtsExecutionResult::GetResult ( void  ) const

inline

Getter of current state (for backward compatibility)

void mtsExecutionResult::GetValue

(

mtsExecutionResult::Enum &

placeHolder

)

const

std::string mtsExecutionResult::HumanReadable

(

void

)

const

bool mtsExecutionResult::IsOK

(

void

)

const

Test if the result is considered OK

mtsExecutionResult::operator bool

(

void

)

const

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

bool mtsExecutionResult::operator!=

(

const ThisType &

state

)

const

const ThisType& mtsExecutionResult::operator=

(

const Enum &

value

)

Assignment operator.

bool mtsExecutionResult::operator==

(

const ThisType &

state

)

const

Equality operators

double mtsExecutionResult::Scalar	(	const size_t	index	)	const
throw	(	std::out_of_range
	)

std::string mtsExecutionResult::ScalarDescription	(	const size_t	index,
		const std::string &	userDescription = ""
	)		const
throw	(	std::out_of_range
	)

size_t mtsExecutionResult::ScalarNumber

(

void

)

const

bool mtsExecutionResult::ScalarNumberIsFixed

(

void

)

const

void mtsExecutionResult::SerializeBinary	(	std::ostream &	outputStream	)	const
throw	(	std::runtime_error
	)

std::string mtsExecutionResult::SerializeDescription	(	const char	delimiter = ',',
		const std::string &	userDescription = ""
	)		const

void mtsExecutionResult::SerializeRaw

(

std::ostream &

outputStream

)

const

void mtsExecutionResult::SerializeText	(	std::ostream &	outputStream,
		const char	delimiter = ','
	)		const
throw	(	std::runtime_error
	)

void mtsExecutionResult::SetValue

(

const mtsExecutionResult::Enum &

newValue

)

void mtsExecutionResult::ToStream

(

std::ostream &

outputStream

)

const

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

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

static

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

const mtsExecutionResult::Enum& mtsExecutionResult::Value

(

void

)

const

mtsExecutionResult::Enum& mtsExecutionResult::Value

(

void

)

Member Data Documentation

mtsExecutionResult::Enum mtsExecutionResult::mValue

protected

---

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

• /home/adeguet1/catkin_ws/build_release/cisst/include/cisstMultiTask/mtsExecutionResult.h