cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
mtsCommandReadDescription Class Reference

#include <mtsInterfaceCommon.h>

Public Member Functions

 mtsCommandReadDescription (void)
 
 mtsCommandReadDescription (const mtsCommandReadDescription &other)
 
 ~mtsCommandReadDescription ()
 
 mtsCommandReadDescription (const std::string &newName, const std::string &newArgumentPrototypeSerialized)
 
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 mtsCommandReadDescription &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)
 

Public Attributes

std::string Name
 
std::string ArgumentPrototypeSerialized
 

Constructor & Destructor Documentation

mtsCommandReadDescription::mtsCommandReadDescription ( void  )
mtsCommandReadDescription::mtsCommandReadDescription ( const mtsCommandReadDescription other)
mtsCommandReadDescription::~mtsCommandReadDescription ( )
mtsCommandReadDescription::mtsCommandReadDescription ( const std::string &  newName,
const std::string &  newArgumentPrototypeSerialized 
)

Member Function Documentation

void mtsCommandReadDescription::Copy ( const mtsCommandReadDescription source)
void mtsCommandReadDescription::DeSerializeBinary ( std::istream &  inputStream,
const cmnDataFormat localFormat,
const cmnDataFormat remoteFormat 
)
throw (std::runtime_error
)
void mtsCommandReadDescription::DeSerializeRaw ( std::istream &  inputStream)
void mtsCommandReadDescription::DeSerializeText ( std::istream &  inputStream,
const char  delimiter = ',' 
)
throw (std::runtime_error
)
std::string mtsCommandReadDescription::HumanReadable ( void  ) const
double mtsCommandReadDescription::Scalar ( const size_t  index) const
throw (std::out_of_range
)
std::string mtsCommandReadDescription::ScalarDescription ( const size_t  index,
const std::string &  userDescription = "" 
) const
throw (std::out_of_range
)
size_t mtsCommandReadDescription::ScalarNumber ( void  ) const
bool mtsCommandReadDescription::ScalarNumberIsFixed ( void  ) const
void mtsCommandReadDescription::SerializeBinary ( std::ostream &  outputStream) const
throw (std::runtime_error
)
std::string mtsCommandReadDescription::SerializeDescription ( const char  delimiter = ',',
const std::string &  userDescription = "" 
) const
void mtsCommandReadDescription::SerializeRaw ( std::ostream &  outputStream) const
void mtsCommandReadDescription::SerializeText ( std::ostream &  outputStream,
const char  delimiter = ',' 
) const
throw (std::runtime_error
)
void mtsCommandReadDescription::ToStream ( std::ostream &  outputStream) const
void mtsCommandReadDescription::ToStreamRaw ( std::ostream &  outputStream,
const char  delimiter = ' ',
bool  headerOnly = false,
const std::string &  headerPrefix = "" 
) const

Member Data Documentation

std::string mtsCommandReadDescription::ArgumentPrototypeSerialized
std::string mtsCommandReadDescription::Name

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