cisst-saw
Loading...
Searching...
No Matches
mtsCommandWriteDescription Class Reference

#include <mtsInterfaceCommon.h>

Public Member Functions

 mtsCommandWriteDescription (void)
 mtsCommandWriteDescription (const mtsCommandWriteDescription &other)
mtsCommandWriteDescriptionoperator= (const mtsCommandWriteDescription &other)
 ~mtsCommandWriteDescription ()
 mtsCommandWriteDescription (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 mtsCommandWriteDescription &source)
bool ScalarNumberIsFixed (void) const
size_t ScalarNumber (void) const

Public Attributes

std::string Name
std::string ArgumentPrototypeSerialized
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

Constructor & Destructor Documentation

◆ mtsCommandWriteDescription() [1/3]

mtsCommandWriteDescription::mtsCommandWriteDescription ( void )

◆ mtsCommandWriteDescription() [2/3]

mtsCommandWriteDescription::mtsCommandWriteDescription ( const mtsCommandWriteDescription & other)

◆ ~mtsCommandWriteDescription()

mtsCommandWriteDescription::~mtsCommandWriteDescription ( )

◆ mtsCommandWriteDescription() [3/3]

mtsCommandWriteDescription::mtsCommandWriteDescription ( const std::string & newName,
const std::string & newArgumentPrototypeSerialized )

Member Function Documentation

◆ Copy()

void mtsCommandWriteDescription::Copy ( const mtsCommandWriteDescription & source)

◆ DeSerializeRaw()

void mtsCommandWriteDescription::DeSerializeRaw ( std::istream & inputStream)

◆ operator=()

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

◆ ScalarNumber()

size_t mtsCommandWriteDescription::ScalarNumber ( void ) const

◆ ScalarNumberIsFixed()

bool mtsCommandWriteDescription::ScalarNumberIsFixed ( void ) const

◆ SerializeRaw()

void mtsCommandWriteDescription::SerializeRaw ( std::ostream & outputStream) const

◆ ToStream()

void mtsCommandWriteDescription::ToStream ( std::ostream & outputStream) const

◆ ToStreamRaw()

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

Member Data Documentation

◆ ArgumentPrototypeSerialized

std::string mtsCommandWriteDescription::ArgumentPrototypeSerialized

◆ HumanReadable

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

◆ Name

std::string mtsCommandWriteDescription::Name

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

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