makArchives::DtSchemaParameter Class Reference

The makArchives::DtSchemaParameter contains a parameter that will be used as part of a schema entry definition. More...

List of all members.

Public Types
enum	ParameterType {   Enumeration = 0, FileName = 1, FloatingPoint = 2, Integer = 3,   Any = 4, StringVector = 5, String = 6, Boolean = 7,   Vector = 8, Double = 9, Color = 10, FontGlyph = 11,   SymbolSelector = 12 }
	Enumeration of possible parameter types This type is used to encode/decode as strings. More...
Public Member Functions
	DtSchemaParameter ()
	CTOR.
	DtSchemaParameter (const DtSchemaParameter &)
	Copy CTOR.
virtual	~DtSchemaParameter ()
	DTOR.
virtual DtSchemaParameter &	operator= (const DtSchemaParameter &)
	Assignment Operator.
void	setName (const std::string &name)
	Accessors.
const std::string &	name () const
	Accessors.
void	setRequired (bool b)
	Accessors.
bool	required () const
	Accessors.
void	setEnumerationValues (const std::vector< std::string > &val)
	Accessors.
const std::vector< std::string > &	enumerationValues () const
	Accessors.
void	setDescription (const std::string &d)
	Accessors.
const std::string &	description () const
	Accessors.
void	setType (ParameterType t)
	Accessors.
ParameterType	type () const
	Accessors.
Protected Member Functions
template<typename Archive >
void	serialize (Archive &ar, unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<.
Protected Attributes
std::string	myName
ParameterType	myType
bool	myRequiredFlag
std::vector< std::string >	myEnumerationValues
std::string	myDescription
Friends
class	boost::serialization::access

---

Detailed Description

The makArchives::DtSchemaParameter contains a parameter that will be used as part of a schema entry definition.

---

Member Enumeration Documentation

enum makArchives::DtSchemaParameter::ParameterType

Enumeration of possible parameter types This type is used to encode/decode as strings.

Enumerator:

Enumeration
FileName
FloatingPoint
Integer
Any
StringVector
String
Boolean
Vector
Double
Color
FontGlyph
SymbolSelector

---

Constructor & Destructor Documentation

makArchives::DtSchemaParameter::DtSchemaParameter

(

)

CTOR.

makArchives::DtSchemaParameter::DtSchemaParameter

(

const DtSchemaParameter &

)

Copy CTOR.

virtual makArchives::DtSchemaParameter::~DtSchemaParameter

(

)

[virtual]

DTOR.

---

Member Function Documentation

virtual DtSchemaParameter& makArchives::DtSchemaParameter::operator=

(

const DtSchemaParameter &

)

[virtual]

Assignment Operator.

void makArchives::DtSchemaParameter::setName

(

const std::string &

name

)

[inline]

Accessors.

const std::string& makArchives::DtSchemaParameter::name

(

void

)

const [inline]

Accessors.

void makArchives::DtSchemaParameter::setRequired

(

bool

b

)

[inline]

Accessors.

bool makArchives::DtSchemaParameter::required

(

)

const [inline]

Accessors.

void makArchives::DtSchemaParameter::setEnumerationValues

(

const std::vector< std::string > &

val

)

[inline]

Accessors.

const std::vector<std::string>& makArchives::DtSchemaParameter::enumerationValues

(

)

const [inline]

Accessors.

void makArchives::DtSchemaParameter::setDescription

(

const std::string &

d

)

[inline]

Accessors.

const std::string& makArchives::DtSchemaParameter::description

(

)

const [inline]

Accessors.

void makArchives::DtSchemaParameter::setType

(

ParameterType

t

)

[inline]

Accessors.

ParameterType makArchives::DtSchemaParameter::type

(

void

)

const [inline]

Accessors.

template<typename Archive >

void makArchives::DtSchemaParameter::serialize	(	Archive &	ar,
		unsigned int	version
	)		[inline, protected]

When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

---

Friends And Related Function Documentation

friend class boost::serialization::access [friend]

---

Member Data Documentation

std::string makArchives::DtSchemaParameter::myName [protected]

ParameterType makArchives::DtSchemaParameter::myType [protected]

bool makArchives::DtSchemaParameter::myRequiredFlag [protected]

std::vector<std::string> makArchives::DtSchemaParameter::myEnumerationValues [protected]

std::string makArchives::DtSchemaParameter::myDescription [protected]

---

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

• include/makArchives/DtSchemaParameter.h