#include <CLStyle.h>

Inheritance diagram for CLStyle:

Public Member Functions
void	addRole (const std::string &role)

void	addSBMLAttributes (Style *pStyle) const

void	addType (const std::string &type)

virtual int	appliesTo (const CLGraphicalObject *pObject) const

	CLStyle (const CLStyle &source, CDataContainer *pParent=NULL)

	CLStyle (const std::string &name, CDataContainer *pParent=NULL)

	CLStyle (const Style &source, const std::string &name, CDataContainer *pParent=NULL)

CLGroup *	getGroup ()

const CLGroup *	getGroup () const

const std::string &	getKey () const

size_t	getNumRoles () const

size_t	getNumTypes () const

const std::set< std::string > &	getRoleList () const

std::string	getRoleListString () const

const std::set< std::string > &	getTypeList () const

std::string	getTypeListString () const

bool	isInRoleList (const std::string &role) const

bool	isInTypeList (const std::string &type) const

void	removeRole (const std::string &role)

void	removeType (const std::string &type)

void	setGroup (const CLGroup *pGroup)

void	setRoleList (const std::set< std::string > &roleList)

void	setTypeList (const std::set< std::string > &typeList)

	~CLStyle ()

Public Member Functions inherited from CLBase
	CLBase ()

	CLBase (const CLBase &b)

	CLBase (const SBase &)

const std::string &	getTag () const

bool	hasTag () const

virtual void	moveBy (const CLPoint &)

void	setTag (const std::string &tag)

virtual	~CLBase ()

Public Member Functions inherited from CDataContainer
virtual bool	add (CDataObject *pObject, const bool &adopt=true)

virtual bool	appendDeletedDependentData (CUndoData &undoData) const

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

	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 void	createUndoData (CUndoData &undoData, const CUndoData::Type &type, const CData &oldData=CData(), const CCore::Framework &framework=CCore::Framework::ParticleNumbers) const override

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 CData	toData () const override

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 void	destruct () override

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 std::string	createStringFromSet (const std::set< std::string > &set)

static void	readIntoSet (const std::string &s, std::set< std::string > &set)

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 *)

Protected Attributes
std::string	mKey

CLGroup *	mpGroup

std::set< std::string >	mRoleList

std::set< std::string >	mTypeList

Protected Attributes inherited from CLBase
std::string	mTag

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

Private Member Functions
CLStyle &	operator= (const CLStyle &source)

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)

Constructor & Destructor Documentation

◆ CLStyle() [1/3]

CLStyle::CLStyle	(	const std::string &	name,
		CDataContainer *	pParent = `NULL`
	)

Constructor.

◆ CLStyle() [2/3]

CLStyle::CLStyle	(	const CLStyle &	source,
		CDataContainer *	pParent = `NULL`
	)

Copy Constructor.

References mpGroup.

◆ CLStyle() [3/3]

CLStyle::CLStyle	(	const Style &	source,
		const std::string &	name,
		CDataContainer *	pParent = `NULL`
	)

Constructor to generate object from the corresponding SBML object.

References createStringFromSet(), and readIntoSet().

◆ ~CLStyle()

CLStyle::~CLStyle ( )

Destructor

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

Member Function Documentation

◆ addRole()

void CLStyle::addRole ( const std::string & role )

Adds an role to the role list.

References mRoleList.

◆ addSBMLAttributes()

void CLStyle::addSBMLAttributes ( Style * pStyle ) const

Adds the attributes for a style object to the passed in. object.

References createStringFromSet(), mpGroup, mRoleList, mTypeList, readIntoSet(), and CLGroup::toSBML().

Referenced by CLGlobalStyle::toSBML(), and CLLocalStyle::toSBML().

◆ addType()

void CLStyle::addType ( const std::string & type )

Adds a type to the type list.

Adds an type to the type list.

References mTypeList.

◆ appliesTo()

int CLStyle::appliesTo ( const CLGraphicalObject * pObject ) const

virtual

Checks whether the style applies to the graphical object

Parameters

pObject the object to check

Returns: 0, if the style does not apply, 1 if it applies by type, 2 if it applies by role

Reimplemented in CLLocalStyle.

References CLGraphicalObject::getObjectRole(), CDataObject::getObjectType(), isInRoleList(), and isInTypeList().

Referenced by CLLocalStyle::appliesTo().

◆ createStringFromSet()

std::string CLStyle::createStringFromSet ( const std::set< std::string > & set )

static

Referenced by addSBMLAttributes(), CLLocalStyle::CLLocalStyle(), CLStyle(), getRoleListString(), getTypeListString(), CCopasiXML::saveLocalStyle(), CCopasiXML::saveStyleAttributes(), and CLLocalStyle::toSBML().

◆ getGroup() [1/2]

CLGroup * CLStyle::getGroup ( )

Returns the group.

References mpGroup.

◆ getGroup() [2/2]

const CLGroup * CLStyle::getGroup ( ) const

Returns the group.

References mpGroup.

Referenced by CLRenderFlattener::convertGlobalToLocalStyle(), CLLayoutRenderer::draw_object(), CLLayoutRenderer::draw_text(), CLLayoutRenderer::extract_group_attributes(), and CCopasiXML::saveStyleElements().

◆ getKey()

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

virtual

Returns the key of the style

Reimplemented from CDataObject.

References mKey.

Referenced by CCopasiXML::saveStyleAttributes().

◆ getNumRoles()

size_t CLStyle::getNumRoles ( ) const

Returns the number of roles in the role list.

Returns the number roles ids in the role list.

References mRoleList.

Referenced by CCopasiXML::saveStyleAttributes().

◆ getNumTypes()

size_t CLStyle::getNumTypes ( ) const

Returns the number of types in the type list.

References mTypeList.

Referenced by CCopasiXML::saveStyleAttributes().

◆ getRoleList()

const std::set< std::string > & CLStyle::getRoleList ( ) const

Returns the role list.

References mRoleList.

Referenced by CLRenderFlattener::convertGlobalToLocalStyle(), CLRenderResolver::fill_global_maps(), CLRenderResolver::fill_local_maps(), CLRenderFlattener::flatten(), and CCopasiXML::saveStyleAttributes().

◆ getRoleListString()

std::string CLStyle::getRoleListString ( ) const

Returns: the roles as string

References createStringFromSet(), and mRoleList.

◆ getTypeList()

const std::set< std::string > & CLStyle::getTypeList ( ) const

Returns the type list.

References mTypeList.

Referenced by CLRenderFlattener::convertGlobalToLocalStyle(), CLRenderResolver::fill_global_maps(), CLRenderResolver::fill_local_maps(), CLRenderFlattener::flatten(), and CCopasiXML::saveStyleAttributes().

◆ getTypeListString()

std::string CLStyle::getTypeListString ( ) const

Returns: the types in the type list as string

References createStringFromSet(), and mTypeList.

◆ isInRoleList()

bool CLStyle::isInRoleList ( const std::string & role ) const

Checks whether a given role is in the role list.

References mRoleList.

Referenced by appliesTo().

◆ isInTypeList()

bool CLStyle::isInTypeList ( const std::string & type ) const

Checks whether a given type is in the type list.

References mTypeList.

Referenced by appliesTo().

◆ operator=()

CLStyle& CLStyle::operator= ( const CLStyle & source )

private

◆ readIntoSet()

void CLStyle::readIntoSet	(	const std::string &	s,
		std::set< std::string > &	set
	)

static

Referenced by addSBMLAttributes(), CLLocalStyle::CLLocalStyle(), CLStyle(), StyleHandler::processStart(), and CLLocalStyle::toSBML().

◆ removeRole()

void CLStyle::removeRole ( const std::string & role )

Removes a role from the role list.

Removes an role from the role list.

References mRoleList.

◆ removeType()

void CLStyle::removeType ( const std::string & type )

Removes an type from the type list.

References mTypeList.

◆ setGroup()

void CLStyle::setGroup ( const CLGroup * pGroup )

Sets the group.

References mpGroup.

Referenced by CLRenderFlattener::convertGlobalToLocalStyle(), and StyleHandler::processEnd().

◆ setRoleList()

void CLStyle::setRoleList ( const std::set< std::string > & roleList )

Sets the role list.

References mRoleList.

Referenced by CLRenderFlattener::convertGlobalToLocalStyle(), and StyleHandler::processStart().

◆ setTypeList()

void CLStyle::setTypeList ( const std::set< std::string > & typeList )

Sets the type list.

References mTypeList.

Referenced by CLRenderFlattener::convertGlobalToLocalStyle(), and StyleHandler::processStart().

Member Data Documentation

◆ mKey

std::string CLStyle::mKey

protected

key string for the style.

Referenced by CLGlobalStyle::CLGlobalStyle(), CLLocalStyle::CLLocalStyle(), getKey(), and ~CLStyle().

◆ mpGroup

CLGroup* CLStyle::mpGroup

protected

Referenced by addSBMLAttributes(), CLStyle(), getGroup(), and setGroup().

◆ mRoleList

std::set<std::string> CLStyle::mRoleList

protected

Referenced by addRole(), addSBMLAttributes(), getNumRoles(), getRoleList(), getRoleListString(), isInRoleList(), removeRole(), and setRoleList().

◆ mTypeList

std::set<std::string> CLStyle::mTypeList

protected

Referenced by addSBMLAttributes(), addType(), getNumTypes(), getTypeList(), getTypeListString(), isInTypeList(), removeType(), and setTypeList().

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ CLStyle() [1/3]

◆ CLStyle() [2/3]

◆ CLStyle() [3/3]

◆ ~CLStyle()

Member Function Documentation

◆ addRole()

◆ addSBMLAttributes()

◆ addType()

◆ appliesTo()

◆ createStringFromSet()

◆ getGroup() [1/2]

◆ getGroup() [2/2]

◆ getKey()

◆ getNumRoles()

◆ getNumTypes()

◆ getRoleList()

◆ getRoleListString()

◆ getTypeList()

◆ getTypeListString()

◆ isInRoleList()

◆ isInTypeList()

◆ operator=()

◆ readIntoSet()

◆ removeRole()

◆ removeType()

◆ setGroup()

◆ setRoleList()

◆ setTypeList()

Member Data Documentation

◆ mKey

◆ mpGroup

◆ mRoleList

◆ mTypeList