units.h File Reference

Scientific units. More...

#include "rnr/rnrconfig.h"

Go to the source code of this file.

Enumerations
enum	units_t {   units_undef,   units_raw,   units_percent,   units_permil,   units_norm,   units_um,   units_mm,   units_cm,   units_m,   units_radians,   units_degrees,   units_um_per_s,   units_mm_per_s,   units_cm_per_s,   units_m_per_s,   units_rad_per_s,   units_deg_per_s,   units_rpm,   units_g,   units_m_per_s2,   units_kgf,   units_gf,   units_newton,   units_dyne,   units_volt,   units_amp,   units_ohm,   units_conductance,   units_compacitance,   units_t_f,   units_t_c,   units_t_k,   units_numof }
	Unit Types. More...

Functions
const char *	units_shortname (units_t u)
	Get the units name. More...

Detailed Description

Scientific units.

Package

RoadNarrows Robotics Common Library 1

Library

librnr

File

rnr/units.h

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2010-2018. RoadNarrows LLC..
http://www.roadnarrows.com
All Rights Reserved

License

MIT

EULA

See the README and EULA files for any copyright and licensing information.

—

Definition in file units.h.

Enumeration Type Documentation

enum units_t

Unit Types.

Enumerator
units_undef	undefined units
units_raw	raw, native device units
units_percent	percent % of maximum raw value
units_permil	permil ‰ of maximum raw value
units_norm	normalized units (continuous from -1 to 1)
units_um	micrometers
units_mm	millimeters
units_cm	centimeters
units_m	meters
units_radians	radians
units_degrees	degrees
units_um_per_s	micrometers/s
units_mm_per_s	millimeters/s
units_cm_per_s	centimeters/s
units_m_per_s	meters/s
units_rad_per_s	radians/s
units_deg_per_s	degrees/s
units_rpm	revolutions per minute
units_g	1 earth g = 9.80665m/s2
units_m_per_s2	meters/s2
units_kgf	kilogram-force: 1kgf = 9.80665 N
units_gf	gram-force: 1gf = 0.001kgf
units_newton	newton N = 1 kg x m / s2
units_dyne	dyne: 1 dyne = N-5
units_volt	volt
units_amp	ampheres
units_ohm	ohms
units_conductance	mho
units_compacitance	farad
units_t_f	Fahrenheit.
units_t_c	Celsius.
units_t_k	Kelvin.
units_numof	number of units

Definition at line 40 of file units.h.

{
  units_undef,      ///< undefined units

  // raw
  units_raw,        ///< raw, native device units

  // relative
  units_percent,    ///< percent % of maximum raw value
  units_permil,     ///< permil \h_permil of maximum raw value
  units_norm,       ///< normalized units (continuous from -1 to 1)

  // linear distance
  units_um,         ///< micrometers
  units_mm,         ///< millimeters
  units_cm,         ///< centimeters
  units_m,          ///< meters

  // angular distance
  units_radians,    ///< radians
  units_degrees,    ///< degrees

  // linear velocity
  units_um_per_s,   ///< micrometers/s
  units_mm_per_s,   ///< millimeters/s
  units_cm_per_s,   ///< centimeters/s
  units_m_per_s,    ///< meters/s

  // angular velocity
  units_rad_per_s,  ///< radians/s
  units_deg_per_s,  ///< degrees/s
  units_rpm,        ///< revolutions per minute

  // linear acceleration
  units_g,          ///< 1 earth g = 9.80665m/s<sup>2</sup>
  units_m_per_s2,   ///< meters/s<sup>2</sup>

  // force
  units_kgf,        ///< kilogram-force: 1kgf = 9.80665 N
  units_gf,         ///< gram-force: 1gf = 0.001kgf
  units_newton,     ///< newton N = 1 kg x m / s<sup>2</sup>
  units_dyne,       ///< dyne: 1 dyne = N<sup>-5</sup>
  
  // electrical
  units_volt,         ///< volt
  units_amp,          ///< ampheres
  units_ohm,          ///< ohms
  units_conductance,  ///< mho
  units_compacitance, ///< farad

  // temperature
  units_t_f,          ///< Fahrenheit 
  units_t_c,          ///< Celsius
  units_t_k,          ///< Kelvin
  
  // energy
  
  units_numof         ///< number of units
} units_t;

Function Documentation

const char* units_shortname

(

units_t

u

)

Get the units name.

Parameters

u	Name-Value Pair table

Returns

The associated units short name.

Definition at line 112 of file units.c.

References arraysize, and NvpVal2Name().

{
  return NvpVal2Name(UnitNamesTbl, arraysize(UnitNamesTbl), u);
}