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

#include <mtsParameterTypes.h>

Public Member Functions

 mtsDescriptionComponentClass (void)
 
 mtsDescriptionComponentClass (const mtsDescriptionComponentClass &other)
 
 ~mtsDescriptionComponentClass ()
 
 mtsDescriptionComponentClass (const std::string &newClassName, const std::string &newArgType, const std::string &newArgTypeId)
 
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 mtsDescriptionComponentClass &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 ClassName
 
std::string ArgType
 
std::string ArgTypeId
 

Constructor & Destructor Documentation

mtsDescriptionComponentClass::mtsDescriptionComponentClass ( void  )
mtsDescriptionComponentClass::mtsDescriptionComponentClass ( const mtsDescriptionComponentClass other)
mtsDescriptionComponentClass::~mtsDescriptionComponentClass ( )
mtsDescriptionComponentClass::mtsDescriptionComponentClass ( const std::string &  newClassName,
const std::string &  newArgType,
const std::string &  newArgTypeId 
)

Member Function Documentation

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

Member Data Documentation

std::string mtsDescriptionComponentClass::ArgType
std::string mtsDescriptionComponentClass::ArgTypeId
std::string mtsDescriptionComponentClass::ClassName

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