mtsDescriptionConnection Class Reference

#include <mtsParameterTypes.h>

Public Member Functions
	mtsDescriptionConnection (void)
	mtsDescriptionConnection (const mtsDescriptionConnection &other)
	~mtsDescriptionConnection ()
	mtsDescriptionConnection (const std::string &clientProcessName, const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName, const ConnectionIDType connectionId=InvalidConnectionID)
void	Init (void)
	mtsDescriptionConnection (const mtsDescriptionIntefaceFullName &newClient, const mtsDescriptionIntefaceFullName &newServer, const ConnectionIDType &newConnectionID)
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 mtsDescriptionConnection &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
mtsDescriptionIntefaceFullName	Client
mtsDescriptionIntefaceFullName	Server
ConnectionIDType	ConnectionID

Constructor & Destructor Documentation

mtsDescriptionConnection::mtsDescriptionConnection

(

void

)

mtsDescriptionConnection::mtsDescriptionConnection

(

const mtsDescriptionConnection &

other

)

mtsDescriptionConnection::~mtsDescriptionConnection

(

)

mtsDescriptionConnection::mtsDescriptionConnection	(	const std::string &	clientProcessName,
		const std::string &	clientComponentName,
		const std::string &	clientInterfaceRequiredName,
		const std::string &	serverProcessName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceProvidedName,
		const ConnectionIDType	connectionId = InvalidConnectionID
	)

mtsDescriptionConnection::mtsDescriptionConnection	(	const mtsDescriptionIntefaceFullName &	newClient,
		const mtsDescriptionIntefaceFullName &	newServer,
		const ConnectionIDType &	newConnectionID
	)

Member Function Documentation

void mtsDescriptionConnection::Copy

(

const mtsDescriptionConnection &

source

)

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

void mtsDescriptionConnection::DeSerializeRaw

(

std::istream &

inputStream

)

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

std::string mtsDescriptionConnection::HumanReadable

(

void

)

const

void mtsDescriptionConnection::Init

(

void

)

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

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

size_t mtsDescriptionConnection::ScalarNumber

(

void

)

const

bool mtsDescriptionConnection::ScalarNumberIsFixed

(

void

)

const

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

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

void mtsDescriptionConnection::SerializeRaw

(

std::ostream &

outputStream

)

const

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

void mtsDescriptionConnection::ToStream

(

std::ostream &

outputStream

)

const

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

Member Data Documentation

mtsDescriptionIntefaceFullName mtsDescriptionConnection::Client

ConnectionIDType mtsDescriptionConnection::ConnectionID

mtsDescriptionIntefaceFullName mtsDescriptionConnection::Server

---

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

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