The makArchives::DtSchemaEntry class is a collection of makArchives::DtSchemaParameter objects. More...

Public Types
typedef std::vector < DtSchemaParameter >	DtSchemaParameters
Public Member Functions
	DtSchemaEntry ()
	CTOR.
	DtSchemaEntry (const std::string &name)
	CTOR.
	DtSchemaEntry (const DtSchemaEntry &copy)
	CopyCTOR.
	~DtSchemaEntry ()
	DTOR.
DtSchemaEntry &	operator= (const DtSchemaEntry &copy)
	Assignment Op.
const std::string &	name () const
	get the schema's name.
void	setName (const std::string &n)
	set the schema's name.
virtual void	addParameter (const DtSchemaParameter &parameter)
	Add a parameter.
virtual bool	removeSchemaParameter (const std::string name)
	Remove a schema parameter.
const DtSchemaParameters &	schemaParameters () const
	Get the collection of schema parameters.
virtual bool	renameParameter (const std::string &oldName, const std::string &newName)
	Renames parameter from old to new name. Returns true if renamed.
DtSchemaParameter *	findSchemaParameter (const std::string name)
	a schema parameter by name.
const DtSchemaParameter *	findSchemaParameter (const std::string name) const
	a schema parameter by name.
Static Public Member Functions
static const DtSchemaEntry &	defaultInstance ()
	Returns a schema entry instance containing default required parameters.
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 <<.
Static Protected Member Functions
static bool	findSchemaFunction (const DtSchemaParameter &parameter, const std::string &name)
	predicate for finding a schema in a collection
Protected Attributes
std::string	myName
DtSchemaParameters	myParameters
Friends
class	boost::serialization::access

Detailed Description

The makArchives::DtSchemaEntry class is a collection of makArchives::DtSchemaParameter objects.

A schema entry will make up a DtSchema and will be written out as part of that class

Member Typedef Documentation

typedef std::vector<DtSchemaParameter> makArchives::DtSchemaEntry::DtSchemaParameters

Constructor & Destructor Documentation

makArchives::DtSchemaEntry::DtSchemaEntry ( )

CTOR.

makArchives::DtSchemaEntry::DtSchemaEntry ( const std::string & name )

CTOR.

makArchives::DtSchemaEntry::DtSchemaEntry ( const DtSchemaEntry & copy )

CopyCTOR.

makArchives::DtSchemaEntry::~DtSchemaEntry ( )

DTOR.

Member Function Documentation

static const DtSchemaEntry& makArchives::DtSchemaEntry::defaultInstance ( ) [static]

Returns a schema entry instance containing default required parameters.

DtSchemaEntry& makArchives::DtSchemaEntry::operator= ( const DtSchemaEntry & copy )

Assignment Op.

const std::string& makArchives::DtSchemaEntry::name ( void ) const [inline]

get the schema's name.

void makArchives::DtSchemaEntry::setName ( const std::string & n ) [inline]

set the schema's name.

virtual void makArchives::DtSchemaEntry::addParameter ( const DtSchemaParameter & parameter ) [virtual]

Add a parameter.

virtual bool makArchives::DtSchemaEntry::removeSchemaParameter ( const std::string name ) [virtual]

Remove a schema parameter.

Returns whether the parameter was removed successfully.

const DtSchemaParameters& makArchives::DtSchemaEntry::schemaParameters ( ) const [inline]

Get the collection of schema parameters.

virtual bool makArchives::DtSchemaEntry::renameParameter	(	const std::string &	oldName,
		const std::string &	newName
	)		`[virtual]`

Renames parameter from old to new name. Returns true if renamed.

DtSchemaParameter* makArchives::DtSchemaEntry::findSchemaParameter ( const std::string name )

a schema parameter by name.

Warning\ the pointer will be invalid if you perform any Additions or Removals.

const DtSchemaParameter* makArchives::DtSchemaEntry::findSchemaParameter ( const std::string name ) const

a schema parameter by name.

Warning\ the pointer will be invalid if you perform any Additions or Removals.

template<typename Archive >

void makArchives::DtSchemaEntry::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 >>.

static bool makArchives::DtSchemaEntry::findSchemaFunction	(	const DtSchemaParameter &	parameter,
		const std::string &	name
	)		`[static, protected]`

predicate for finding a schema in a collection

Friends And Related Function Documentation

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

Member Data Documentation

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

DtSchemaParameters makArchives::DtSchemaEntry::myParameters [protected]

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

include/makArchives/DtSchemaEntry.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions