COPASI API  4.40.278
COptItem Class Reference

#include <COptItem.h>

Inheritance diagram for COptItem:
[legend]

Public Member Functions

void addDependentItem (COptItem *pDependentItem)
 
virtual void calculateValue () override
 
virtual C_INT32 checkConstraint () const
 
C_INT32 checkConstraint (const C_FLOAT64 &value) const
 
bool checkInterval () const
 
bool checkIsInitialValue () const
 
bool checkLowerBound (const C_FLOAT64 &value) const
 
bool checkUpperBound (const C_FLOAT64 &value) const
 
virtual bool compile (CObjectInterface::ContainerList listOfContainer=CDataContainer::EmptyList)
 
 COptItem (const CCopasiParameterGroup &group, const CDataContainer *pParent)
 
 COptItem (const CDataContainer *pParent, const std::string &name="OptimizationItem")
 
 COptItem (const COptItem &src, const CDataContainer *pParent)
 
virtual C_FLOAT64 getConstraintViolation () const
 
const std::set< COptItem * > & getDependentItems () const
 
const CCore::CUpdateSequencegetIntervalUpdateSequence () const
 
const C_FLOAT64getLastStartValue () const
 
const std::string getLowerBound () const
 
const C_FLOAT64getLowerBoundValue () const
 
const CObjectInterfacegetObject () const
 
const CCommonName getObjectCN () const
 
std::string getObjectDisplayName () const override
 
virtual const C_FLOAT64getObjectValue () const
 
C_FLOAT64 getRandomValue (CRandom &Random) const
 
const C_FLOAT64getStartValue () const
 
const std::string getUpperBound () const
 
const C_FLOAT64getUpperBoundValue () const
 
virtual void * getValuePointer () const override
 
bool influencesIntervals () const
 
virtual bool isValid () const
 
void rememberStartValue ()
 
void setIntervalUpdateSequence (const CCore::CUpdateSequence &updateSequence)
 
bool setLowerBound (const CCommonName &lowerBound)
 
bool setObjectCN (const CCommonName &objectCN)
 
bool setStartValue (const C_FLOAT64 &value)
 
bool setUpperBound (const CCommonName &upperBound)
 
void updatePrerequisites (const std::vector< COptItem * > &influencingIntervals)
 
virtual ~COptItem ()
 
- 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)
 
virtual bool applyData (const CData &data, CUndoData::CChangeSet &changes)
 
CCopasiParameterGroupassertGroup (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
 
CCopasiParameterGroupgetElementTemplates ()
 
const CCopasiParameterGroupgetElementTemplates () const
 
CCopasiParameterGroupgetGroup (const size_t &index)
 
const CCopasiParameterGroupgetGroup (const size_t &index) const
 
CCopasiParameterGroupgetGroup (const std::string &name)
 
const CCopasiParameterGroupgetGroup (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 CObjectInterfacegetObject (const CCommonName &cn) const
 
CCopasiParametergetParameter (const size_t &index)
 
const CCopasiParametergetParameter (const size_t &index) const
 
CCopasiParametergetParameter (std::string name)
 
const CCopasiParametergetParameter (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 CUndoObjectInterfaceinsert (const CData &data)
 
CCopasiParameterGroupoperator= (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 CData toData () const
 
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
 
const CCopasiParameter::TypegetType () const
 
const UserInterfaceFlaggetUserInterfaceFlag () 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
 
CDataObjectgetValueReference () 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
 
CCopasiParameteroperator= (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 objectMapgetObjects ()
 
virtual const objectMapgetObjects () const
 
virtual const std::string getUnits () const override
 
virtual const CDataObjectgetValueObject () 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)
 
 CDataObject (const CDataObject &src, const CDataContainer *pParent=NULL)
 
virtual void destruct () override
 
virtual const CDataObjectgetDataObject () const override
 
CDataContainergetObjectAncestor (const std::string &type) const
 
CDataModelgetObjectDataModel () const
 
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 CValiditygetValidity () 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 bool isValid (CCopasiParameterGroup &group)
 
- 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 CCopasiParameterfromData (const CData &data, CUndoObjectInterface *pParent)
 
- Static Public Member Functions inherited from CDataContainer
static CDataContainerfromData (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

 COptItem ()
 
 COptItem (const COptItem &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)
 

Protected Attributes

std::set< COptItem * > mDependentItems
 
C_FLOAT64 mInterval
 
C_FLOAT64 mLastStartValue
 
C_FLOAT64 mLowerBound
 
const C_FLOAT64mpLowerBound
 
const CObjectInterfacempLowerObject
 
const CObjectInterfacempObject
 
const C_FLOAT64mpObjectValue
 
std::string * mpParmLowerBound
 
std::string * mpParmObjectCN
 
C_FLOAT64mpParmStartValue
 
std::string * mpParmUpperBound
 
const C_FLOAT64mpUpperBound
 
const CObjectInterfacempUpperObject
 
CCore::CUpdateSequence mUpdateInterval
 
C_FLOAT64 mUpperBound
 
- Protected Attributes inherited from CCopasiParameter
std::string mKey
 
void * mpDefault
 
void * mpValidValues
 
void * mpValue
 
CDataObjectmpValueReference
 
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
 

Private Member Functions

bool compileLowerBound (const CObjectInterface::ContainerList &listOfContainer)
 
bool compileUpperBound (const CObjectInterface::ContainerList &listOfContainer)
 
void initializeParameter ()
 

Friends

std::ostream & operator<< (std::ostream &os, const COptItem &o)
 

Additional Inherited Members

- Public Types inherited from CCopasiParameterGroup
typedef CDataObjectMap::const_type_iterator< CCopasiParameterconst_name_iterator
 
typedef std::vector< CCopasiParameter * > elements
 
typedef elements::iterator index_iterator
 
typedef CDataObjectMap::type_iterator< CCopasiParametername_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< eUserInterfaceFlagUserInterfaceFlag
 
- 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 CCopasiParameter
static const CEnumAnnotation< std::string, TypeTypeName
 
static const CEnumAnnotation< std::string, TypeXMLType
 
- Static Public Attributes inherited from CDataContainer
static const CObjectInterface::ContainerList EmptyList
 

Constructor & Destructor Documentation

◆ COptItem() [1/5]

COptItem::COptItem ( )
protected

Default constructor

◆ COptItem() [2/5]

COptItem::COptItem ( const COptItem src)
protected

◆ COptItem() [3/5]

COptItem::COptItem ( const CDataContainer pParent,
const std::string &  name = "OptimizationItem" 
)

Specific constructor

Parameters
constCDataContainer * pParent
conststd::string & name (default: OptimizationItem)

References initializeParameter().

◆ COptItem() [4/5]

COptItem::COptItem ( const COptItem src,
const CDataContainer pParent 
)

Copy constructor

Parameters
constCOptItem & src
constCDataContainer * pParent (default: src data model)

References initializeParameter().

◆ COptItem() [5/5]

COptItem::COptItem ( const CCopasiParameterGroup group,
const CDataContainer pParent 
)

Specific constructor used for reading COPASI files

Parameters
constCCopasiParameterGroup & group
constCDataContainer * pParent (default: group data model)

References initializeParameter().

◆ ~COptItem()

COptItem::~COptItem ( )
virtual

Destructor

Member Function Documentation

◆ addDependentItem()

void COptItem::addDependentItem ( COptItem pDependentItem)

References mDependentItems.

Referenced by COptProblem::initialize().

◆ calculateValue()

void COptItem::calculateValue ( )
overridevirtual

Calculate the objects value.

Reimplemented from CDataObject.

References mInterval, mpLowerBound, and mpUpperBound.

◆ checkConstraint() [1/2]

◆ checkConstraint() [2/2]

C_INT32 COptItem::checkConstraint ( const C_FLOAT64 value) const

This functions check whether the value is within the limits of the optimization item.

Parameters
constC_FLOAT64 & value
Returns
C_INT32 result (-1: to small, 0: within boundaries, 1 to large)

References mpLowerBound, and mpUpperBound.

◆ checkInterval()

bool COptItem::checkInterval ( ) const

Checks whether we have a valid interval.

Returns
bool fulfills

References mpLowerBound, and mpUpperBound.

◆ checkIsInitialValue()

bool COptItem::checkIsInitialValue ( ) const

Checks whether we have a valid initial value item.

Returns
bool fulfills

References CCopasiMessage::ERROR, CObjectInterface::getObjectDisplayName(), MCOptimization, mpLowerObject, mpObject, and mpUpperObject.

◆ checkLowerBound()

bool COptItem::checkLowerBound ( const C_FLOAT64 value) const

Checks whether the value fulfills the lower bound constraint.

Parameters
constC_FLOAT64 & value
Returns
bool fulfills

References mpLowerBound.

Referenced by COptMethodEP::creation(), COptMethodSRES::creation(), and CRandomSearch::optimise().

◆ checkUpperBound()

bool COptItem::checkUpperBound ( const C_FLOAT64 value) const

Checks whether the value fulfills the upper bound constraint.

Parameters
constC_FLOAT64 & value
Returns
bool fulfills

References mpUpperBound.

Referenced by COptMethodEP::creation(), COptMethodSRES::creation(), and CRandomSearch::optimise().

◆ compile()

◆ compileLowerBound()

bool COptItem::compileLowerBound ( const CObjectInterface::ContainerList listOfContainer)
private

◆ compileUpperBound()

bool COptItem::compileUpperBound ( const CObjectInterface::ContainerList listOfContainer)
private

◆ getConstraintViolation()

C_FLOAT64 COptItem::getConstraintViolation ( ) const
virtual

Retrieve the magnitude of the constraint violation This is always a positive number

Returns
C_FLOAT64 constraintViolation;

Reimplemented in CFitItem, and CFitConstraint.

References checkConstraint(), mpLowerBound, mpObjectValue, and mpUpperBound.

◆ getDependentItems()

const std::set< COptItem * > & COptItem::getDependentItems ( ) const

◆ getIntervalUpdateSequence()

const CCore::CUpdateSequence & COptItem::getIntervalUpdateSequence ( ) const

References mUpdateInterval.

◆ getLastStartValue()

const C_FLOAT64 & COptItem::getLastStartValue ( ) const

Retrieve the start value use in the last optimization.

Returns
const C_FLOAT64 & startValue

References mLastStartValue.

◆ getLowerBound()

const std::string COptItem::getLowerBound ( ) const

Retrieve the lower bound.

Returns
const std::string lowerBound

References mpParmLowerBound.

Referenced by isValid(), and CFitItem::updateBounds().

◆ getLowerBoundValue()

◆ getObject()

const CObjectInterface * COptItem::getObject ( ) const

Retrieve the item object. This may only be called after compile

Returns
const CObjectInterface *

References mpObject.

Referenced by COptProblem::adjustStartValue(), CMathDependencyGraph::getDOTNodeId(), and CFitProblem::initialize().

◆ getObjectCN()

const CCommonName COptItem::getObjectCN ( ) const

Retrieve the object of the optimization item.

Returns
const CCommonName objectCN

References mpParmObjectCN.

◆ getObjectDisplayName()

std::string COptItem::getObjectDisplayName ( ) const
overridevirtual

◆ getObjectValue()

const C_FLOAT64 * COptItem::getObjectValue ( ) const
virtual

Retrieve the value of the optimization object.

Returns
const C_FLOAT64 * objectValue

Reimplemented in CFitItem.

References mpObjectValue.

◆ getRandomValue()

C_FLOAT64 COptItem::getRandomValue ( CRandom Random) const

Retrieve a random value in the interval (lower bound, upper bound). Optionally one may provide a random number generator to be used to create the random value.

Parameters
CRandom& Random
Returns
C_FLOAT64 randomValue

References C_FLOAT64, compile(), CRandom::getRandomCC(), CRandom::getRandomNormal(), max, min, mpLowerBound, mpUpperBound, and NaN.

Referenced by CRandomSearch::optimise().

◆ getStartValue()

◆ getUpperBound()

const std::string COptItem::getUpperBound ( ) const

Retrieve the upper bound.

Returns
const std::string upperBound

References mpParmUpperBound.

Referenced by isValid(), and CFitItem::updateBounds().

◆ getUpperBoundValue()

◆ getValuePointer()

void * COptItem::getValuePointer ( ) const
overridevirtual

Retrieve a pointer to the value of the object

Reimplemented from CCopasiParameter.

References C_FLOAT64, and mInterval.

◆ influencesIntervals()

bool COptItem::influencesIntervals ( ) const

Check whether the item influences other intervals

Returns
bool influencesIntervals

References mDependentItems.

◆ initializeParameter()

void COptItem::initializeParameter ( )
private

Allocates all group parameters and assures that they are properly initialized.

References CCopasiParameterGroup::assertParameter(), CCopasiParameter::CN, CCopasiParameter::DOUBLE, mpParmLowerBound, mpParmObjectCN, mpParmStartValue, mpParmUpperBound, and NaN.

Referenced by COptItem().

◆ isValid() [1/2]

bool COptItem::isValid ( ) const
virtual

Check the validity of the optimization item.

Reimplemented in CFitItem.

References getLowerBound(), getUpperBound(), mpParmObjectCN, setLowerBound(), setObjectCN(), and setUpperBound().

Referenced by CFitItem::isValid(), and isValid().

◆ isValid() [2/2]

bool COptItem::isValid ( CCopasiParameterGroup group)
static

Check whether the group describes a valid optimization item.

Returns
bool isValid

References isValid(), and NO_PARENT.

◆ rememberStartValue()

void COptItem::rememberStartValue ( )

Remember the current start value

References getStartValue(), and mLastStartValue.

◆ setIntervalUpdateSequence()

void COptItem::setIntervalUpdateSequence ( const CCore::CUpdateSequence updateSequence)

References mUpdateInterval.

◆ setLowerBound()

bool COptItem::setLowerBound ( const CCommonName lowerBound)

Set the lower bound.

Parameters
constCCommonName & lowerBound
Returns
bool success

References C_FLOAT64, compileLowerBound(), CDataContainer::EmptyList, getStartValue(), isNumber(), mpParmLowerBound, and strToDouble().

Referenced by isValid().

◆ setObjectCN()

bool COptItem::setObjectCN ( const CCommonName objectCN)

◆ setStartValue()

bool COptItem::setStartValue ( const C_FLOAT64 value)

Set the value start value.

Parameters
constC_FLOAT64 & startValue
Returns
bool success

References mpParmStartValue.

Referenced by COptProblem::adjustStartValue(), CFitItem::elevateChildren(), and ResultData::setOptItemStartValues().

◆ setUpperBound()

bool COptItem::setUpperBound ( const CCommonName upperBound)

Set the upper bound.

Parameters
constCCommonName & upperBound
Returns
bool success

References C_FLOAT64, compileUpperBound(), CDataContainer::EmptyList, getStartValue(), isNumber(), mpParmUpperBound, and strToDouble().

Referenced by isValid().

◆ updatePrerequisites()

void COptItem::updatePrerequisites ( const std::vector< COptItem * > &  influencingIntervals)

Update the prerequisites to point to the optimization items controlling the boundary object

Parameters
conststd::vector< COptItem * > & influencingIntervals

References CDataObject::mPrerequisits.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const COptItem o 
)
friend

Output stream operator

Parameters
ostream& os
constCOptItem & A
Returns
ostream & os

Member Data Documentation

◆ mDependentItems

std::set< COptItem * > COptItem::mDependentItems
protected

◆ mInterval

C_FLOAT64 COptItem::mInterval
protected

A value indicating whether the interval is valid

Referenced by calculateValue(), and getValuePointer().

◆ mLastStartValue

C_FLOAT64 COptItem::mLastStartValue
protected

The start value use for last calculation

Referenced by getLastStartValue(), and rememberStartValue().

◆ mLowerBound

C_FLOAT64 COptItem::mLowerBound
protected

The value of the lower bound (only if not on object)

Referenced by compileLowerBound().

◆ mpLowerBound

◆ mpLowerObject

const CObjectInterface* COptItem::mpLowerObject
protected

A pointer to the object for the lower bound

Referenced by checkIsInitialValue(), compile(), compileLowerBound(), and CFitItem::updateBounds().

◆ mpObject

const CObjectInterface* COptItem::mpObject
protected

A pointer to the object

Referenced by checkIsInitialValue(), compile(), getObject(), and getObjectDisplayName().

◆ mpObjectValue

const C_FLOAT64* COptItem::mpObjectValue
protected

◆ mpParmLowerBound

std::string* COptItem::mpParmLowerBound
protected

A pointer to the value of the CCopasiParameter holding the LowerBound

Referenced by compile(), compileLowerBound(), getLowerBound(), initializeParameter(), and setLowerBound().

◆ mpParmObjectCN

std::string* COptItem::mpParmObjectCN
protected

A pointer to the value of the CCopasiParameter holding the ObjectCN

Referenced by compile(), getObjectCN(), getObjectDisplayName(), getStartValue(), initializeParameter(), isValid(), and setObjectCN().

◆ mpParmStartValue

C_FLOAT64* COptItem::mpParmStartValue
protected

A pointer to the value of the CCopasiParameter holding the start value

Referenced by compile(), CFitItem::compile(), getStartValue(), initializeParameter(), and setStartValue().

◆ mpParmUpperBound

std::string* COptItem::mpParmUpperBound
protected

A pointer to the value of the CCopasiParameter holding the UpperBound

Referenced by compile(), compileUpperBound(), getUpperBound(), initializeParameter(), and setUpperBound().

◆ mpUpperBound

◆ mpUpperObject

const CObjectInterface* COptItem::mpUpperObject
protected

A pointer to the object for the upper bound

Referenced by checkIsInitialValue(), compile(), compileUpperBound(), and CFitItem::updateBounds().

◆ mUpdateInterval

CCore::CUpdateSequence COptItem::mUpdateInterval
protected

◆ mUpperBound

C_FLOAT64 COptItem::mUpperBound
protected

The value of the upper bound (only if not on object)

Referenced by compileUpperBound().


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