GranOO  3.0
A robust and versatile workbench to build 3D dynamic simulations based on the Discrete Element Method
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
GranOO3::Math::Variable Class Reference

#include <Variable.hpp>

Inheritance diagram for GranOO3::Math::Variable:
Inheritance graph
[legend]

Public Member Functions

 Variable (const std::string &id, double &var)
 
 Variable (const std::string &id, double &var, const std::string &desc)
 
 ~Variable ()
 
const std::string & symbol () const
 
- Public Member Functions inherited from GranOO3::Core::Mapped< Variable >
const std::string & get_ID () const
 
void set_ID (const std::string &)
 

Static Public Member Functions

static Variableglob (const std::string &id)
 
static std::string class_ID ()
 
- Static Public Member Functions inherited from GranOO3::Core::Mapped< Variable >
static Variable & get (const std::string &id)
 
static const Variable & get_const (const std::string &id)
 
static bool exist (const std::string &id)
 
static Mapget_map ()
 

Private Member Functions

 Variable ()=delete
 
 Variable (const Variable &)=delete
 
Variableoperator= (const Variable &)=delete
 

Private Attributes

double & _variable
 
const std::string _symbol
 
const std::string _description
 

Additional Inherited Members

- Public Types inherited from GranOO3::Core::Mapped< Variable >
typedef std::map< const std::string, Variable * > Map
 
- Protected Member Functions inherited from GranOO3::Core::Mapped< Variable >
 Mapped (const std::string &id)
 
 Mapped ()
 
virtual ~Mapped ()
 

Constructor & Destructor Documentation

◆ Variable() [1/4]

GranOO3::Math::Variable::Variable ( const std::string &  id,
double &  var 
)

◆ Variable() [2/4]

GranOO3::Math::Variable::Variable ( const std::string &  id,
double &  var,
const std::string &  desc 
)

◆ ~Variable()

GranOO3::Math::Variable::~Variable ( )

◆ Variable() [3/4]

GranOO3::Math::Variable::Variable ( )
privatedelete

◆ Variable() [4/4]

GranOO3::Math::Variable::Variable ( const Variable )
privatedelete

Member Function Documentation

◆ class_ID()

static std::string GranOO3::Math::Variable::class_ID ( )
inlinestatic

◆ glob()

Variable & GranOO3::Math::Variable::glob ( const std::string &  id)
static

◆ operator=()

Variable& GranOO3::Math::Variable::operator= ( const Variable )
privatedelete

◆ symbol()

const std::string & GranOO3::Math::Variable::symbol ( ) const

Member Data Documentation

◆ _description

const std::string GranOO3::Math::Variable::_description
private

◆ _symbol

const std::string GranOO3::Math::Variable::_symbol
private

◆ _variable

double& GranOO3::Math::Variable::_variable
private

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