COPASI API
4.16.103
|
#include <CReportDefinition.h>
Public Member Functions | |
void | cleanup () |
CReportDefinition (const std::string &name="NoName", const CCopasiContainer *pParent=NULL) | |
CReportDefinition (const CReportDefinition &src, const CCopasiContainer *pParent=NULL) | |
std::vector < CRegisteredObjectName > * | getBodyAddr () |
const std::string & | getComment () const |
std::vector < CRegisteredObjectName > * | getFooterAddr () |
std::vector < CRegisteredObjectName > * | getHeaderAddr () |
virtual const std::string & | getKey () const |
const unsigned C_INT32 & | getPrecision () const |
const CCopasiReportSeparator & | getSeparator () const |
std::vector < CRegisteredObjectName > * | getTableAddr () |
const CCopasiTask::Type & | getTaskType () const |
bool | getTitle () const |
bool | isTable () const |
bool | preCompileTable (const std::vector< CCopasiContainer * > &listOfContainer=CCopasiContainer::EmptyList) |
void | setComment (const std::string &comment) |
void | setIsTable (bool table) |
void | setPrecision (const unsigned C_INT32 &precision) |
void | setSeparator (const CCopasiReportSeparator &Separator) |
bool | setTaskType (const CCopasiTask::Type &taskType) |
void | setTitle (bool title) |
~CReportDefinition () | |
![]() | |
void | addDirectDependency (const CCopasiObject *pObject) |
CCopasiObject (const CCopasiObject &src, const CCopasiContainer *pParent=NULL) | |
void | clearDirectDependencies () |
void | clearRefresh () |
bool | dependsOn (DataObjectSet candidates, const DataObjectSet &context=DataObjectSet()) const |
void | getAllDependencies (DataObjectSet &dependencies, const DataObjectSet &context) const |
virtual CCopasiObjectName | getCN () const |
virtual const DataObjectSet & | getDirectDependencies (const DataObjectSet &context=DataObjectSet()) const |
virtual const CObjectInterface * | getObject (const CCopasiObjectName &cn) const |
CCopasiContainer * | getObjectAncestor (const std::string &type) const |
CCopasiDataModel * | getObjectDataModel () |
const CCopasiDataModel * | getObjectDataModel () const |
virtual std::string | getObjectDisplayName (bool regular=true, bool richtext=false) const |
const std::string & | getObjectName () const |
CCopasiContainer * | getObjectParent () const |
const std::string & | getObjectType () const |
virtual const CObjectInterface::ObjectSet & | getPrerequisites () const |
virtual Refresh * | getRefresh () const |
virtual std::string | getUnits () const |
UpdateMethod * | getUpdateMethod () const |
virtual const CCopasiObject * | getValueObject () const |
virtual void * | getValuePointer () const |
bool | hasCircularDependencies (DataObjectSet &candidates, DataObjectSet &verified, const DataObjectSet &context) const |
bool | hasUpdateMethod () const |
bool | isArray () const |
bool | isContainer () const |
bool | isDataModel () const |
bool | isMatrix () const |
bool | isNameVector () const |
bool | isNonUniqueName () const |
virtual bool | isPrerequisiteForContext (const CObjectInterface *pObject, const CMath::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const |
bool | isReference () const |
bool | isRoot () const |
bool | isSeparator () const |
bool | isStaticString () const |
bool | isValueBool () const |
bool | isValueDbl () const |
bool | isValueInt () const |
bool | isValueInt64 () const |
bool | isValueString () const |
bool | isVector () const |
virtual bool | mustBeDeleted (const DataObjectSet &deletedObjects) const |
virtual void | print (std::ostream *ostream) const |
void | removeDirectDependency (const CCopasiObject *pObject) |
void | setDirectDependencies (const DataObjectSet &directDependencies) |
bool | setObjectName (const std::string &name) |
virtual bool | setObjectParent (const CCopasiContainer *pParent) |
void | setObjectValue (const C_FLOAT64 &value) |
void | setObjectValue (const C_INT32 &value) |
void | setObjectValue (const bool &value) |
template<class CType > | |
void | setRefresh (CType *pType, void(CType::*method)(void)) |
template<class CType > | |
void | setUpdateMethod (CType *pType, void(CType::*method)(const C_FLOAT64 &)) |
template<class CType > | |
void | setUpdateMethod (CType *pType, void(CType::*method)(const C_INT32 &)) |
template<class CType > | |
void | setUpdateMethod (CType *pType, void(CType::*method)(const bool &)) |
virtual | ~CCopasiObject () |
![]() | |
CObjectInterface () | |
virtual | ~CObjectInterface () |
Private Member Functions | |
void | addTableElement (const CCopasiObject *pObject) |
Private Attributes | |
std::vector < CRegisteredObjectName > | mBodyVector |
bool | mbTitle |
std::string | mComment |
std::vector < CRegisteredObjectName > | mFooterVector |
std::vector < CRegisteredObjectName > | mHeaderVector |
std::string | mKey |
unsigned C_INT32 | mPrecision |
CCopasiReportSeparator | mSeparator |
bool | mTable |
std::vector < CRegisteredObjectName > | mTableVector |
CCopasiTask::Type | mTaskType |
Additional Inherited Members | |
![]() | |
typedef std::set< const CCopasiObject * > | DataObjectSet |
typedef std::vector< Refresh * > | DataUpdateSequence |
![]() | |
typedef std::set< const CObjectInterface * > | ObjectSet |
typedef std::vector < CObjectInterface * > | UpdateSequence |
![]() | |
static std::vector< Refresh * > | buildUpdateSequence (const DataObjectSet &objects, const DataObjectSet &uptoDateObjects, const DataObjectSet &context=DataObjectSet()) |
static void | setRenameHandler (CRenameHandler *rh) |
![]() | |
enum | Flag { Container = 0x1, Vector = 0x2, Matrix = 0x4, NameVector = 0x8, Reference = 0x10, ValueBool = 0x20, ValueInt = 0x40, ValueInt64 = 0x80, ValueDbl = 0x100, NonUniqueName = 0x200, StaticString = 0x400, ValueString = 0x800, Separator = 0x1000, ModelEntity = 0x2000, Array = 0x4000, DataModel = 0x8000, Root = 0x10000, Gui = 0x20000 } |
![]() | |
CCopasiObject () | |
CCopasiObject (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &type="CN", const unsigned C_INT32 &flag=0) | |
![]() | |
static CRenameHandler * | smpRenameHandler = NULL |
Definition at line 40 of file CReportDefinition.h.
CReportDefinition::CReportDefinition | ( | const std::string & | name = "NoName" , |
const CCopasiContainer * | pParent = NULL |
||
) |
Default constructor.
CReportDefinition class. This class describes the Report Definition
Created for Copasi by Mudita Singhal
Definition at line 44 of file CReportDefinition.cpp.
CReportDefinition::CReportDefinition | ( | const CReportDefinition & | src, |
const CCopasiContainer * | pParent = NULL |
||
) |
Copy constructor.
Definition at line 56 of file CReportDefinition.cpp.
CReportDefinition::~CReportDefinition | ( | ) |
|
private |
This adds header and body entries for one table element (including separator if necessary)
const | CCopasiObject * pObject |
Definition at line 160 of file CReportDefinition.cpp.
References CCopasiObject::getCN(), CCopasiObject::getObjectName(), CCopasiObject::getObjectParent(), mBodyVector, mbTitle, mHeaderVector, and mSeparator.
Referenced by preCompileTable().
void CReportDefinition::cleanup | ( | ) |
cleanup
Definition at line 75 of file CReportDefinition.cpp.
References CCopasiRootContainer::getKeyFactory(), mBodyVector, mFooterVector, mHeaderVector, mKey, mTableVector, and CKeyFactory::remove().
Referenced by ~CReportDefinition().
std::vector< CRegisteredObjectName > * CReportDefinition::getBodyAddr | ( | ) |
gets the body in the report tag
Definition at line 115 of file CReportDefinition.cpp.
References mBodyVector.
Referenced by CCopasiDataModel::addReport(), CReport::compile(), CSEDMLExporter::createDataGenerators(), CCopasiXMLParser::BodyElement::end(), CQReportDefinition::load(), SEDMLImporter::readListOfPlotsFromSedMLOutput(), CQReportDefinition::save(), CCopasiXML::saveReportList(), and test000087::test_simulate_reaction_flux_reference_1().
|
inline |
Returns the comments in the report tag
Definition at line 92 of file CReportDefinition.h.
References mComment.
Referenced by CQNotes::load(), CQNotes::save(), and CCopasiXML::saveReportList().
std::vector< CRegisteredObjectName > * CReportDefinition::getFooterAddr | ( | ) |
gets the footer in the report tag
Definition at line 121 of file CReportDefinition.cpp.
References mFooterVector.
Referenced by CCopasiDataModel::addReport(), CReport::compile(), CCopasiXMLParser::FooterElement::end(), CQReportDefinition::load(), CQReportDefinition::save(), and CCopasiXML::saveReportList().
std::vector< CRegisteredObjectName > * CReportDefinition::getHeaderAddr | ( | ) |
gets the header in the report tag
Definition at line 118 of file CReportDefinition.cpp.
References mHeaderVector.
Referenced by CCopasiDataModel::addReport(), CReport::compile(), CSEDMLExporter::createDataGenerators(), CCopasiXMLParser::HeaderElement::end(), CQReportDefinition::load(), SEDMLImporter::readListOfPlotsFromSedMLOutput(), CQReportDefinition::save(), CCopasiXML::saveReportList(), and test000087::test_simulate_reaction_flux_reference_1().
|
virtual |
Reimplemented from CCopasiObject.
Definition at line 157 of file CReportDefinition.cpp.
References mKey.
Referenced by CQReportDefinition::btnCopyReportClicked(), CQReportDefinition::btnNewReportClicked(), CQReportDM::insertRows(), CQReportDM::removeRows(), CCopasiXML::saveReportList(), CCopasiXML::saveTaskList(), and CQReportDM::setData().
const unsigned C_INT32 & CReportDefinition::getPrecision | ( | ) | const |
Retrieve the precsion for floating point numbers;
Definition at line 154 of file CReportDefinition.cpp.
References mPrecision.
Referenced by CQReportDefinition::load(), CReport::open(), and CCopasiXML::saveReportList().
const CCopasiReportSeparator & CReportDefinition::getSeparator | ( | ) | const |
Definition at line 136 of file CReportDefinition.cpp.
References mSeparator.
Referenced by CSEDMLExporter::createDataGenerators(), CQReportDefinition::load(), SEDMLImporter::readListOfPlotsFromSedMLOutput(), CCopasiXML::saveReportList(), and test000087::test_simulate_reaction_flux_reference_1().
std::vector< CRegisteredObjectName > * CReportDefinition::getTableAddr | ( | ) |
gets the footer in the report tag
Definition at line 124 of file CReportDefinition.cpp.
References mTableVector.
Referenced by CSEDMLExporter::createDataGenerators(), COutputAssistant::createTable(), CCopasiXMLParser::TableElement::end(), CQReportDefinition::load(), CQReportDefinition::save(), and CCopasiXML::saveReportList().
const CCopasiTask::Type & CReportDefinition::getTaskType | ( | ) | const |
Definition at line 130 of file CReportDefinition.cpp.
References mTaskType.
Referenced by CQReportDefinition::load(), and CCopasiXML::saveReportList().
bool CReportDefinition::getTitle | ( | ) | const |
Definition at line 139 of file CReportDefinition.cpp.
References mbTitle.
Referenced by CQReportDefinition::load(), and CCopasiXML::saveReportList().
bool CReportDefinition::isTable | ( | ) | const |
Definition at line 145 of file CReportDefinition.cpp.
References mTable.
Referenced by CReport::compile(), CSEDMLExporter::createDataGenerators(), CQReportDefinition::load(), and CCopasiXML::saveReportList().
bool CReportDefinition::preCompileTable | ( | const std::vector< CCopasiContainer * > & | listOfContainer = CCopasiContainer::EmptyList | ) |
Convert the table list into a header and body list.
const | std::vector< CCopasiContainer * > & listOfContainer (default: CCopasiContainer::EmptyList) |
Definition at line 84 of file CReportDefinition.cpp.
References addTableElement(), CCopasiObject::getObjectDataModel(), mBodyVector, MCCopasiTask, mFooterVector, mHeaderVector, mTableVector, CCopasiDataModel::ObjectFromName(), and CCopasiMessage::WARNING.
Referenced by CQReportDefinition::btnAdvancedClicked(), and CReport::compile().
|
inline |
sets the comments in the report tag
Definition at line 100 of file CReportDefinition.h.
References mComment.
Referenced by CCopasiDataModel::addReport(), CReportDefinitionVector::createReportDefinition(), CCopasiXMLParser::ReportElement::end(), SEDMLImporter::readListOfPlotsFromSedMLOutput(), and CQNotes::save().
void CReportDefinition::setIsTable | ( | bool | table | ) |
Definition at line 148 of file CReportDefinition.cpp.
References mTable.
Referenced by CCopasiDataModel::addReport(), CQReportDefinition::btnAdvancedClicked(), COutputAssistant::createTable(), SEDMLImporter::readListOfPlotsFromSedMLOutput(), CQReportDefinition::save(), CCopasiXMLParser::ReportElement::start(), and test000087::test_simulate_reaction_flux_reference_1().
Set the precsion for floating point numbers;
const | unsigned C_INT32 & precision |
Definition at line 151 of file CReportDefinition.cpp.
References mPrecision.
Referenced by CQReportDefinition::save(), and CCopasiXMLParser::ReportElement::start().
void CReportDefinition::setSeparator | ( | const CCopasiReportSeparator & | Separator | ) |
Definition at line 133 of file CReportDefinition.cpp.
References mSeparator, and CCopasiObject::Separator.
Referenced by CCopasiDataModel::addReport(), COutputAssistant::createTable(), SEDMLImporter::readListOfPlotsFromSedMLOutput(), CQReportDefinition::save(), CCopasiXMLParser::ReportElement::start(), and test000087::test_simulate_reaction_flux_reference_1().
bool CReportDefinition::setTaskType | ( | const CCopasiTask::Type & | taskType | ) |
Definition at line 127 of file CReportDefinition.cpp.
References mTaskType.
Referenced by CCopasiDataModel::addReport(), COutputAssistant::createTable(), CQReportDefinition::save(), CCopasiXMLParser::ReportElement::start(), and test000087::test_simulate_reaction_flux_reference_1().
void CReportDefinition::setTitle | ( | bool | title | ) |
Definition at line 142 of file CReportDefinition.cpp.
References mbTitle.
Referenced by CCopasiDataModel::addReport(), CQReportDefinition::save(), and CCopasiXMLParser::TableElement::start().
|
private |
Definition at line 49 of file CReportDefinition.h.
Referenced by addTableElement(), cleanup(), getBodyAddr(), and preCompileTable().
|
private |
Definition at line 55 of file CReportDefinition.h.
Referenced by addTableElement(), getTitle(), and setTitle().
|
private |
Definition at line 45 of file CReportDefinition.h.
Referenced by getComment(), and setComment().
|
private |
Definition at line 50 of file CReportDefinition.h.
Referenced by cleanup(), getFooterAddr(), and preCompileTable().
|
private |
Definition at line 48 of file CReportDefinition.h.
Referenced by addTableElement(), cleanup(), getHeaderAddr(), and preCompileTable().
|
private |
Definition at line 44 of file CReportDefinition.h.
|
private |
Definition at line 56 of file CReportDefinition.h.
Referenced by getPrecision(), and setPrecision().
|
private |
Definition at line 53 of file CReportDefinition.h.
Referenced by addTableElement(), getSeparator(), and setSeparator().
|
private |
Definition at line 54 of file CReportDefinition.h.
Referenced by isTable(), and setIsTable().
|
private |
Definition at line 51 of file CReportDefinition.h.
Referenced by cleanup(), getTableAddr(), and preCompileTable().
|
private |
Definition at line 46 of file CReportDefinition.h.
Referenced by getTaskType(), and setTaskType().