COPASI API  4.40.278
CLGradientStop Class Reference

#include <CLGradientStop.h>

Inheritance diagram for CLGradientStop:

Public Member Functions

virtual bool applyData (const CData &data, CUndoData::CChangeSet &changes)
 CLGradientStop (CDataContainer *pParent=NULL)
 CLGradientStop (const CLGradientStop &source, CDataContainer *pParent=NULL)
 CLGradientStop (const GradientStop &source, CDataContainer *pParent=NULL)
const std::string & getKey () const
const CLRelAbsVectorgetOffset () const
const std::string & getStopColor () const
void setOffset (const CLRelAbsVector &co)
void setOffset (const std::string &)
void setOffset (double x, double y)
void setStopColor (const std::string &key)
virtual CData toData () const
GradientStop * toSBML (unsigned int level, unsigned int version) const
virtual ~CLGradientStop ()
- 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 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 createUndoData (CUndoData &undoData, const CUndoData::Type &type, const CData &oldData=CData(), const CCore::Framework &framework=CCore::Framework::ParticleNumbers) const override
virtual void destruct () override
virtual CCommonName getCN () const override
virtual const CDataObjectgetDataObject () const override
virtual const CObjectInterfacegetObject (const CCommonName &cn) 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 std::string getUnits () const
virtual const CValiditygetValidity () const override
virtual const CDataObjectgetValueObject () const
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
virtual CUndoObjectInterfaceinsert (const CData &data)
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 CLGradientStopfromData (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

std::string mKey
CLRelAbsVector mOffset
std::string mStopColor
- Protected Attributes inherited from CLBase
std::string mTag
- Protected Attributes inherited from CDataObject
ObjectSet mPrerequisits
std::set< CDataContainer * > mReferences
- Protected Attributes inherited from CObjectInterface
CValidity mValidity

Private Member Functions

CLGradientStopoperator= (const CLGradientStop &source)

Additional Inherited Members

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

◆ CLGradientStop() [1/3]

CLGradientStop::CLGradientStop ( CDataContainer pParent = NULL)


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

Referenced by fromData().

◆ CLGradientStop() [2/3]

CLGradientStop::CLGradientStop ( const CLGradientStop source,
CDataContainer pParent = NULL 

Copy Constructor

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

◆ CLGradientStop() [3/3]

CLGradientStop::CLGradientStop ( const GradientStop &  source,
CDataContainer pParent = NULL 

Constructor to generate object from the corresponding SBML object.

Copy Constructor

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

◆ ~CLGradientStop()

CLGradientStop::~CLGradientStop ( )

Virtual destructor to satify the linker.

Virtual destructor to satify the linker. Does nothing , is only in the source file to help the compiler in determining where to put the vtable.

Member Function Documentation

◆ applyData()

bool CLGradientStop::applyData ( const CData data,
CUndoData::CChangeSet changes 

Apply the provided data to the object

constCData & data
bool success

Reimplemented from CDataObject.

References fatalError.

◆ fromData()

CLGradientStop * CLGradientStop::fromData ( const CData data,
CUndoObjectInterface pParent 

Static method to create a CDataObject based on the provided data

constCData & data
CLGradientStop * pDataObject

References CLGradientStop(), and NO_PARENT.

◆ getKey()

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

Returns the key of the color definition.

Reimplemented from CDataObject.

References mKey.

◆ getOffset()

const CLRelAbsVector & CLGradientStop::getOffset ( ) const

◆ getStopColor()

const std::string & CLGradientStop::getStopColor ( ) const

◆ operator=()

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

◆ setOffset() [1/3]

void CLGradientStop::setOffset ( const CLRelAbsVector co)

Sets the offset.

References mOffset.

◆ setOffset() [2/3]

void CLGradientStop::setOffset ( const std::string &  co)

Sets the offset.

References mOffset.

◆ setOffset() [3/3]

void CLGradientStop::setOffset ( double  x,
double  y 

Sets the offset.

References mOffset.

Referenced by GradientStopHandler::processStart().

◆ setStopColor()

void CLGradientStop::setStopColor ( const std::string &  key)

Sets the stop color id.

Sets the stop color key.

References mStopColor.

Referenced by GradientStopHandler::processStart().

◆ toData()

CData CLGradientStop::toData ( ) const

Retrieve the data describing the object

CData data

Reimplemented from CDataObject.

References fatalError.

◆ toSBML()

GradientStop * CLGradientStop::toSBML ( unsigned int  level,
unsigned int  version 
) const

Converts this object to the corresponding SBML object.

References mOffset, mStopColor, and CLRelAbsVector::toSBML().

Member Data Documentation

◆ mKey

std::string CLGradientStop::mKey

key string for the gradient stop.

Referenced by CLGradientStop(), and getKey().

◆ mOffset

CLRelAbsVector CLGradientStop::mOffset

Referenced by getOffset(), setOffset(), and toSBML().

◆ mStopColor

std::string CLGradientStop::mStopColor

Referenced by getStopColor(), setStopColor(), and toSBML().

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