mtsDescriptionInterface Class Reference

#include <mtsParameterTypes.h>

Public Member Functions
	mtsDescriptionInterface (void)
	mtsDescriptionInterface (const mtsDescriptionInterface &other)
mtsDescriptionInterface &	operator= (const mtsDescriptionInterface &other)
	~mtsDescriptionInterface ()
	mtsDescriptionInterface (const std::string &newProcessName, const std::string &newComponentName, const std::vector< std::string > &newInterfaceRequiredNames, const std::vector< std::string > &newInterfaceProvidedNames)
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 mtsDescriptionInterface &source)
bool	ScalarNumberIsFixed (void) const
size_t	ScalarNumber (void) const

Public Attributes
std::string	ProcessName
std::string	ComponentName
std::vector< std::string >	InterfaceRequiredNames
std::vector< std::string >	InterfaceProvidedNames
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

mtsDescriptionInterface() [1/3]

mtsDescriptionInterface::mtsDescriptionInterface

(

void

)

mtsDescriptionInterface() [2/3]

mtsDescriptionInterface::mtsDescriptionInterface

(

const mtsDescriptionInterface &

other

)

~mtsDescriptionInterface()

mtsDescriptionInterface::~mtsDescriptionInterface

(

)

mtsDescriptionInterface() [3/3]

mtsDescriptionInterface::mtsDescriptionInterface	(	const std::string &	newProcessName,
		const std::string &	newComponentName,
		const std::vector< std::string > &	newInterfaceRequiredNames,
		const std::vector< std::string > &	newInterfaceProvidedNames )

Member Function Documentation

Copy()

void mtsDescriptionInterface::Copy

(

const mtsDescriptionInterface &

source

)

DeSerializeRaw()

void mtsDescriptionInterface::DeSerializeRaw

(

std::istream &

inputStream

)

operator=()

mtsDescriptionInterface & mtsDescriptionInterface::operator=

(

const mtsDescriptionInterface &

other

)

ScalarNumber()

size_t mtsDescriptionInterface::ScalarNumber

(

void

)

const

ScalarNumberIsFixed()

bool mtsDescriptionInterface::ScalarNumberIsFixed

(

void

)

const

SerializeRaw()

void mtsDescriptionInterface::SerializeRaw

(

std::ostream &

outputStream

)

const

ToStream()

void mtsDescriptionInterface::ToStream

(

std::ostream &

outputStream

)

const

ToStreamRaw()

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

Member Data Documentation

ComponentName

std::string mtsDescriptionInterface::ComponentName

HumanReadable

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

InterfaceProvidedNames

std::vector<std::string> mtsDescriptionInterface::InterfaceProvidedNames

InterfaceRequiredNames

std::vector<std::string> mtsDescriptionInterface::InterfaceRequiredNames

ProcessName

std::string mtsDescriptionInterface::ProcessName

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

---

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

• tmp/cisst-saw/build/cisst/include/cisstMultiTask/mtsParameterTypes.h