COPASI API  4.40.278
CReportDefinition Class Reference

#include <CReportDefinition.h>

Inheritance diagram for CReportDefinition:

Public Member Functions

virtual bool applyData (const CData &data, CUndoData::CChangeSet &changes)
void cleanup ()
virtual void createUndoData (CUndoData &undoData, const CUndoData::Type &type, const CData &oldData=CData(), const CCore::Framework &framework=CCore::Framework::ParticleNumbers) const
 CReportDefinition (const CReportDefinition &src, const CDataContainer *pParent)
 CReportDefinition (const std::string &name="NoName", const CDataContainer *pParent=NO_PARENT)
std::vector< CRegisteredCommonName > * getBodyAddr ()
const std::vector< CRegisteredCommonName > * getBodyAddr () const
const std::string & getComment () const
std::vector< CRegisteredCommonName > * getFooterAddr ()
const std::vector< CRegisteredCommonName > * getFooterAddr () const
std::vector< CRegisteredCommonName > * getHeaderAddr ()
const std::vector< CRegisteredCommonName > * getHeaderAddr () const
virtual const std::string & getKey () const
const unsigned C_INT32getPrecision () const
const CCopasiReportSeparatorgetSeparator () const
std::vector< CRegisteredCommonName > * getTableAddr ()
const std::vector< CRegisteredCommonName > * getTableAddr () const
const CTaskEnum::TaskgetTaskType () const
bool getTitle () const
bool isTable () const
bool preCompileTable (const CObjectInterface::ContainerList &listOfContainer)
void setComment (const std::string &comment)
void setIsTable (bool table)
void setPrecision (const unsigned C_INT32 &precision)
void setSeparator (const std::string &separator)
bool setTaskType (const CTaskEnum::Task &taskType)
void setTitle (bool title)
virtual CData toData () const
 ~CReportDefinition ()
- 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
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 CReportDefinitionfromData (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 Member Functions

 CReportDefinition (const CReportDefinition &src)
- 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 addTableElement (const CDataObject *pObject)

Private Attributes

std::vector< CRegisteredCommonNamemBodyVector
bool mbTitle
std::string mComment
std::vector< CRegisteredCommonNamemFooterVector
std::vector< CRegisteredCommonNamemHeaderVector
std::string mKey
unsigned C_INT32 mPrecision
CCopasiReportSeparator mSeparator
bool mTable
std::vector< CRegisteredCommonNamemTableVector
CTaskEnum::Task mTaskType

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 Attributes inherited from CDataObject
ObjectSet mPrerequisits
std::set< CDataContainer * > mReferences
- Protected Attributes inherited from CObjectInterface
CValidity mValidity

Constructor & Destructor Documentation

◆ CReportDefinition() [1/3]

CReportDefinition::CReportDefinition ( const CReportDefinition src)

Referenced by fromData().

◆ CReportDefinition() [2/3]

CReportDefinition::CReportDefinition ( const std::string &  name = "NoName",
const CDataContainer pParent = NO_PARENT 

Default constructor.

◆ CReportDefinition() [3/3]

CReportDefinition::CReportDefinition ( const CReportDefinition src,
const CDataContainer pParent 

Copy constructor.

◆ ~CReportDefinition()

CReportDefinition::~CReportDefinition ( )


References cleanup().

Member Function Documentation

◆ addTableElement()

void CReportDefinition::addTableElement ( const CDataObject pObject)

This adds header and body entries for one table element (including separator if necessary)

constCDataObject * pObject

References CDataObject::getCN(), CCommonName::getObjectName(), CDataObject::getObjectName(), CDataObject::getObjectParent(), CDataObject::getObjectType(), mBodyVector, mbTitle, mHeaderVector, and mSeparator.

Referenced by preCompileTable().

◆ applyData()

◆ cleanup()

void CReportDefinition::cleanup ( )

◆ createUndoData()

void CReportDefinition::createUndoData ( CUndoData undoData,
const CUndoData::Type type,
const CData oldData = CData(),
const CCore::Framework framework = CCore::Framework::ParticleNumbers 
) const

Create the undo data which represents the changes recording the differences between the provided oldData and the current data.

CUndoData& undoData
constCUndoData::Type & type
constCData & oldData (default: empty data)
constCCore::Framework & framework (default: CCore::Framework::ParticleNumbers)
CUndoData undoData

Reimplemented from CDataObject.

References CUndoData::addProperty(), CUndoData::CHANGE, CDataObject::createUndoData(), CData::getProperty(), CDataString::getStaticString(), mbTitle, mComment, mPrecision, mSeparator, mTable, mTaskType, CData::NOTES, CData::REPORT_IS_TABLE, CData::REPORT_PRECISION, CData::REPORT_SEPARATOR, CData::REPORT_SHOW_TITLE, CData::TASK_TYPE, and CTaskEnum::TaskName.

◆ fromData()

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

Static method to create a CDataObject based on the provided data

constCData & data
CReportDefinition * pDataObject

CReportDefinition class. This class describes the Report Definition

Created for COPASI by Mudita Singhal

References CReportDefinition(), CData::getProperty(), NO_PARENT, CData::OBJECT_NAME, and CDataValue::toString().

◆ getBodyAddr() [1/2]

◆ getBodyAddr() [2/2]

const std::vector< CRegisteredCommonName > * CReportDefinition::getBodyAddr ( ) const

gets the body in the report tag

References mBodyVector.

◆ getComment()

const std::string & CReportDefinition::getComment ( ) const

Returns the comments in the report tag

References mComment.

Referenced by CCopasiXML::saveReportList().

◆ getFooterAddr() [1/2]

std::vector< CRegisteredCommonName > * CReportDefinition::getFooterAddr ( )

◆ getFooterAddr() [2/2]

const std::vector< CRegisteredCommonName > * CReportDefinition::getFooterAddr ( ) const

gets the footer in the report tag

References mFooterVector.

◆ getHeaderAddr() [1/2]

std::vector< CRegisteredCommonName > * CReportDefinition::getHeaderAddr ( )

◆ getHeaderAddr() [2/2]

const std::vector< CRegisteredCommonName > * CReportDefinition::getHeaderAddr ( ) const

gets the header in the report tag

References mHeaderVector.

◆ getKey()

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

Reimplemented from CDataObject.

References mKey.

Referenced by CCopasiXML::saveReportList(), and CCopasiXML::saveTaskList().

◆ getPrecision()

const unsigned C_INT32 & CReportDefinition::getPrecision ( ) const

Retrieve the precsion for floating point numbers;

const unsigned C_INT32 & precision

References mPrecision.

Referenced by CReport::open(), and CCopasiXML::saveReportList().

◆ getSeparator()

const CCopasiReportSeparator & CReportDefinition::getSeparator ( ) const

◆ getTableAddr() [1/2]

std::vector< CRegisteredCommonName > * CReportDefinition::getTableAddr ( )

◆ getTableAddr() [2/2]

const std::vector< CRegisteredCommonName > * CReportDefinition::getTableAddr ( ) const

gets the footer in the report tag

References mTableVector.

◆ getTaskType()

const CTaskEnum::Task & CReportDefinition::getTaskType ( ) const

References mTaskType.

Referenced by CCopasiXML::saveReportList().

◆ getTitle()

bool CReportDefinition::getTitle ( ) const

References mbTitle.

Referenced by CCopasiXML::saveReportList().

◆ isTable()

bool CReportDefinition::isTable ( ) const

◆ preCompileTable()

bool CReportDefinition::preCompileTable ( const CObjectInterface::ContainerList listOfContainer)

Convert the table list into a header and body list.

constCObjectInterface::ContainerList & listOfContainer (default: CDataContainer::EmptyList)
bool success

References addTableElement(), CObjectInterface::DataObject(), CObjectInterface::GetObjectFromCN(), mBodyVector, MCCopasiTask, mFooterVector, mHeaderVector, mTableVector, and CCopasiMessage::WARNING.

◆ setComment()

void CReportDefinition::setComment ( const std::string &  comment)

◆ setIsTable()

void CReportDefinition::setIsTable ( bool  table)

◆ setPrecision()

void CReportDefinition::setPrecision ( const unsigned C_INT32 precision)

Set the precsion for floating point numbers;

constunsigned C_INT32 & precision

References mPrecision.

Referenced by ReportDefinitionHandler::processStart().

◆ setSeparator()

void CReportDefinition::setSeparator ( const std::string &  separator)

◆ setTaskType()

bool CReportDefinition::setTaskType ( const CTaskEnum::Task taskType)

◆ setTitle()

void CReportDefinition::setTitle ( bool  title)

◆ toData()

Member Data Documentation

◆ mBodyVector

std::vector<CRegisteredCommonName> CReportDefinition::mBodyVector

◆ mbTitle

bool CReportDefinition::mbTitle

◆ mComment

std::string CReportDefinition::mComment

◆ mFooterVector

std::vector<CRegisteredCommonName> CReportDefinition::mFooterVector

◆ mHeaderVector

std::vector<CRegisteredCommonName> CReportDefinition::mHeaderVector

◆ mKey

std::string CReportDefinition::mKey

Referenced by cleanup(), and getKey().

◆ mPrecision

unsigned C_INT32 CReportDefinition::mPrecision

◆ mSeparator

CCopasiReportSeparator CReportDefinition::mSeparator

◆ mTable

bool CReportDefinition::mTable

◆ mTableVector

std::vector<CRegisteredCommonName> CReportDefinition::mTableVector

◆ mTaskType

CTaskEnum::Task CReportDefinition::mTaskType

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