makArchives::DtSchema Class Reference

Collection of DtSchemaEntry objects Used to archive model definition schemas.

Public Types
typedef std::vector < DtSchemaEntry >	SchemaEntries

Public Member Functions
	DtSchema ()
	DtSchema (const std::string &name)
	DtSchema (const DtSchema &copy)
virtual	~DtSchema ()
DtSchema &	operator= (const DtSchema &copy)
const std::string &	name () const
void	setName (const std::string &n)
virtual void	addSchemaEntry (const DtSchemaEntry &entry)
virtual bool	removeSchemaEntry (const std::string &name)
const SchemaEntries &	schemaEntries () const
void	clear ()
void	setSchemaEntries (const SchemaEntries &e)
DtSchemaEntry *	findSchemaEntry (const std::string &name)
const DtSchemaEntry *	findSchemaEntry (const std::string &name) const
virtual void	merge (const DtSchema &rhs)
virtual bool	renameSchemaEntry (const std::string &oldName, const std::string &newName)

Protected Member Functions
template<typename Archive >
void	serialize (Archive &ar, unsigned int version)

Static Protected Member Functions
static bool	findSchemaEntryFunction (const DtSchemaEntry &parameter, const std::string &name)

Protected Attributes
std::string	myName
SchemaEntries	mySchemaEntries

Friends
class	boost::serialization::access

Member Typedef Documentation

typedef std::vector<DtSchemaEntry> makArchives::DtSchema::SchemaEntries

Constructor & Destructor Documentation

makArchives::DtSchema::DtSchema

(

)

CTOR.

makArchives::DtSchema::DtSchema

(

const std::string &

name

)

CTOR.

makArchives::DtSchema::DtSchema

(

const DtSchema &

copy

)

CopyCTOR.

virtual makArchives::DtSchema::~DtSchema ( )

virtual

DTOR.

Member Function Documentation

DtSchema& makArchives::DtSchema::operator=

(

const DtSchema &

copy

)

Assignment Op.

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

inline

Get the schema's name.

void makArchives::DtSchema::setName ( const std::string &  n )

inline

Get the schema's name.

virtual void makArchives::DtSchema::addSchemaEntry ( const DtSchemaEntry &  entry )

virtual

Add a schema entry.

virtual bool makArchives::DtSchema::removeSchemaEntry ( const std::string &  name )

virtual

Remove a schema entry. Returns whether the entry was removed successfully.

const SchemaEntries& makArchives::DtSchema::schemaEntries ( ) const

inline

Get the schema entries.

void makArchives::DtSchema::clear ( )

inline

Clear the schema entries.

void makArchives::DtSchema::setSchemaEntries ( const SchemaEntries &  e )

inline

Set the schema entries.

DtSchemaEntry* makArchives::DtSchema::findSchemaEntry

(

const std::string &

name

)

a schema entry by name. Warning\ the pointer will be invalid if you perform any Additions or Removals.

const DtSchemaEntry* makArchives::DtSchema::findSchemaEntry

(

const std::string &

name

)

const

virtual void makArchives::DtSchema::merge ( const DtSchema &  rhs )

virtual

Merges contents of supplied schema into this one. Merge will replace existing schemas with schemas of like names or add new schemas that do not exist. Will not delete schemas that do not exist in supplied schema.

virtual bool makArchives::DtSchema::renameSchemaEntry ( const std::string &  oldName, const std::string &  newName  )

virtual

Renames the schema to the new name. Returns true if schema is renamed.

template<typename Archive >

void makArchives::DtSchema::serialize ( Archive &  ar, unsigned int  version  )

inlineprotected

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::DtSchema::findSchemaEntryFunction ( const DtSchemaEntry &  parameter, const std::string &  name  )

staticprotected

Predicate for finding a schema entry in a collection.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Member Data Documentation

std::string makArchives::DtSchema::myName

protected

SchemaEntries makArchives::DtSchema::mySchemaEntries

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/makArchives/DtSchema.h