libviennashe::quantity::quantitiy_register Class Reference

The main quantity register. Not deep copy-able! More...

#include <quantity_wrappers.hpp>

Public Types
typedef std::map< std::string, quantity_wrapper * >	quan_map

Public Member Functions
virtual	~quantitiy_register ()
std::size_t	size () const
	Returns the number of registered quantities. More...
std::vector< std::string >	get_names () const
	Returns all names of the registered quantities. More...
quantity_wrapper const &	get (std::string const &name) const
	Returns a single const reference to a quantitiy wrapper. More...
bool	has_quan (std::string const &name) const
	Returns true if a quantity is registered. More...
void	register_quan (quantity_wrapper const &quan)
	Registers a quantity. More...

Detailed Description

The main quantity register. Not deep copy-able!

Definition at line 228 of file quantity_wrappers.hpp.

Member Typedef Documentation

quan_map

typedef std::map<std::string, quantity_wrapper * > libviennashe::quantity::quantitiy_register::quan_map

Definition at line 231 of file quantity_wrappers.hpp.

Constructor & Destructor Documentation

~quantitiy_register()

virtual libviennashe::quantity::quantitiy_register::~quantitiy_register ( )

inlinevirtual

Definition at line 233 of file quantity_wrappers.hpp.

Member Function Documentation

get()

quantity_wrapper const & libviennashe::quantity::quantitiy_register::get ( std::string const &  name ) const

inline

Returns a single const reference to a quantitiy wrapper.

Parameters

name	The name of the quantity to retrieve

Definition at line 260 of file quantity_wrappers.hpp.

get_names()

std::vector< std::string > libviennashe::quantity::quantitiy_register::get_names ( ) const

inline

Returns all names of the registered quantities.

Definition at line 247 of file quantity_wrappers.hpp.

has_quan()

bool libviennashe::quantity::quantitiy_register::has_quan ( std::string const &  name ) const

inline

Returns true if a quantity is registered.

Parameters

name	The name of the quantity

Returns

true if the quantity exists (is registered)

Definition at line 267 of file quantity_wrappers.hpp.

register_quan()

void libviennashe::quantity::quantitiy_register::register_quan ( quantity_wrapper const &  quan )

inline

Registers a quantity.

Parameters

quan	The quantity by reference. Will be copied using quan.copy()!

Definition at line 272 of file quantity_wrappers.hpp.

size()

std::size_t libviennashe::quantity::quantitiy_register::size ( ) const

inline

Returns the number of registered quantities.

Definition at line 244 of file quantity_wrappers.hpp.

---

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

• libviennashe/src/quantity_wrappers.hpp