trick/trick_source/sim_services/Units/include/UnitsMap.hh
Alex Lin 14a75508a3 Cleaning up once include variables and copyright cleanup.
Changed all header file once include variables to follow the same naming
convention and not start with any underscores.  Also deleted old
incorrect copyright notices.  Also removed $Id: tags from all files.

Fixes #14.  Fixes #22.
2015-03-23 16:03:14 -05:00

62 lines
1.3 KiB
C++

/*
PURPOSE:
(UnitsMap)
*/
#ifndef UNITSMAP_HH
#define UNITSMAP_HH
#include <map>
#include <string>
namespace Trick {
/**
* This map stores all the variables and their units and
* provides a convenient way of getting variables units.
*/
class UnitsMap {
public:
/**
* Returns a pointer to the singleton Trick::UnitsMap instance.
* @return A pointer to Trick::UnitsMap.
*/
static Trick::UnitsMap * units_map() ;
/**
* Constructor.
*/
UnitsMap() {} ;
/**
* Destructor.
*/
~UnitsMap() ;
/**
* Adds a variable with specified units to the map.
* @param param The name of the variable.
* @param units The units of the variable.
*/
int add_param( std::string param , const char * units ) ;
/**
* Gets the units for a specified variable.
* @param param The name of the variable.
* @return The units of a specified variable.
*/
std::string get_units( std::string param ) ;
private:
std::map<std::string, char * > param_units ;
static Trick::UnitsMap* pInstance ;
} ;
}
#endif