mtsDescriptionComponent Class Reference

#include <mtsParameterTypes.h>

Public Member Functions
	mtsDescriptionComponent (void)
	mtsDescriptionComponent (const mtsDescriptionComponent &other)
mtsDescriptionComponent &	operator= (const mtsDescriptionComponent &other)
	~mtsDescriptionComponent ()
	mtsDescriptionComponent (const std::string &processName, const std::string &componentName, const std::set< std::string > &tags=std::set< std::string >())
	mtsDescriptionComponent (const std::string &newProcessName, const std::string &newComponentName, const std::string &newClassName, const std::string &newConstructorArgSerialized, const std::set< std::string > &newTags)
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 mtsDescriptionComponent &source)
bool	ScalarNumberIsFixed (void) const
size_t	ScalarNumber (void) const

Public Attributes
std::string	ProcessName
std::string	ComponentName
std::string	ClassName
std::string	ConstructorArgSerialized
std::set< std::string >	Tags
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

mtsDescriptionComponent() [1/4]

mtsDescriptionComponent::mtsDescriptionComponent

(

void

)

mtsDescriptionComponent() [2/4]

mtsDescriptionComponent::mtsDescriptionComponent

(

const mtsDescriptionComponent &

other

)

~mtsDescriptionComponent()

mtsDescriptionComponent::~mtsDescriptionComponent

(

)

mtsDescriptionComponent() [3/4]

mtsDescriptionComponent::mtsDescriptionComponent	(	const std::string &	processName,
		const std::string &	componentName,
		const std::set< std::string > &	tags = std::set< std::string >() )

mtsDescriptionComponent() [4/4]

mtsDescriptionComponent::mtsDescriptionComponent	(	const std::string &	newProcessName,
		const std::string &	newComponentName,
		const std::string &	newClassName,
		const std::string &	newConstructorArgSerialized,
		const std::set< std::string > &	newTags )

Member Function Documentation

Copy()

void mtsDescriptionComponent::Copy

(

const mtsDescriptionComponent &

source

)

DeSerializeRaw()

void mtsDescriptionComponent::DeSerializeRaw

(

std::istream &

inputStream

)

operator=()

mtsDescriptionComponent & mtsDescriptionComponent::operator=

(

const mtsDescriptionComponent &

other

)

ScalarNumber()

size_t mtsDescriptionComponent::ScalarNumber

(

void

)

const

ScalarNumberIsFixed()

bool mtsDescriptionComponent::ScalarNumberIsFixed

(

void

)

const

SerializeRaw()

void mtsDescriptionComponent::SerializeRaw

(

std::ostream &

outputStream

)

const

ToStream()

void mtsDescriptionComponent::ToStream

(

std::ostream &

outputStream

)

const

ToStreamRaw()

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

Member Data Documentation

ClassName

std::string mtsDescriptionComponent::ClassName

ComponentName

std::string mtsDescriptionComponent::ComponentName

ConstructorArgSerialized

std::string mtsDescriptionComponent::ConstructorArgSerialized

HumanReadable

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

ProcessName

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

Tags

std::set<std::string> mtsDescriptionComponent::Tags

---

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

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