CCreator Class Reference

#include <CCreator.h>

Inheritance diagram for CCreator:

Public Member Functions
virtual bool	applyData (const CData &data, CUndoData::CChangeSet &changes)
	CCreator (const CCreator &src, const CDataContainer *pParent)
	CCreator (const CRDFTriplet &triplet, const std::string &objectName="", const CDataContainer *pParent=NO_PARENT)
	CCreator (const std::string &objectName, const CDataContainer *pParent=NO_PARENT)
virtual void	createUndoData (CUndoData &undoData, const CUndoData::Type &type, const CData &oldData=CData(), const CCore::Framework &framework=CCore::Framework::ParticleNumbers) const
virtual void	destruct ()
const std::string &	getEmail () const
const std::string &	getFamilyName () const
const std::string &	getGivenName () const
virtual const std::string &	getKey () const
const std::string &	getORG () const
const CRDFTriplet &	getTriplet () const
void	setEmail (const std::string &Email)
void	setFamilyName (const std::string &familyName)
void	setGivenName (const std::string &givenName)
void	setORG (const std::string &Orgname)
virtual CData	toData () const
	~CCreator ()
Public Member Functions inherited from CDataContainer
virtual bool	add (CDataObject *pObject, const bool &adopt=true)
virtual bool	appendDeletedDependentData (CUndoData &undoData) const
	CDataContainer (const CDataContainer &src, const CDataContainer *pParent)
	CDataContainer (const std::string &name, const CDataContainer *pParent=NO_PARENT, const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)
virtual std::string	getChildObjectUnits (const CDataObject *pObject) const
void	getDescendants (CDataObject::DataObjectSet &descendants, const bool &recursive=false) const
virtual size_t	getIndex (const CDataObject *pObject) const
virtual const CObjectInterface *	getObject (const CCommonName &cn) const override
virtual objectMap &	getObjects ()
virtual const objectMap &	getObjects () const
virtual const std::string	getUnits () const override
virtual const CDataObject *	getValueObject () const override
virtual CUndoObjectInterface *	insert (const CData &data) override
void	objectRenamed (CDataObject *pObject, const std::string &oldName)
virtual bool	remove (CDataObject *pObject)
virtual	~CDataContainer ()
Public Member Functions inherited from CDataObject
void	addIssue (const CIssue &issue)
void	addReference (const CDataContainer *pReference)
virtual void	calculateValue () override
	CDataObject (const CDataObject &src, const CDataContainer *pParent=NULL)
virtual CCommonName	getCN () const override
virtual const CDataObject *	getDataObject () const override
CDataContainer *	getObjectAncestor (const std::string &type) const
CDataModel *	getObjectDataModel () const
virtual std::string	getObjectDisplayName () const override
const CObjectInterface *	getObjectFromCN (const CCommonName &cn) const
const std::string &	getObjectName () const
CDataContainer *	getObjectParent () const
const std::string &	getObjectType () const
virtual const CObjectInterface::ObjectSet &	getPrerequisites () const override
virtual const CValidity &	getValidity () const override
virtual void *	getValuePointer () const override
bool	hasFlag (const Flag &flag) const
virtual bool	isPrerequisiteForContext (const CObjectInterface *pObject, const CCore::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const override
bool	prerequisitsContains (const DataObjectSet &objects) const
virtual void	print (std::ostream *ostream) const override
void	removeIssue (const CIssue &issue)
void	removeReference (const CDataContainer *pReference)
bool	setObjectName (const std::string &name)
virtual bool	setObjectParent (const CDataContainer *pParent)
void	validityChanged (const CValidity &changedValidity) override
void	validityRemoved (const CValidity &changedValidity)
virtual	~CDataObject ()
Public Member Functions inherited from CObjectInterface
	CObjectInterface ()
	CObjectInterface (const CObjectInterface &src)
virtual	~CObjectInterface ()
Public Member Functions inherited from CUndoObjectInterface
	CUndoObjectInterface ()
	CUndoObjectInterface (const CUndoObjectInterface &src)
bool	generateUuid ()
const xg::Guid &	getUuid () const
bool	setUuid (const std::string &uuid)
bool	setUuid (const xg::Guid &uuid)
virtual void	updateIndex (const size_t &index, const CUndoObjectInterface *pUndoObject)
virtual	~CUndoObjectInterface ()

Static Public Member Functions
static CCreator *	fromData (const CData &data, CUndoObjectInterface *pParent)
Static Public Member Functions inherited from CDataContainer
static CDataContainer *	fromData (const CData &data, CUndoObjectInterface *pParent)
Static Public Member Functions inherited from CDataObject
static CDataObject *	fromData (const CData &data, CUndoObjectInterface *pParent)
static void	sanitizeObjectName (std::string &name)
Static Public Member Functions inherited from CObjectInterface
static const CDataObject *	DataObject (const CObjectInterface *pInterface)
static CObjectInterface *	GetObjectFromCN (const ContainerList &listOfContainer, const CCommonName &objName)
Static Public Member Functions inherited from CUndoObjectInterface
template<class CType >
static CType *	fromData (const CData &, CUndoObjectInterface *)

Private Attributes
std::string	mKey
CRDFPredicate::Path	mNodePath
CRDFTriplet	mTriplet

Additional Inherited Members
Public Types inherited from CDataContainer
typedef CDataObjectMap	objectMap
Public Types inherited from CDataObject
typedef std::set< const CDataObject * >	DataObjectSet
enum	Flag {   Container , Vector , Matrix , NameVector ,   Reference , ValueBool , ValueInt , ValueInt64 ,   ValueDbl , NonUniqueName , StaticString , ValueString ,   Separator , DisplayName , ModelEntity , Array ,   DataModel , Root , Gui , __SIZE }
Public Types inherited from CObjectInterface
typedef std::vector< const CDataContainer * >	ContainerList
typedef std::set< const CObjectInterface * >	ObjectSet
Static Public Attributes inherited from CDataContainer
static const CObjectInterface::ContainerList	EmptyList
Protected Member Functions inherited from CDataContainer
template<class CType >
CDataMatrixReference< CType > *	addMatrixReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
template<class CType >
CDataObjectReference< CType > *	addObjectReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
template<class CType >
CDataVectorReference< CType > *	addVectorReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
	CDataContainer (const CDataContainer &src)
void	initObjects ()
Protected Member Functions inherited from CDataObject
	CDataObject ()
	CDataObject (const std::string &name, const CDataContainer *pParent=static_cast< CDataContainer * >((void *) 0), const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)
Protected Attributes inherited from CDataContainer
objectMap	mObjects
Protected Attributes inherited from CDataObject
ObjectSet	mPrerequisits
std::set< CDataContainer * >	mReferences
Protected Attributes inherited from CObjectInterface
CValidity	mValidity

Detailed Description

CCreators: Stores author name, email and other (vCard) details.

Constructor & Destructor Documentation

CCreator() [1/3]

CCreator::CCreator	(	const std::string &	objectName,
		const CDataContainer *	pParent = NO_PARENT
	)

Default constructor

Parameters

const	std::string & objectName
const	CDataContainer * pParent (default: NULL)

CCreator() [2/3]

CCreator::CCreator	(	const CRDFTriplet &	triplet,
		const std::string &	objectName = "",
		const CDataContainer *	pParent = NO_PARENT
	)

Specific constructor

Parameters

const	CRDFTriplet & triplet
const	std::string & objectName (default: "")
const	CDataContainer * pParent (default: NULL)

References CRDFNode::getPath(), mNodePath, mTriplet, and CRDFTriplet::pObject.

CCreator() [3/3]

CCreator::CCreator	(	const CCreator &	src,
		const CDataContainer *	pParent
	)

Copy constructor

Parameters

const	CCreator & src
const	CDataContainer * pParent (default: NULL)

~CCreator()

CCreator::~CCreator

(

)

Destructor

References CRootContainer::getKeyFactory(), mKey, and CKeyFactory::remove().

Member Function Documentation

applyData()

bool CCreator::applyData ( const CData &  data, CUndoData::CChangeSet &  changes  )

virtual

Apply the provided data to the object

Parameters

const

CData & data

Returns

bool success

Reimplemented from CDataContainer.

References CDataContainer::applyData(), CData::EMAIL, CData::FAMILY_NAME, CDataObject::getObjectAncestor(), CData::getProperty(), CData::GIVEN_NAME, CData::isSetProperty(), CData::ORGANIZATION, CMIRIAMInfo::save(), setEmail(), setFamilyName(), setGivenName(), setORG(), and CDataValue::toString().

createUndoData()

void CCreator::createUndoData ( CUndoData &  undoData, const CUndoData::Type &  type, const CData &  oldData = CData(), const CCore::Framework &  framework = CCore::Framework::ParticleNumbers  ) const

virtual

Create the undo data which represents the changes recording the differences between the provided oldData and the current data.

Parameters

CUndoData	& undoData
const	CUndoData::Type & type
const	CData & oldData (default: empty data)
const	CCore::Framework & framework (default: CCore::Framework::ParticleNumbers)

Returns

CUndoData undoData

Reimplemented from CDataContainer.

References CUndoData::addProperty(), CUndoData::CHANGE, CDataContainer::createUndoData(), CData::EMAIL, CUndoData::empty(), CData::FAMILY_NAME, getEmail(), getFamilyName(), getGivenName(), getORG(), CData::getProperty(), CData::GIVEN_NAME, CData::OBJECT_HASH, CData::OBJECT_INDEX, CData::ORGANIZATION, CUndoData::removeProperty(), and toData().

destruct()

void CCreator::destruct ( )

virtual

Destruct the object

Reimplemented from CDataObject.

References CDataObject::destruct(), CDataObject::getObjectAncestor(), CMIRIAMInfo::removeCreator(), and CMIRIAMInfo::save().

fromData()

CCreator * CCreator::fromData ( const CData &  data, CUndoObjectInterface *  pParent  )

static

Static method to create a CDataObject based on the provided data

Parameters

const

CData & data

Returns

CCreator * pDataObject

References CMIRIAMInfo::createCreator(), CDataObject::getObjectAncestor(), CData::getProperty(), CData::OBJECT_NAME, CDataContainer::remove(), and CDataValue::toString().

getEmail()

const std::string & CCreator::getEmail

(

)

const

References CRDFNode::getFieldValue(), mTriplet, CRDFTriplet::pObject, and CRDFPredicate::vcard_EMAIL.

Referenced by createUndoData(), toData(), and CSBMLExporter::updateMIRIAMAnnotation().

getFamilyName()

const std::string & CCreator::getFamilyName

(

)

const

Add the given name to Last name to get the full Name.

References CRDFNode::getFieldValue(), mTriplet, CRDFTriplet::pObject, and CRDFPredicate::vcard_Family.

Referenced by createUndoData(), toData(), and CSBMLExporter::updateMIRIAMAnnotation().

getGivenName()

const std::string & CCreator::getGivenName

(

)

const

References CRDFNode::getFieldValue(), mTriplet, CRDFTriplet::pObject, and CRDFPredicate::vcard_Given.

Referenced by createUndoData(), toData(), and CSBMLExporter::updateMIRIAMAnnotation().

getKey()

const std::string & CCreator::getKey ( ) const

virtual

Reimplemented from CDataObject.

References mKey.

getORG()

const std::string & CCreator::getORG

(

)

const

References CRDFNode::getFieldValue(), mTriplet, CRDFTriplet::pObject, and CRDFPredicate::vcard_Orgname.

Referenced by createUndoData(), toData(), and CSBMLExporter::updateMIRIAMAnnotation().

getTriplet()

const CRDFTriplet & CCreator::getTriplet

(

)

const

References mTriplet.

Referenced by CMIRIAMInfo::removeCreator().

setEmail()

void CCreator::setEmail

(

const std::string &

Email

)

References mNodePath, mTriplet, CRDFTriplet::pObject, CRDFNode::setFieldValue(), and CRDFPredicate::vcard_EMAIL.

Referenced by CMIRIAMInfo::addDefaultCreator(), and applyData().

setFamilyName()

void CCreator::setFamilyName

(

const std::string &

familyName

)

References mNodePath, mTriplet, CRDFTriplet::pObject, CRDFNode::setFieldValue(), and CRDFPredicate::vcard_Family.

Referenced by CMIRIAMInfo::addDefaultCreator(), and applyData().

setGivenName()

void CCreator::setGivenName

(

const std::string &

givenName

)

References mNodePath, mTriplet, CRDFTriplet::pObject, CRDFNode::setFieldValue(), and CRDFPredicate::vcard_Given.

Referenced by CMIRIAMInfo::addDefaultCreator(), and applyData().

setORG()

void CCreator::setORG

(

const std::string &

Orgname

)

References mNodePath, mTriplet, CRDFTriplet::pObject, CRDFNode::setFieldValue(), and CRDFPredicate::vcard_Orgname.

Referenced by CMIRIAMInfo::addDefaultCreator(), and applyData().

toData()

CData CCreator::toData ( ) const

virtual

Retrieve the data describing the object

Returns

CData data

Reimplemented from CDataContainer.

References CData::addProperty(), CData::EMAIL, CData::FAMILY_NAME, getEmail(), getFamilyName(), getGivenName(), getORG(), CData::GIVEN_NAME, CData::hash(), CData::OBJECT_HASH, CData::OBJECT_INDEX, CData::ORGANIZATION, CData::removeProperty(), and CDataContainer::toData().

Referenced by createUndoData().

Member Data Documentation

mKey

std::string CCreator::mKey

private

The key of the object needed for the COPASI tables.

Referenced by getKey(), and ~CCreator().

mNodePath

CRDFPredicate::Path CCreator::mNodePath

private

The predicate path to the node.

Referenced by CCreator(), setEmail(), setFamilyName(), setGivenName(), and setORG().

mTriplet

CRDFTriplet CCreator::mTriplet

private

Triplet in the RDF graph representing the reference.

Referenced by CCreator(), getEmail(), getFamilyName(), getGivenName(), getORG(), getTriplet(), setEmail(), setFamilyName(), setGivenName(), and setORG().

---

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

• CCreator.h
• CCreator.cpp