COPASI API  4.16.103
Classes | Public Member Functions | Protected Attributes | List of all members
CAbstractLayoutInterface Class Referenceabstract

#include <CAbstractLayoutInterface.h>

Inheritance diagram for CAbstractLayoutInterface:
Inheritance graph
[legend]
Collaboration diagram for CAbstractLayoutInterface:
Collaboration graph
[legend]

Classes

class  VariableDescription
 

Public Member Functions

 CAbstractLayoutInterface ()
 
virtual const std::vector
< double > & 
getInitialValues () const =0
 
virtual const std::vector
< double > & 
getMassVector () const
 
unsigned int getNumVariables () const
 
virtual double getPotential ()=0
 
const std::vector
< VariableDescription > & 
getVariablesDescription () const
 
virtual bool setState (const std::vector< double > &vars)=0
 
virtual ~CAbstractLayoutInterface ()
 

Protected Attributes

std::vector< double > mMassVector
 
std::vector< VariableDescriptionmVarDescription
 

Detailed Description

This abstract class describes how an optimization algorithm will see a layout.

Definition at line 15 of file CAbstractLayoutInterface.h.

Constructor & Destructor Documentation

CAbstractLayoutInterface::CAbstractLayoutInterface ( )
inline

Definition at line 18 of file CAbstractLayoutInterface.h.

18 {};
virtual CAbstractLayoutInterface::~CAbstractLayoutInterface ( )
inlinevirtual

Definition at line 19 of file CAbstractLayoutInterface.h.

19 {};

Member Function Documentation

virtual const std::vector<double>& CAbstractLayoutInterface::getInitialValues ( ) const
pure virtual

Implemented in CCopasiSpringLayout.

Referenced by CLayoutEngine::CLayoutEngine().

const std::vector< double > & CAbstractLayoutInterface::getMassVector ( ) const
virtual

Definition at line 27 of file CAbstractLayoutInterface.cpp.

References mMassVector.

Referenced by CLayoutEngine::calcRHS().

28 {
29  return mMassVector;
30 }
std::vector< double > mMassVector
unsigned int CAbstractLayoutInterface::getNumVariables ( ) const

Definition at line 17 of file CAbstractLayoutInterface.cpp.

References mVarDescription.

Referenced by CLayoutEngine::calcForces(), and CLayoutEngine::calcRHS().

18 {
19  return mVarDescription.size();
20 }
std::vector< VariableDescription > mVarDescription
virtual double CAbstractLayoutInterface::getPotential ( )
pure virtual
const std::vector< CAbstractLayoutInterface::VariableDescription > & CAbstractLayoutInterface::getVariablesDescription ( ) const

Definition at line 22 of file CAbstractLayoutInterface.cpp.

References mVarDescription.

23 {
24  return mVarDescription;
25 }
std::vector< VariableDescription > mVarDescription
virtual bool CAbstractLayoutInterface::setState ( const std::vector< double > &  vars)
pure virtual

Member Data Documentation

std::vector<double> CAbstractLayoutInterface::mMassVector
protected
std::vector<VariableDescription> CAbstractLayoutInterface::mVarDescription
protected

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