cmnUnits.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */
 
/*
  Author(s):  Anton Deguet
  Created on: 2008-08-21
 
  (C) Copyright 2008-2015 Johns Hopkins University (JHU), All Rights Reserved.
 
--- begin cisst license - do not edit ---
 
This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.
 
--- end cisst license ---
 
*/
 

#pragma once
 
#ifndef _cmnUnits_h
#define _cmnUnits_h
 
// To determine if we are using SI (m) or millimeters by default
#include <cisstConfig.h>
 
// Always include last
#include <cisstCommon/cmnExport.h>
 
 


#if CISST_USE_SI_UNITS
const double cmn_mm = 0.001;
#else
const double cmn_mm = 1.0;
#endif

inline double cmnInternalTo_mm(double valueInternalUnits) {
    return valueInternalUnits / cmn_mm;
}

const double cmn_um = cmn_mm / 1000.0;

inline double cmnInternalTo_um(double valueInternalUnits) {
    return valueInternalUnits / cmn_um;
}

const double cmn_cm = 10.0 * cmn_mm;

inline double cmnInternalTo_cm(double valueInternalUnits) {
    return valueInternalUnits / cmn_cm;
}

#if CISST_USE_SI_UNITS
const double cmn_m = 1.0;
#else
const double cmn_m = 1000.0;
#endif

inline double cmnInternalTo_m(double valueInternalUnits) {
    return valueInternalUnits / cmn_m;
}

const double cmn_km = 1000.0 * cmn_m;

inline double cmnInternalTo_km(double valueInternalUnits) {
    return valueInternalUnits / cmn_km;
}

 
 


#if CISST_USE_SI_UNITS
const double cmn_g = 0.001;
#else
const double cmn_g = 1.0;
#endif

inline double cmnInternalTo_g(double valueInternalUnits) {
    return valueInternalUnits / cmn_g;
}

const double cmn_mg = cmn_g / 1000.0;

inline double cmnInternalTo_mg(double valueInternalUnits) {
    return valueInternalUnits / cmn_mg;
}

const double cmn_ug = cmn_mg / 1000.0;

inline double cmnInternalTo_ug(double valueInternalUnits) {
    return valueInternalUnits / cmn_ug;
}

const double cmn_cg = cmn_g / 100.0;

inline double cmnInternalTo_cg(double valueInternalUnits) {
    return valueInternalUnits / cmn_cg;
}

const double cmn_kg = 1000.0 * cmn_g;

inline double cmnInternalTo_kg(double valueInternalUnits) {
    return valueInternalUnits / cmn_kg;
}

 
 


const double cmn_s = 1.0;

inline double cmnInternalTo_s(double valueInternalUnits) {
    return valueInternalUnits / cmn_s;
}

const double cmn_ms = cmn_s / 1000.0;

inline double cmnInternalTo_ms(double valueInternalUnits) {
    return valueInternalUnits / cmn_ms;
}

const double cmn_us = cmn_ms / 1000.0;

inline double cmnInternalTo_us(double valueInternalUnits) {
    return valueInternalUnits / cmn_us;
}

const double cmn_ns = cmn_us / 1000.0;

inline double cmnInternalTo_ns(double valueInternalUnits) {
    return valueInternalUnits / cmn_ns;
}

const double cmn_minute = 60.0 * cmn_s;

inline double cmnInternalTo_minute(double valueInternalUnits) {
    return valueInternalUnits / cmn_minute;
}

const double cmn_hour = 60.0 * cmn_minute;

inline double cmnInternalTo_hour(double valueInternalUnits) {
    return valueInternalUnits / cmn_hour;
}

const double cmn_day = 24.0 * cmn_hour;

inline double cmnInternalTo_day(double valueInternalUnits) {
    return valueInternalUnits / cmn_day;
}

inline double cmnHzToPeriod(const double frequencyInHz) {
    return cmn_s / frequencyInHz;
}

 
 
#endif // _cmnUnits_h