mtsDescriptionInterface Class Reference

#include <mtsParameterTypes.h>

Public Member Functions
	mtsDescriptionInterface (void)
	mtsDescriptionInterface (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)
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	ProcessName
std::string	ComponentName
std::vector< std::string >	InterfaceRequiredNames
std::vector< std::string >	InterfaceProvidedNames

Constructor & Destructor Documentation

mtsDescriptionInterface::mtsDescriptionInterface

(

void

)

mtsDescriptionInterface::mtsDescriptionInterface

(

const mtsDescriptionInterface &

other

)

mtsDescriptionInterface::~mtsDescriptionInterface

(

)

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

void mtsDescriptionInterface::Copy

(

const mtsDescriptionInterface &

source

)

void mtsDescriptionInterface::DeSerializeBinary	(	std::istream &	inputStream,
		const cmnDataFormat &	localFormat,
		const cmnDataFormat &	remoteFormat
	)
throw	(	std::runtime_error
	)

void mtsDescriptionInterface::DeSerializeRaw

(

std::istream &

inputStream

)

void mtsDescriptionInterface::DeSerializeText	(	std::istream &	inputStream,
		const char	delimiter = ','
	)
throw	(	std::runtime_error
	)

std::string mtsDescriptionInterface::HumanReadable

(

void

)

const

double mtsDescriptionInterface::Scalar	(	const size_t	index	)	const
throw	(	std::out_of_range
	)

std::string mtsDescriptionInterface::ScalarDescription	(	const size_t	index,
		const std::string &	userDescription = ""
	)		const
throw	(	std::out_of_range
	)

size_t mtsDescriptionInterface::ScalarNumber

(

void

)

const

bool mtsDescriptionInterface::ScalarNumberIsFixed

(

void

)

const

void mtsDescriptionInterface::SerializeBinary	(	std::ostream &	outputStream	)	const
throw	(	std::runtime_error
	)

std::string mtsDescriptionInterface::SerializeDescription	(	const char	delimiter = ',',
		const std::string &	userDescription = ""
	)		const

void mtsDescriptionInterface::SerializeRaw

(

std::ostream &

outputStream

)

const

void mtsDescriptionInterface::SerializeText	(	std::ostream &	outputStream,
		const char	delimiter = ','
	)		const
throw	(	std::runtime_error
	)

void mtsDescriptionInterface::ToStream

(

std::ostream &

outputStream

)

const

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

Member Data Documentation

std::string mtsDescriptionInterface::ComponentName

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

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

std::string mtsDescriptionInterface::ProcessName

---

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

• /home/adeguet1/catkin_ws/build_release/cisst/include/cisstMultiTask/mtsParameterTypes.h