COPASI API  4.40.278
CLGlobalRenderInformation Class Reference

#include <CLGlobalRenderInformation.h>

Inheritance diagram for CLGlobalRenderInformation:
[legend]

Public Member Functions

void addStyle (const CLGlobalStyle *pStyle)
 
virtual bool applyData (const CData &data, CUndoData::CChangeSet &changes)
 
 CLGlobalRenderInformation (CDataContainer *pParent=NULL)
 
 CLGlobalRenderInformation (const CLGlobalRenderInformation &source, CDataContainer *pParent=NULL)
 
 CLGlobalRenderInformation (const GlobalRenderInformation &source, CDataContainer *pParent=NULL)
 
virtual CLStylecreateStyle ()
 
CDataVector< CLGlobalStyle > * getListOfStyles ()
 
const CDataVector< CLGlobalStyle > * getListOfStyles () const
 
virtual size_t getNumStyles () const
 
virtual CLStylegetStyle (size_t i)
 
virtual const CLStylegetStyle (size_t i) const
 
virtual const CLStylegetStyleForGraphicalObject (const CLGraphicalObject *pObject) const
 
virtual CData toData () const
 
bool toSBML (GlobalRenderInformation *pGRI, unsigned int level, unsigned int version) const
 
- Public Member Functions inherited from CLRenderInformationBase
void addColorDefinition (const CLColorDefinition *cd)
 
void addGradientDefinition (const CLGradientBase *gradient)
 
void addLineEnding (const CLLineEnding *le)
 
void addSBMLAttributes (RenderInformationBase *pBase) const
 
 CLRenderInformationBase (const CLRenderInformationBase &source, CDataContainer *pParent)
 
 CLRenderInformationBase (const RenderInformationBase &source, const std::string &name, CDataContainer *pParent=NULL)
 
 CLRenderInformationBase (const std::string &name, CDataContainer *pParent=NULL)
 
CLColorDefinitioncreateColorDefinition ()
 
CLLinearGradientcreateLinearGradientDefinition ()
 
CLLineEndingcreateLineEnding ()
 
CLRadialGradientcreateRadialGradientDefinition ()
 
const std::string & getBackgroundColor () const
 
CLColorDefinitiongetColorDefinition (size_t index)
 
const CLColorDefinitiongetColorDefinition (size_t index) const
 
CLGradientBasegetGradientDefinition (size_t index)
 
const CLGradientBasegetGradientDefinition (size_t index) const
 
const std::string & getKey () const
 
CLLineEndinggetLineEnding (size_t index)
 
const CLLineEndinggetLineEnding (size_t index) const
 
CDataVector< CLColorDefinition > * getListOfColorDefinitions ()
 
const CDataVector< CLColorDefinition > * getListOfColorDefinitions () const
 
CDataVector< CLGradientBase > * getListOfGradientDefinitions ()
 
const CDataVector< CLGradientBase > * getListOfGradientDefinitions () const
 
CDataVector< CLLineEnding > * getListOfLineEndings ()
 
const CDataVector< CLLineEnding > * getListOfLineEndings () const
 
const std::string & getName () const
 
size_t getNumColorDefinitions () const
 
size_t getNumGradientDefinitions () const
 
size_t getNumLineEndings () const
 
const std::string & getReferenceRenderInformationKey () const
 
void removeColorDefinition (size_t index)
 
void removeGradientDefinition (size_t index)
 
void removeLineEnding (size_t index)
 
void setBackgroundColor (const std::string &bg)
 
void setName (const std::string &name)
 
void setReferenceRenderInformationKey (const std::string &key)
 
 ~CLRenderInformationBase ()
 
- 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
 
 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 CObjectInterfacegetObject (const CCommonName &cn) const override
 
virtual objectMapgetObjects ()
 
virtual const objectMapgetObjects () const
 
virtual const std::string getUnits () const override
 
virtual const CDataObjectgetValueObject () const override
 
virtual CUndoObjectInterfaceinsert (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 void destruct () override
 
virtual CCommonName getCN () const override
 
virtual const CDataObjectgetDataObject () const override
 
CDataContainergetObjectAncestor (const std::string &type) const
 
CDataModelgetObjectDataModel () const
 
virtual std::string getObjectDisplayName () const override
 
const CObjectInterfacegetObjectFromCN (const CCommonName &cn) const
 
const std::string & getObjectName () const
 
CDataContainergetObjectParent () const
 
const std::string & getObjectType () const
 
virtual const CObjectInterface::ObjectSetgetPrerequisites () const override
 
virtual const CValiditygetValidity () 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 CLGlobalRenderInformationfromData (const CData &data, CUndoObjectInterface *pParent)
 
static std::string getTypeForObject (const CLGraphicalObject *pObject)
 
- Static Public Member Functions inherited from CDataContainer
static CDataContainerfromData (const CData &data, CUndoObjectInterface *pParent)
 
- Static Public Member Functions inherited from CDataObject
static CDataObjectfromData (const CData &data, CUndoObjectInterface *pParent)
 
static void sanitizeObjectName (std::string &name)
 
- Static Public Member Functions inherited from CObjectInterface
static const CDataObjectDataObject (const CObjectInterface *pInterface)
 
static CObjectInterfaceGetObjectFromCN (const ContainerList &listOfContainer, const CCommonName &objName)
 
- Static Public Member Functions inherited from CUndoObjectInterface
template<class CType >
static CType * fromData (const CData &, CUndoObjectInterface *)
 

Protected Attributes

CDataVector< CLGlobalStylemListOfStyles
 
- Protected Attributes inherited from CLRenderInformationBase
std::string mBackgroundColor
 
std::string mKey
 
CDataVector< CLColorDefinitionmListOfColorDefinitions
 
CDataVector< CLGradientBasemListOfGradientDefinitions
 
CDataVector< CLLineEndingmListOfLineEndings
 
std::string mName
 
std::string mReferenceRenderInformation
 
- 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
 

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

◆ CLGlobalRenderInformation() [1/3]

CLGlobalRenderInformation::CLGlobalRenderInformation ( CDataContainer pParent = NULL)

◆ CLGlobalRenderInformation() [2/3]

CLGlobalRenderInformation::CLGlobalRenderInformation ( const CLGlobalRenderInformation source,
CDataContainer pParent = NULL 
)

Copy Constructor.

Copy constructor

References CKeyFactory::add(), CRootContainer::getKeyFactory(), and CLRenderInformationBase::mKey.

◆ CLGlobalRenderInformation() [3/3]

CLGlobalRenderInformation::CLGlobalRenderInformation ( const GlobalRenderInformation &  source,
CDataContainer pParent = NULL 
)

Constructor to generate object from the corresponding SBML object.

References CDataVector< CType >::add(), CKeyFactory::add(), CRootContainer::getKeyFactory(), CLRenderInformationBase::mKey, and mListOfStyles.

Member Function Documentation

◆ addStyle()

void CLGlobalRenderInformation::addStyle ( const CLGlobalStyle pStyle)

◆ applyData()

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

Apply the provided data to the object

Parameters
constCData & data
Returns
bool success

Reimplemented from CDataContainer.

References fatalError.

◆ createStyle()

CLStyle * CLGlobalRenderInformation::createStyle ( )
virtual

Creates a new style, and adds it to the list of styles (where it is owned)

Returns
the newly created style

Implements CLRenderInformationBase.

References CDataVector< CType >::add(), and mListOfStyles.

◆ fromData()

CLGlobalRenderInformation * CLGlobalRenderInformation::fromData ( const CData data,
CUndoObjectInterface pParent 
)
static

Static method to create a CDataObject based on the provided data

Parameters
constCData & data
Returns
CLGlobalRenderInformation * pDataObject

References CLGlobalRenderInformation(), and NO_PARENT.

◆ getListOfStyles() [1/2]

CDataVector< CLGlobalStyle > * CLGlobalRenderInformation::getListOfStyles ( )

Returns a pointer to the LitOfStyles object.

References mListOfStyles.

Referenced by CLRenderFlattener::flatten().

◆ getListOfStyles() [2/2]

const CDataVector< CLGlobalStyle > * CLGlobalRenderInformation::getListOfStyles ( ) const

Returns a pointer to the LitOfStyles object.

Returns a pointer to the ListOfStyles object.

References mListOfStyles.

◆ getNumStyles()

size_t CLGlobalRenderInformation::getNumStyles ( ) const
virtual

◆ getStyle() [1/2]

CLStyle * CLGlobalRenderInformation::getStyle ( size_t  i)
virtual

Returns a pointer to the style with the given index. If the index is invalid, NULL is returned.

Implements CLRenderInformationBase.

References mListOfStyles, and CDataVector< CType >::size().

Referenced by CLRenderResolver::fill_global_maps(), CLRenderFlattener::flatten(), CCopasiXML::saveGlobalRenderInformation(), and toSBML().

◆ getStyle() [2/2]

const CLStyle * CLGlobalRenderInformation::getStyle ( size_t  i) const
virtual

Returns a pointer to the style with the given index. If the index is invalid, NULL is returned.

Implements CLRenderInformationBase.

References mListOfStyles, and CDataVector< CType >::size().

◆ getStyleForGraphicalObject()

const CLStyle * CLGlobalRenderInformation::getStyleForGraphicalObject ( const CLGraphicalObject pObject) const
virtual

Returns the style for the graphical object or NULL

Parameters
pObjectthe graphical object
Returns
the style if one is available for the object

Implements CLRenderInformationBase.

References CLGraphicalObject::getObjectRole(), getTypeForObject(), and mListOfStyles.

◆ getTypeForObject()

std::string CLGlobalRenderInformation::getTypeForObject ( const CLGraphicalObject pObject)
static

◆ toData()

CData CLGlobalRenderInformation::toData ( ) const
virtual

Retrieve the data describing the object

Returns
CData data

Reimplemented from CDataContainer.

References fatalError.

◆ toSBML()

bool CLGlobalRenderInformation::toSBML ( GlobalRenderInformation *  pGRI,
unsigned int  level,
unsigned int  version 
) const

Converts this object to the corresponding SBML object.

References CLRenderInformationBase::addSBMLAttributes(), getStyle(), mListOfStyles, and CDataVector< CType >::size().

Referenced by CSBMLExporter::exportLayout().

Member Data Documentation

◆ mListOfStyles


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