CPlotSpecification Class Reference

#include <CPlotSpecification.h>

Inheritance diagram for CPlotSpecification:

Public Member Functions
void	addTaskType (const CTaskEnum::Task &type)
bool	appliesTo (const CCopasiTask *pTask) const
bool	appliesTo (const CObjectInterface::ContainerList &list) const
virtual bool	applyData (const CData &data, CUndoData::CChangeSet &changes)
virtual void	cleanup ()
	CPlotSpecification (const CPlotSpecification &src, const CDataContainer *pParent)
	CPlotSpecification (const std::string &name="NoName", const CDataContainer *pParent=NO_PARENT, const CPlotItem::Type &type=plot2d)
bool	createDefaultPlot (const CModel *model)
CPlotItem *	createItem (const std::string &name, CPlotItem::Type type)
CDataVector< CPlotItem > &	getItems ()
const CDataVector< CPlotItem > &	getItems () const
std::string	getTaskTypes () const
bool	has3D () const
bool	hasItem (const std::string &name)
const bool &	isActive () const
bool	isLogX () const
bool	isLogY () const
void	setActive (const bool &active)
void	setLogX (bool l)
void	setLogY (bool l)
void	setTaskTypes (const std::set< CTaskEnum::Task > &taskTypes)
void	setTaskTypes (const std::string &taskTypes)
virtual CData	toData () const
virtual	~CPlotSpecification ()
Public Member Functions inherited from CPlotItem
void	addChannel (const CPlotDataChannelSpec &channel)
void	cleanup ()
	CPlotItem (const CPlotItem &src, const CDataContainer *pParent)
	CPlotItem (const std::string &name="NoName", const CDataContainer *pParent=NO_PARENT, const Type &type=curve2d)
const COutputInterface::Activity &	getActivity () const
std::vector< CPlotDataChannelSpec > &	getChannels ()
const std::vector< CPlotDataChannelSpec > &	getChannels () const
size_t	getNumChannels () const
const std::string &	getTitle () const
const CPlotItem::Type &	getType () const
void	setActivity (const COutputInterface::Activity &activity)
void	setTitle (const std::string &title)
void	setType (CPlotItem::Type type)
virtual	~CPlotItem ()
Public Member Functions inherited from CCopasiParameterGroup
bool	addGroup (const std::string &name)
void	addParameter (CCopasiParameter *pParameter)
bool	addParameter (const CCopasiParameter &parameter)
bool	addParameter (const std::string &name, const CCopasiParameter::Type type, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)
template<class CType >
bool	addParameter (const std::string &name, const CCopasiParameter::Type type, const CType &value, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)
CCopasiParameterGroup *	assertGroup (const std::string &name, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)
template<class CType >
CType *	assertParameter (const std::string &name, const CCopasiParameter::Type type, const CType &defaultValue, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)
index_iterator	beginIndex () const
const_name_iterator	beginName () const
	CCopasiParameterGroup (const CCopasiParameterGroup &src, const CDataContainer *pParent=NULL)
	CCopasiParameterGroup (const std::string &name, const CDataContainer *pParent=NO_PARENT, const std::string &objectType="ParameterGroup")
void	clear ()
virtual void	createUndoData (CUndoData &undoData, const CUndoData::Type &type, const CData &oldData=CData(), const CCore::Framework &framework=CCore::Framework::ParticleNumbers) const
virtual bool	elevateChildren ()
index_iterator	endIndex () const
const_name_iterator	endName () const
CCopasiParameterGroup &	getElementTemplates ()
const CCopasiParameterGroup &	getElementTemplates () const
CCopasiParameterGroup *	getGroup (const size_t &index)
const CCopasiParameterGroup *	getGroup (const size_t &index) const
CCopasiParameterGroup *	getGroup (const std::string &name)
const CCopasiParameterGroup *	getGroup (const std::string &name) const
virtual size_t	getIndex (const CDataObject *pObject) const
size_t	getIndex (const std::string &name) const
std::string	getKey (const size_t &index) const
std::string	getKey (const std::string &name) const
virtual const std::string &	getName (const size_t &index) const
virtual const CObjectInterface *	getObject (const CCommonName &cn) const
CCopasiParameter *	getParameter (const size_t &index)
const CCopasiParameter *	getParameter (const size_t &index) const
CCopasiParameter *	getParameter (std::string name)
const CCopasiParameter *	getParameter (std::string name) const
CCopasiParameter::Type	getType (const size_t &index) const
CCopasiParameter::Type	getType (const std::string &name) const
std::string	getUniqueParameterName (const CCopasiParameter *pParameter) const
template<class CType >
CType &	getValue (const size_t &index)
template<class CType >
const CType &	getValue (const size_t &index) const
template<class CType >
CType &	getValue (const std::string &name)
template<class CType >
const CType &	getValue (const std::string &name) const
bool	haveTemplate () const
virtual CUndoObjectInterface *	insert (const CData &data)
CCopasiParameterGroup &	operator= (const CCopasiParameterGroup &rhs)
virtual void	print (std::ostream *ostream) const
virtual bool	remove (CDataObject *pObject)
bool	removeParameter (CCopasiParameter *pParameter)
bool	removeParameter (const size_t &index)
bool	removeParameter (const std::string &name)
virtual void	setUserInterfaceFlag (const UserInterfaceFlag &flag)
template<class CType >
bool	setValue (const size_t &index, const CType &value)
template<class CType >
bool	setValue (const std::string &name, const CType &value)
size_t	size (const UserInterfaceFlag &require=UserInterfaceFlag::None, const UserInterfaceFlag &exclude=UserInterfaceFlag::None) const
bool	swap (const size_t &iFrom, const size_t &iTo)
bool	swap (index_iterator &from, index_iterator &to)
virtual void	updateIndex (const size_t &index, const CUndoObjectInterface *pUndoObject)
virtual	~CCopasiParameterGroup ()
Public Member Functions inherited from CCopasiParameter
	CCopasiParameter (const CCopasiParameter &src, const CDataContainer *pParent)
	CCopasiParameter (const std::string &name, const Type &type, const void *pValue=NULL, const CDataContainer *pParent=NO_PARENT, const std::string &objectType="Parameter")
virtual CCommonName	getCN () const override
template<class CType >
const CType &	getDefault () const
virtual const std::string &	getKey () const override
virtual std::string	getObjectDisplayName () const override
const CCopasiParameter::Type &	getType () const
const UserInterfaceFlag &	getUserInterfaceFlag () const
template<class CType >
std::vector< std::pair< CType, CType > > &	getValidValues ()
template<class CType >
const std::vector< std::pair< CType, CType > > &	getValidValues () const
void *	getValidValuesPointer () const
template<class CType >
CType &	getValue ()
template<class CType >
const CType &	getValue () const
virtual void *	getValuePointer () const override
CDataObject *	getValueReference () const
bool	hasValidValues () const
bool	isBasic () const
bool	isDefault () const
bool	isEditable () const
bool	isUnsupported () const
bool	isValidValue (const bool &value) const
bool	isValidValue (const C_FLOAT64 &value) const
bool	isValidValue (const C_INT32 &value) const
bool	isValidValue (const CCommonName &value) const
template<class CType >
bool	isValidValue (const CType &) const
bool	isValidValue (const std::string &value) const
bool	isValidValue (const std::vector< CCopasiParameter * > &value) const
bool	isValidValue (const unsigned C_INT32 &value) const
CCopasiParameter &	operator= (const CCopasiParameter &rhs)
template<class CType >
bool	setDefault (const CType &defaultValue)
bool	setDefault (const std::vector< CCopasiParameter * > &defaultValue)
virtual bool	setObjectParent (const CDataContainer *pParent) override
template<class CType , class Enum >
bool	setValidValues (const CEnumAnnotation< CType, Enum > &validValues)
template<class CType >
bool	setValidValues (const std::vector< std::pair< CType, CType > > &validValues)
template<class CType >
bool	setValue (const CType &value)
bool	setValue (const std::vector< CCopasiParameter * > &value)
virtual	~CCopasiParameter ()
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 objectMap &	getObjects ()
virtual const objectMap &	getObjects () const
virtual const std::string	getUnits () const override
virtual const CDataObject *	getValueObject () const override
void	objectRenamed (CDataObject *pObject, const std::string &oldName)
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 const CDataObject *	getDataObject () const override
CDataContainer *	getObjectAncestor (const std::string &type) const
CDataModel *	getObjectDataModel () const
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
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
void	removeIssue (const CIssue &issue)
void	removeReference (const CDataContainer *pReference)
bool	setObjectName (const std::string &name)
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	~CUndoObjectInterface ()

Static Public Member Functions
static CPlotSpecification *	fromData (const CData &data, CUndoObjectInterface *pParent)
Static Public Member Functions inherited from CPlotItem
static CPlotItem *	fromData (const CData &data, CUndoObjectInterface *pParent)
Static Public Member Functions inherited from CCopasiParameter
static void	allocateValidValues (const Type &type, void *&pValidValues)
static void	allocateValue (const Type &type, void *&pValue)
static void	assignValue (const Type &type, void *&pValue, const void *pNewValue)
static void	deleteValidValues (const Type &type, void *&pValidValues)
static void	deleteValue (const Type &type, void *&pValue)
static CCopasiParameter *	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 *)

Protected Member Functions
	CPlotSpecification (const CPlotSpecification &src)
Protected Member Functions inherited from CPlotItem
	CPlotItem (const CPlotItem &src)
Protected Member Functions inherited from CCopasiParameterGroup
	CCopasiParameterGroup ()
Protected Member Functions inherited from CCopasiParameter
	CCopasiParameter (const CCopasiParameter &src)
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)

Private Member Functions
void	initObjects ()

Private Attributes
CDataVector< CPlotItem >	items
bool	mActive
std::set< CTaskEnum::Task >	mTaskTypes

Additional Inherited Members
Public Types inherited from CPlotItem
enum class	LineStyle {   Solid = 0 , Dotted , Dashed , DotDash ,   DotDotDash , None , __SIZE }
enum class	LineType {   Lines = 0 , Points , Symbols , LinesAndSymbols ,   __SIZE }
enum class	SymbolType {   SmallCross = 0 , LargeCross , Circle , Square ,   Diamond , xCross , Plus , Star ,   TriangleUp , TriangleDown , TriangleLeft , TriangleRight ,   hDash , vDash , None , __SIZE }
enum	Type {   unset = 0 , curve2d , histoItem1d , bandedGraph ,   surface , plot2d , simWiz , spectogram }
Public Types inherited from CCopasiParameterGroup
typedef CDataObjectMap::const_type_iterator< CCopasiParameter >	const_name_iterator
typedef std::vector< CCopasiParameter * >	elements
typedef elements::iterator	index_iterator
typedef CDataObjectMap::type_iterator< CCopasiParameter >	name_iterator
Public Types inherited from CCopasiParameter
enum class	eUserInterfaceFlag { editable , basic , unsupported , __SIZE }
enum class	Type {   DOUBLE = 0 , UDOUBLE , INT , UINT ,   BOOL , GROUP , STRING , CN ,   KEY , FILE , EXPRESSION , INVALID ,   __SIZE }
typedef CFlags< eUserInterfaceFlag >	UserInterfaceFlag
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 CPlotItem
static const CEnumAnnotation< std::string, LineStyle >	LineStyleNames
static const CEnumAnnotation< std::string, LineType >	LineTypeNames
static const std::string	RecordingActivityName []
static const CEnumAnnotation< std::string, SymbolType >	SymbolNames
static const std::string	TypeName []
static const char *	XMLRecordingActivity []
static const char *	XMLType []
Static Public Attributes inherited from CCopasiParameter
static const CEnumAnnotation< std::string, Type >	TypeName
static const CEnumAnnotation< std::string, Type >	XMLType
Static Public Attributes inherited from CDataContainer
static const CObjectInterface::ContainerList	EmptyList
Protected Attributes inherited from CCopasiParameter
std::string	mKey
void *	mpDefault
void *	mpValidValues
void *	mpValue
CDataObject *	mpValueReference
UserInterfaceFlag	mUserInterfaceFlag
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

Constructor & Destructor Documentation

CPlotSpecification() [1/3]

CPlotSpecification::CPlotSpecification ( const CPlotSpecification &  src )

protected

Referenced by fromData().

CPlotSpecification() [2/3]

CPlotSpecification::CPlotSpecification	(	const std::string &	name = "NoName",
		const CDataContainer *	pParent = NO_PARENT,
		const CPlotItem::Type &	type = plot2d
	)

References initObjects().

CPlotSpecification() [3/3]

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

References initObjects().

~CPlotSpecification()

CPlotSpecification::~CPlotSpecification ( )

virtual

Destructor

Member Function Documentation

addTaskType()

void CPlotSpecification::addTaskType

(

const CTaskEnum::Task &

type

)

References mTaskTypes.

Referenced by COutputAssistant::createDefaultOutput(), and COutputAssistant::createPlot().

appliesTo() [1/2]

bool CPlotSpecification::appliesTo

(

const CCopasiTask *

pTask

)

const

References CCopasiTask::getType(), and mTaskTypes.

appliesTo() [2/2]

bool CPlotSpecification::appliesTo

(

const CObjectInterface::ContainerList &

list

)

const

Referenced by CSEDMLExporter::exportNthPlot().

applyData()

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

virtual

Apply the provided data to the object

Parameters

const

CData & data

Returns

bool success

Reimplemented from CPlotItem.

References fatalError.

cleanup()

void CPlotSpecification::cleanup ( )

virtual

References CDataVector< CType >::cleanup(), CPlotItem::cleanup(), and items.

createDefaultPlot()

bool CPlotSpecification::createDefaultPlot

(

const CModel *

model

)

References CPlotItem::addChannel(), createItem(), CPlotItem::curve2d, CDataObject::getCN(), CModel::getMetabolites(), CDataObject::getObjectDisplayName(), CModelEntity::getValueReference(), mActive, and CDataVector< CType >::size().

createItem()

CPlotItem * CPlotSpecification::createItem	(	const std::string &	name,
		CPlotItem::Type	type
	)

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

Referenced by SEDMLImporter::addCurveToCopasiPlot(), SEDMLImporter::addSurfaceToCopasiPlot(), COutputAssistant::createDefaultOutput(), createDefaultPlot(), COutputAssistant::createPlot(), and PlotItemHandler::processStart().

fromData()

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

static

Static method to create a CDataObject based on the provided data

Parameters

const

CData & data

Returns

CPlotSpecification * pDataObject

References CPlotSpecification(), CData::getProperty(), NO_PARENT, CData::OBJECT_NAME, CData::PLOT_TYPE, CDataValue::toString(), and CDataValue::toUint().

getItems() [1/2]

CDataVector< CPlotItem > & CPlotSpecification::getItems

(

)

References items.

getItems() [2/2]

const CDataVector< CPlotItem > & CPlotSpecification::getItems

(

)

const

References items.

Referenced by COutputAssistant::createDefaultOutput(), CSEDMLExporter::exportNthPlot(), has3D(), and CCopasiXML::savePlotList().

getTaskTypes()

std::string CPlotSpecification::getTaskTypes

(

)

const

References mTaskTypes, and CTaskEnum::TaskName.

Referenced by CCopasiXML::savePlotList().

has3D()

bool CPlotSpecification::has3D

(

)

const

References getItems(), CPlotItem::spectogram, and CPlotItem::surface.

hasItem()

bool CPlotSpecification::hasItem

(

const std::string &

name

)

Convenience function, whether a curve with given name already exists (otherwise it would be removed when creating a new one)

Parameters

name

a name

Returns

true, if a curve exists, false otherwise

References items.

Referenced by SEDMLImporter::addCurveToCopasiPlot(), and SEDMLImporter::addSurfaceToCopasiPlot().

initObjects()

void CPlotSpecification::initObjects ( )

private

Initialize the contained CDataObjects

Referenced by CPlotSpecification().

isActive()

const bool & CPlotSpecification::isActive

(

)

const

References mActive.

Referenced by CSEDMLExporter::exportNthPlot(), and CCopasiXML::savePlotList().

isLogX()

bool CPlotSpecification::isLogX

(

)

const

Referenced by CSEDMLExporter::exportPlotItem().

isLogY()

bool CPlotSpecification::isLogY

(

)

const

Referenced by CSEDMLExporter::exportPlotItem().

setActive()

void CPlotSpecification::setActive

(

const bool &

active

)

References mActive.

Referenced by PlotSpecificationHandler::processStart().

setLogX()

void CPlotSpecification::setLogX

(

bool

l

)

References CCopasiParameterGroup::setValue().

Referenced by SEDMLImporter::addCurveToCopasiPlot(), SEDMLImporter::addSurfaceToCopasiPlot(), COutputAssistant::createPlot(), and SEDMLImporter::importOutputs().

setLogY()

void CPlotSpecification::setLogY

(

bool

l

)

References CCopasiParameterGroup::setValue().

Referenced by SEDMLImporter::addCurveToCopasiPlot(), SEDMLImporter::addSurfaceToCopasiPlot(), COutputAssistant::createDefaultOutput(), COutputAssistant::createPlot(), and SEDMLImporter::importOutputs().

setTaskTypes() [1/2]

void CPlotSpecification::setTaskTypes

(

const std::set< CTaskEnum::Task > &

taskTypes

)

References mTaskTypes.

setTaskTypes() [2/2]

void CPlotSpecification::setTaskTypes

(

const std::string &

taskTypes

)

References mTaskTypes, CTaskEnum::TaskName, CEnumAnnotation< Type, Enum >::toEnum(), and CTaskEnum::UnsetTask.

Referenced by PlotSpecificationHandler::processStart().

toData()

CData CPlotSpecification::toData ( ) const

virtual

Retrieve the data describing the object

Returns

CData data

Reimplemented from CPlotItem.

References fatalError.

Member Data Documentation

items

CDataVector<CPlotItem> CPlotSpecification::items

private

Referenced by cleanup(), createItem(), getItems(), and hasItem().

mActive

bool CPlotSpecification::mActive

private

Referenced by createDefaultPlot(), isActive(), and setActive().

mTaskTypes

std::set<CTaskEnum::Task> CPlotSpecification::mTaskTypes

private

Referenced by addTaskType(), appliesTo(), getTaskTypes(), and setTaskTypes().

---

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

• CPlotSpecification.h
• CPlotSpecification.cpp