NumeRe v1.1.4
NumeRe: Framework für Numerische Rechnungen
NumeRe::ClusterItem Class Reference

This is an abstract cluster item. It is used as root class of any cluster items and only contains the type of the item and virtual functions as interfaces to the child classes. More...

#include <cluster.hpp>

Inheritance diagram for NumeRe::ClusterItem:
Collaboration diagram for NumeRe::ClusterItem:

Public Types

enum  ClusterItemType { ITEMTYPE_INVALID = -1 , ITEMTYPE_MIXED , ITEMTYPE_DOUBLE , ITEMTYPE_STRING }
 Defines the available types of clusters. More...
 

Public Member Functions

 ClusterItem (unsigned short type)
 
virtual ~ClusterItem ()
 
unsigned short getType () const
 Returns the ClusterItemType. More...
 
virtual mu::value_type getDouble ()
 Base implementation. Returns always NaN. More...
 
virtual void setDouble (const mu::value_type &val)
 Base implementation. Does nothing. More...
 
virtual std::string getString ()
 Base implementation. Always returns an empty string. More...
 
virtual std::string getInternalString ()
 Base implementation. Returns an empty string. More...
 
virtual std::string getParserString ()
 Base implementation. Returns a string with quotation marks. More...
 
virtual void setString (const std::string &strval)
 Base implementation. Does nothing. More...
 

Private Attributes

unsigned short nType
 

Detailed Description

This is an abstract cluster item. It is used as root class of any cluster items and only contains the type of the item and virtual functions as interfaces to the child classes.

Definition at line 38 of file cluster.hpp.

Member Enumeration Documentation

◆ ClusterItemType

Defines the available types of clusters.

Enumerator
ITEMTYPE_INVALID 
ITEMTYPE_MIXED 
ITEMTYPE_DOUBLE 
ITEMTYPE_STRING 

Definition at line 48 of file cluster.hpp.

Constructor & Destructor Documentation

◆ ClusterItem()

NumeRe::ClusterItem::ClusterItem ( unsigned short  type)
inline

Definition at line 56 of file cluster.hpp.

◆ ~ClusterItem()

virtual NumeRe::ClusterItem::~ClusterItem ( )
inlinevirtual

Definition at line 57 of file cluster.hpp.

Member Function Documentation

◆ getDouble()

virtual mu::value_type NumeRe::ClusterItem::getDouble ( )
inlinevirtual

Base implementation. Returns always NaN.

Returns
virtual mu::value_type

Reimplemented in NumeRe::ClusterDoubleItem, and NumeRe::ClusterStringItem.

Definition at line 77 of file cluster.hpp.

◆ getInternalString()

virtual std::string NumeRe::ClusterItem::getInternalString ( )
inlinevirtual

Base implementation. Returns an empty string.

Returns
virtual std::string

Reimplemented in NumeRe::ClusterDoubleItem, and NumeRe::ClusterStringItem.

Definition at line 110 of file cluster.hpp.

Referenced by getParserString().

◆ getParserString()

virtual std::string NumeRe::ClusterItem::getParserString ( )
inlinevirtual

Base implementation. Returns a string with quotation marks.

Returns
virtual std::string

Reimplemented in NumeRe::ClusterDoubleItem.

Definition at line 122 of file cluster.hpp.

References getInternalString().

Here is the call graph for this function:

◆ getString()

virtual std::string NumeRe::ClusterItem::getString ( )
inlinevirtual

Base implementation. Always returns an empty string.

Returns
virtual std::string

Reimplemented in NumeRe::ClusterDoubleItem, and NumeRe::ClusterStringItem.

Definition at line 98 of file cluster.hpp.

◆ getType()

unsigned short NumeRe::ClusterItem::getType ( ) const
inline

Returns the ClusterItemType.

Returns
unsigned short

Definition at line 65 of file cluster.hpp.

References nType.

Referenced by NumeRe::Cluster::push_back().

◆ setDouble()

virtual void NumeRe::ClusterItem::setDouble ( const mu::value_type val)
inlinevirtual

Base implementation. Does nothing.

Parameters
valconst mu::value_type&
Returns
virtual void

Reimplemented in NumeRe::ClusterDoubleItem, and NumeRe::ClusterStringItem.

Definition at line 89 of file cluster.hpp.

◆ setString()

virtual void NumeRe::ClusterItem::setString ( const std::string &  strval)
inlinevirtual

Base implementation. Does nothing.

Parameters
strvalconst std::string&
Returns
virtual void

Reimplemented in NumeRe::ClusterDoubleItem, and NumeRe::ClusterStringItem.

Definition at line 134 of file cluster.hpp.

Member Data Documentation

◆ nType

unsigned short NumeRe::ClusterItem::nType
private

Definition at line 41 of file cluster.hpp.

Referenced by getType().


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