#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 CLRelAbsVector &	getOffset () 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 CDataObject *	getDataObject () const override

virtual const CObjectInterface *	getObject (const CCommonName &cn) 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 std::string	getUnits () const

virtual const CValidity &	getValidity () const override

virtual const CDataObject *	getValueObject () 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 CUndoObjectInterface *	insert (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 CLGradientStop *	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

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
CLGradientStop &	operator= (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 )

Constructor.

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

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
	)

virtual

Apply the provided data to the object

Parameters

const CData & data

Returns: bool success

Reimplemented from CDataObject.

References fatalError.

◆ fromData()

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

static

Static method to create a CDataObject based on the provided data

Parameters

const CData & data

Returns: CLGradientStop * pDataObject

References CLGradientStop(), and NO_PARENT.

◆ getKey()

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

virtual

Returns the key of the color definition.

Reimplemented from CDataObject.

References mKey.

◆ getOffset()

const CLRelAbsVector & CLGradientStop::getOffset ( ) const

Returns the offset.

References mOffset.

Referenced by CLGradientStops::CLGradientStops(), CLLayoutRenderer::map_gradient_color(), and CCopasiXML::saveGradientStop().

◆ getStopColor()

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

Returns the stop color id.

References mStopColor.

Referenced by CLGradientStops::CLGradientStops(), CLLayoutRenderer::map_gradient_color(), CCopasiXML::saveGradientStop(), and CLLayoutRenderer::update_colors().

◆ operator=()

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

private

◆ 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

virtual

Retrieve the data describing the object

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

protected

key string for the gradient stop.

Referenced by CLGradientStop(), and getKey().

◆ mOffset

CLRelAbsVector CLGradientStop::mOffset

protected

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

◆ mStopColor

std::string CLGradientStop::mStopColor

protected

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

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

◆ CLGradientStop() [1/3]

◆ CLGradientStop() [2/3]

◆ CLGradientStop() [3/3]

◆ ~CLGradientStop()

Member Function Documentation

◆ applyData()

◆ fromData()

◆ getKey()

◆ getOffset()

◆ getStopColor()

◆ operator=()

◆ setOffset() [1/3]

◆ setOffset() [2/3]

◆ setOffset() [3/3]

◆ setStopColor()

◆ toData()

◆ toSBML()

Member Data Documentation

◆ mKey

◆ mOffset

◆ mStopColor