Class simtix::stat::StatBase

ClassList > simtix > stat > StatBase

All visible stat objects will inherit this base class.

• #include <statistics.h>

Inherited by the following classes: simtix::stat::Formula, simtix::stat::Vector, simtix::stat::Formula, simtix::stat::ScalarBase, simtix::stat::Vector

Public Functions

Type	Name
	StatBase (Group * parent, const std::string & name, const std::string & desc, const std::string & unit) Register itself to the parent if any exist.
virtual toml::table	Tabularize () const = 0
const std::string &	desc () const
const std::string &	name () const
const std::string &	unit () const

Protected Attributes

Type	Name
std::string	desc_
std::string	name_
Group *	parent_
std::string	unit_

Public Functions Documentation

function StatBase

Register itself to the parent if any exist.

explicit simtix::stat::StatBase::StatBase (
    Group * parent,
    const std::string & name,
    const std::string & desc,
    const std::string & unit
) 

---

function Tabularize

virtual toml::table simtix::stat::StatBase::Tabularize () const = 0

---

function desc

inline const std::string & simtix::stat::StatBase::desc () const

---

function name

inline const std::string & simtix::stat::StatBase::name () const

---

function unit

inline const std::string & simtix::stat::StatBase::unit () const

---

Protected Attributes Documentation

variable desc_

std::string simtix::stat::StatBase::desc_;

---

variable name_

std::string simtix::stat::StatBase::name_;

---

variable parent_

Group* simtix::stat::StatBase::parent_;

---

variable unit_

std::string simtix::stat::StatBase::unit_;

---

---

The documentation for this class was generated from the following file projects/simtix/include/simtix/statistics.h