prmKeyValue Class Reference

#include <prmKeyValue.h>

Public Member Functions
	prmKeyValue (void)
	prmKeyValue (const prmKeyValue &other)
prmKeyValue &	operator= (const prmKeyValue &other)
	~prmKeyValue ()
	prmKeyValue (const std::string &newKey, const std::string &newValue)
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 prmKeyValue &source)
bool	ScalarNumberIsFixed (void) const
size_t	ScalarNumber (void) const

Public Attributes
std::string	Key
std::string	Value
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

prmKeyValue() [1/3]

prmKeyValue::prmKeyValue

(

void

)

prmKeyValue() [2/3]

prmKeyValue::prmKeyValue

(

const prmKeyValue &

other

)

~prmKeyValue()

prmKeyValue::~prmKeyValue

(

)

prmKeyValue() [3/3]

prmKeyValue::prmKeyValue	(	const std::string &	newKey,
		const std::string &	newValue )

Member Function Documentation

Copy()

void prmKeyValue::Copy

(

const prmKeyValue &

source

)

DeSerializeRaw()

void prmKeyValue::DeSerializeRaw

(

std::istream &

inputStream

)

operator=()

prmKeyValue & prmKeyValue::operator=

(

const prmKeyValue &

other

)

ScalarNumber()

size_t prmKeyValue::ScalarNumber

(

void

)

const

ScalarNumberIsFixed()

bool prmKeyValue::ScalarNumberIsFixed

(

void

)

const

SerializeRaw()

void prmKeyValue::SerializeRaw

(

std::ostream &

outputStream

)

const

ToStream()

void prmKeyValue::ToStream

(

std::ostream &

outputStream

)

const

ToStreamRaw()

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

Member Data Documentation

HumanReadable

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

Key

std::string prmKeyValue::Key

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

Value

std::string prmKeyValue::Value

---

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

• tmp/cisst-saw/build/cisst/include/cisstParameterTypes/prmKeyValue.h