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

#include <mtsInterfaceCommon.h>

Public Member Functions

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

Public Attributes

std::string InterfaceName
mtsCommandPointerNames FunctionVoidNames
mtsCommandPointerNames FunctionWriteNames
mtsCommandPointerNames FunctionReadNames
mtsCommandPointerNames FunctionQualifiedReadNames
mtsCommandPointerNames FunctionVoidReturnNames
mtsCommandPointerNames FunctionWriteReturnNames
mtsEventHandlersVoidDescription EventHandlersVoid
mtsEventHandlersWriteDescription EventHandlersWrite
bool IsRequired
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

◆ mtsInterfaceRequiredDescription() [1/2]

mtsInterfaceRequiredDescription::mtsInterfaceRequiredDescription ( void )

◆ mtsInterfaceRequiredDescription() [2/2]

mtsInterfaceRequiredDescription::mtsInterfaceRequiredDescription ( const mtsInterfaceRequiredDescription & other)

◆ ~mtsInterfaceRequiredDescription()

mtsInterfaceRequiredDescription::~mtsInterfaceRequiredDescription ( )

Member Function Documentation

◆ Copy()

void mtsInterfaceRequiredDescription::Copy ( const mtsInterfaceRequiredDescription & source)

◆ DeSerializeRaw()

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

◆ operator=()

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

◆ ScalarNumber()

size_t mtsInterfaceRequiredDescription::ScalarNumber ( void ) const

◆ ScalarNumberIsFixed()

bool mtsInterfaceRequiredDescription::ScalarNumberIsFixed ( void ) const

◆ SerializeRaw()

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

◆ ToStream()

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

◆ ToStreamRaw()

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

Member Data Documentation

◆ EventHandlersVoid

mtsEventHandlersVoidDescription mtsInterfaceRequiredDescription::EventHandlersVoid

◆ EventHandlersWrite

mtsEventHandlersWriteDescription mtsInterfaceRequiredDescription::EventHandlersWrite

◆ FunctionQualifiedReadNames

mtsCommandPointerNames mtsInterfaceRequiredDescription::FunctionQualifiedReadNames

◆ FunctionReadNames

mtsCommandPointerNames mtsInterfaceRequiredDescription::FunctionReadNames

◆ FunctionVoidNames

mtsCommandPointerNames mtsInterfaceRequiredDescription::FunctionVoidNames

◆ FunctionVoidReturnNames

mtsCommandPointerNames mtsInterfaceRequiredDescription::FunctionVoidReturnNames

◆ FunctionWriteNames

mtsCommandPointerNames mtsInterfaceRequiredDescription::FunctionWriteNames

◆ FunctionWriteReturnNames

mtsCommandPointerNames mtsInterfaceRequiredDescription::FunctionWriteReturnNames

◆ HumanReadable

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

◆ InterfaceName

std::string mtsInterfaceRequiredDescription::InterfaceName

◆ IsRequired

bool mtsInterfaceRequiredDescription::IsRequired

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

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