Structure to hold a constant's details. More...

#include <const.h>

Public Member Functions
	Constant (const std::string &name, const double value, const double uncertainty, const std::string &unit, const std::string &reference)
	Parameterized constructor.

Public Attributes
const std::string	name
	Name of the constant.

const double	value
	Value of the constant.

const double	uncertainty
	Uncertainty in the constant's value.

const std::string	unit
	Unit of the constant.

const std::string	reference
	Reference for the constant's value.

Friends
std::ostream &	operator<< (std::ostream &os, const Constant &c)
	overload the << operator for pretty printing

Detailed Description

Structure to hold a constant's details.

Definition at line 31 of file const.h.

Constructor & Destructor Documentation

◆ Constant()

serif::constant::Constant::Constant	(	const std::string &	name,
		const double	value,
		const double	uncertainty,
		const std::string &	unit,
		const std::string &	reference )

inline

Parameterized constructor.

Parameters

name	The name of the constant.
value	The value of the constant.
uncertainty	The uncertainty in the constant's value.
unit	The unit of the constant.
reference	The reference for the constant's value.

Definition at line 46 of file const.h.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const Constant &	c )

friend

overload the << operator for pretty printing

Definition at line 52 of file const.h.

Member Data Documentation

◆ name

const std::string serif::constant::Constant::name

Name of the constant.

Definition at line 32 of file const.h.

◆ reference

const std::string serif::constant::Constant::reference

Reference for the constant's value.

Definition at line 36 of file const.h.

◆ uncertainty

const double serif::constant::Constant::uncertainty

Uncertainty in the constant's value.

Definition at line 34 of file const.h.

◆ unit

const std::string serif::constant::Constant::unit

Unit of the constant.

Definition at line 35 of file const.h.

◆ value

const double serif::constant::Constant::value

Value of the constant.

Definition at line 33 of file const.h.

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

src/constants/public/const.h

Public Member Functions

Public Attributes

Friends