COPASI API  4.40.278
CLDimensions Class Reference

#include <CLBase.h>

Inheritance diagram for CLDimensions:
[legend]

Public Member Functions

 CLDimensions ()
 
 CLDimensions (const C_FLOAT64 &w, const C_FLOAT64 &h, const C_FLOAT64 &d=0.0)
 
 CLDimensions (const Dimensions &d)
 
C_FLOAT64getDepth ()
 
const C_FLOAT64getDepth () const
 
C_FLOAT64getHeight ()
 
const C_FLOAT64getHeight () const
 
Dimensions getSBMLDimensions () const
 
C_FLOAT64getWidth ()
 
const C_FLOAT64getWidth () const
 
bool isEmpty () const
 
void scale (const double &scaleFactor)
 
void setDepth (const C_FLOAT64 &d)
 
void setHeight (const C_FLOAT64 &h)
 
void setWidth (const C_FLOAT64 &w)
 
- Public Member Functions inherited from CLBase
 CLBase ()
 
 CLBase (const CLBase &b)
 
 CLBase (const SBase &)
 
const std::string & getTag () const
 
bool hasTag () const
 
virtual void moveBy (const CLPoint &)
 
void setTag (const std::string &tag)
 
virtual ~CLBase ()
 

Protected Attributes

C_FLOAT64 mDepth
 
C_FLOAT64 mHeight
 
C_FLOAT64 mWidth
 
- Protected Attributes inherited from CLBase
std::string mTag
 

Friends

std::ostream & operator<< (std::ostream &os, const CLDimensions &d)
 

Detailed Description

This class describes a size in a layout. It is 2-dimensional at the moment.

Constructor & Destructor Documentation

◆ CLDimensions() [1/3]

CLDimensions::CLDimensions ( )
inline

◆ CLDimensions() [2/3]

CLDimensions::CLDimensions ( const C_FLOAT64 w,
const C_FLOAT64 h,
const C_FLOAT64 d = 0.0 
)
inline

◆ CLDimensions() [3/3]

CLDimensions::CLDimensions ( const Dimensions &  d)

constructor from libsbml object

Member Function Documentation

◆ getDepth() [1/2]

C_FLOAT64& CLDimensions::getDepth ( )
inline

References mDepth.

◆ getDepth() [2/2]

const C_FLOAT64& CLDimensions::getDepth ( ) const
inline

◆ getHeight() [1/2]

C_FLOAT64& CLDimensions::getHeight ( )
inline

References mHeight.

◆ getHeight() [2/2]

◆ getSBMLDimensions()

Dimensions CLDimensions::getSBMLDimensions ( ) const

convert to sbml dimension

References mDepth, mHeight, and mWidth.

Referenced by CLayout::exportToSBML().

◆ getWidth() [1/2]

C_FLOAT64& CLDimensions::getWidth ( )
inline

References mWidth.

◆ getWidth() [2/2]

◆ isEmpty()

bool CLDimensions::isEmpty ( ) const
inline

References mDepth, mHeight, and mWidth.

Referenced by CLBoundingBox::isEmpty().

◆ scale()

void CLDimensions::scale ( const double &  scaleFactor)
inline

References mDepth, mHeight, and mWidth.

Referenced by CLayout::scale(), and CLBoundingBox::scale().

◆ setDepth()

void CLDimensions::setDepth ( const C_FLOAT64 d)
inline

References mDepth.

Referenced by DimensionsHandler::processStart().

◆ setHeight()

void CLDimensions::setHeight ( const C_FLOAT64 h)
inline

◆ setWidth()

void CLDimensions::setWidth ( const C_FLOAT64 w)
inline

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const CLDimensions d 
)
friend

insert operator

Member Data Documentation

◆ mDepth

C_FLOAT64 CLDimensions::mDepth
protected

◆ mHeight

C_FLOAT64 CLDimensions::mHeight
protected

◆ mWidth

C_FLOAT64 CLDimensions::mWidth
protected

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