copasi API  0.1
Public Types | Public Member Functions | Static Public Attributes
CPlotItem Class Reference

#include <CPlotItem.h>

Inheritance diagram for CPlotItem:
CCopasiParameterGroup CCopasiParameter CCopasiContainer CCopasiObject CPlotSpecification

List of all members.

Public Types

enum  Type {
  unset = 0, curve2d, histoItem1d, plot2d,
  simWiz
}

Public Member Functions

 CPlotItem (const std::string &name="NoName", const CCopasiContainer *pParent=NULL, const Type &type=curve2d)
 CPlotItem (const CPlotItem &src, const CCopasiContainer *pParent=NULL)
virtual ~CPlotItem ()
void cleanup ()
const CPlotItem::TypegetType () const
void setType (CPlotItem::Type type)
void setActivity (const COutputInterface::Activity &activity)
const COutputInterface::ActivitygetActivity () const
const std::string & getTitle () const
void setTitle (const std::string &title)
std::vector
< CPlotDataChannelSpec > & 
getChannels ()
const std::vector
< CPlotDataChannelSpec > & 
getChannels () const
unsigned C_INT32 getNumChannels () const
void addChannel (const CPlotDataChannelSpec &channel)

Static Public Attributes

static const std::string TypeName []
static const char * XMLType []
static const std::string RecordingActivityName []
static const char * XMLRecordingActivity []

Member Enumeration Documentation

Enumeration of the sub types of methods known to COPASI.

Enumerator:
unset 
curve2d 
histoItem1d 
plot2d 
simWiz 

Reimplemented from CCopasiParameter.


Constructor & Destructor Documentation

CPlotItem::CPlotItem ( const std::string &  name = "NoName",
const CCopasiContainer pParent = NULL,
const Type type = curve2d 
)
CPlotItem::CPlotItem ( const CPlotItem src,
const CCopasiContainer pParent = NULL 
)
CPlotItem::~CPlotItem ( ) [virtual]

Destructor


Member Function Documentation

void CPlotItem::addChannel ( const CPlotDataChannelSpec channel)
void CPlotItem::cleanup ( )

Reimplemented in CPlotSpecification.

const COutputInterface::Activity & CPlotItem::getActivity ( ) const
std::vector< CPlotDataChannelSpec > & CPlotItem::getChannels ( )
const std::vector< CPlotDataChannelSpec > & CPlotItem::getChannels ( ) const
unsigned C_INT32 CPlotItem::getNumChannels ( ) const
const std::string & CPlotItem::getTitle ( ) const
const CPlotItem::Type & CPlotItem::getType ( ) const

Retrieve the type of the method

Reimplemented from CCopasiParameter.

void CPlotItem::setActivity ( const COutputInterface::Activity activity)
void CPlotItem::setTitle ( const std::string &  title)
void CPlotItem::setType ( CPlotItem::Type  type)

Member Data Documentation

const std::string CPlotItem::RecordingActivityName [static]
Initial value:
{
  "",
  "Before",
  "During",
  "",
  "After"
}

String literals for the GUI to display recording activity names of plots known to COPASI.

const std::string CPlotItem::TypeName [static]
Initial value:
{
  "Unset",
  "2D Curve",
  "Histogram",

  "2D Plot",
  "SimWiz",
  ""
}

String literals for the GUI to display plot item names of methods known to COPASI.

Reimplemented from CCopasiParameter.

const char * CPlotItem::XMLRecordingActivity [static]
Initial value:
{
  "NotSet",
  "before",
  "during",
  "before&during",
  "after",
  "before&after",
  "during&after",
  "before&during&after",
  NULL
}

XML recording activity names of plots known to COPASI.

const char * CPlotItem::XMLType [static]
Initial value:
{
  "Unset",
  "Curve2D",
  "Histogram1DItem",

  "Plot2D",
  "SimWiz",
  NULL
}

XML sub type names of methods known to COPASI.

Reimplemented from CCopasiParameter.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines