Class for those physical parameters having dimensions of Inverse Length [L^-1]. More...

#include <ATMInverseLength.h>

Public Member Functions
	InverseLength ()
	Default constructor: Length value set to 0 m^-1. More...

	InverseLength (double inverseLength)
	A full constructor: value in default units (m^-1) More...

	InverseLength (double inverseLength, const std::string &units)
	A full constructor: value + units. More...

	InverseLength (const InverseLength &inverseLength)
	Copy constructor. More...

virtual	~InverseLength ()
	Destructor. More...

double	get () const
	Accessor to get the numerical value of inverse length (in International System units: m^-1) More...

double	get (const std::string &units) const
	Accessor to the inverse length value in specified units. More...

InverseLength &	operator= (const InverseLength &rhs)
	Operator "equal to a InverseLength". More...

InverseLength &	operator= (double rhs)
	Operator "equal to a double converted to InverseLength in m-1". More...

InverseLength	operator+ (const InverseLength &rhs)
	Operator "addition of inverse lengths". More...

InverseLength	operator- (const InverseLength &rhs)
	Operator "substraction of inverse lengths". More...

InverseLength	operator* (double scf)
	Operator "multiplication of a inverse length by a double". More...

InverseLength	operator* (float scf)
	Operator "multiplication of a inverse length by a float". More...

InverseLength	operator* (int scf)
	Operator "multiplication of a inverse length by an int". More...

InverseLength	operator* (unsigned int scf)
	Operator "multiplication of a inverse length by an unsigned int". More...

InverseLength	operator/ (double scf)
	Operator "division of a inverse length by a double". More...

InverseLength	operator/ (float scf)
	Operator "division of a inverse length by a float". More...

InverseLength	operator/ (int scf)
	Operator "division of a inverse length by an int". More...

InverseLength	operator/ (unsigned int scf)
	Operator "division of a inverse length by an unsigned int". More...

bool	operator< (const InverseLength &rhs) const
	Operator "comparator < for two inverse lengths". More...

bool	operator> (const InverseLength &rhs) const
	Operator "comparator > for two inverse lengths". More...

bool	operator<= (const InverseLength &rhs) const
	Operator "comparator <= for two inverse lengths". More...

bool	operator>= (const InverseLength &rhs) const
	Operator "comparator >= for two inverse lengths". More...

bool	operator== (const InverseLength &rhs) const
	Operator "comparator == for two inverse lengths". More...

bool	operator!= (const InverseLength &rhs) const
	Operator "comparator != for two inverse lengths". More...

Static Private Member Functions
static double	sget (double value, const std::string &units)

static double	sput (double value, const std::string &units)

Private Attributes
double	valueIS_

Detailed Description

Class for those physical parameters having dimensions of Inverse Length [L^-1].

This class is defined for those physical parameters that have units of Inverse Length, for example the absorption coefficients. Desfault units are m^-1 (International System).

Definition at line 43 of file ATMInverseLength.h.

Constructor & Destructor Documentation

InverseLength::InverseLength ( )

Default constructor: Length value set to 0 m^-1.

Referenced by operator*(), operator+(), operator-(), and operator/().

InverseLength::InverseLength ( double inverseLength )

A full constructor: value in default units (m^-1)

InverseLength::InverseLength	(	double	inverseLength,
		const std::string &	units
	)

A full constructor: value + units.

Valid units are: km-1 [KM-1], m-1 [M-1], mm-1 [MM-1], micron-1 [MICRON-1], nm-1 [NM-1].

InverseLength::InverseLength ( const InverseLength & inverseLength )

Copy constructor.

virtual InverseLength::~InverseLength ( )

virtual

Destructor.

Member Function Documentation

double InverseLength::get ( ) const

inline

Accessor to get the numerical value of inverse length (in International System units: m^-1)

Definition at line 59 of file ATMInverseLength.h.

References valueIS_.

Referenced by operator!=(), operator+(), operator-(), operator<(), operator<=(), operator==(), operator>(), and operator>=().

double InverseLength::get ( const std::string & units ) const

inline

Accessor to the inverse length value in specified units.

Implemented units are km-1 [KM-1], m-1 [M-1], mm-1 [MM-1], micron-1 [MICRON-1], nm-1 [NM-1]. If none of these implemented units is given, the SI value will be returned.

Definition at line 62 of file ATMInverseLength.h.

References sget(), and valueIS_.

bool InverseLength::operator!= ( const InverseLength & rhs ) const

inline

Operator "comparator != for two inverse lengths".

Definition at line 99 of file ATMInverseLength.h.

References get(), and valueIS_.

InverseLength InverseLength::operator* ( double scf )

inline

Operator "multiplication of a inverse length by a double".

Definition at line 73 of file ATMInverseLength.h.

References InverseLength(), and valueIS_.

InverseLength InverseLength::operator* ( float scf )

inline

Operator "multiplication of a inverse length by a float".

Definition at line 75 of file ATMInverseLength.h.

References InverseLength(), and valueIS_.

InverseLength InverseLength::operator* ( int scf )

inline

Operator "multiplication of a inverse length by an int".

Definition at line 77 of file ATMInverseLength.h.

References InverseLength(), and valueIS_.

InverseLength InverseLength::operator* ( unsigned int scf )

inline

Operator "multiplication of a inverse length by an unsigned int".

Definition at line 79 of file ATMInverseLength.h.

References InverseLength(), and valueIS_.

InverseLength InverseLength::operator+ ( const InverseLength & rhs )

inline

Operator "addition of inverse lengths".

Definition at line 69 of file ATMInverseLength.h.

References get(), InverseLength(), and valueIS_.

InverseLength InverseLength::operator- ( const InverseLength & rhs )

inline

Operator "substraction of inverse lengths".

Definition at line 71 of file ATMInverseLength.h.

References get(), InverseLength(), and valueIS_.

InverseLength InverseLength::operator/ ( double scf )

inline

Operator "division of a inverse length by a double".

Definition at line 81 of file ATMInverseLength.h.

References InverseLength(), and valueIS_.

InverseLength InverseLength::operator/ ( float scf )

inline

Operator "division of a inverse length by a float".

Definition at line 83 of file ATMInverseLength.h.

References InverseLength(), and valueIS_.

InverseLength InverseLength::operator/ ( int scf )

inline

Operator "division of a inverse length by an int".

Definition at line 85 of file ATMInverseLength.h.

References InverseLength(), and valueIS_.

InverseLength InverseLength::operator/ ( unsigned int scf )

inline

Operator "division of a inverse length by an unsigned int".

Definition at line 87 of file ATMInverseLength.h.

References InverseLength(), and valueIS_.

bool InverseLength::operator< ( const InverseLength & rhs ) const

inline

Operator "comparator < for two inverse lengths".

Definition at line 89 of file ATMInverseLength.h.

References get(), and valueIS_.

bool InverseLength::operator<= ( const InverseLength & rhs ) const

inline

Operator "comparator <= for two inverse lengths".

Definition at line 93 of file ATMInverseLength.h.

References get(), and valueIS_.

InverseLength& InverseLength::operator= ( const InverseLength & rhs )

inline

Operator "equal to a InverseLength".

Definition at line 65 of file ATMInverseLength.h.

References valueIS_.

InverseLength& InverseLength::operator= ( double rhs )

inline

Operator "equal to a double converted to InverseLength in m-1".

Definition at line 67 of file ATMInverseLength.h.

References valueIS_.

bool InverseLength::operator== ( const InverseLength & rhs ) const

inline

Operator "comparator == for two inverse lengths".

Definition at line 97 of file ATMInverseLength.h.

References get(), and valueIS_.

bool InverseLength::operator> ( const InverseLength & rhs ) const

inline

Operator "comparator > for two inverse lengths".

Definition at line 91 of file ATMInverseLength.h.

References get(), and valueIS_.

bool InverseLength::operator>= ( const InverseLength & rhs ) const

inline

Operator "comparator >= for two inverse lengths".

Definition at line 95 of file ATMInverseLength.h.

References get(), and valueIS_.

static double InverseLength::sget	(	double	value,
		const std::string &	units
	)

staticprivate

Referenced by get().

static double InverseLength::sput	(	double	value,
		const std::string &	units
	)

staticprivate

Member Data Documentation

double InverseLength::valueIS_

private

Definition at line 106 of file ATMInverseLength.h.

Referenced by get(), operator!=(), operator*(), operator+(), operator-(), operator/(), operator<(), operator<=(), operator=(), operator==(), operator>(), and operator>=().

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

casa/code/atmosphere/ATM/ATMInverseLength.h

Public Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation