casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Private Attributes | Friends
asdm::Humidity Class Reference

The Humidity class implements a quantity of humidity in percent. More...

#include <Humidity.h>

List of all members.

Public Member Functions

 Humidity ()
 The nullary constructor (default).
 Humidity (const Humidity &)
 The copy constructor.
 Humidity (const string &s)
 A constructor from a string representation.
 Humidity (const IDLHumidity &idlHumidity)
 A constructor from a CORBA/IDL representation.
 Humidity (double value)
 A constructor from a value in double precision.
virtual ~Humidity ()
 The destructor.
void toBin (EndianOSStream &eoss)
 Write the binary representation of this to an EndianOSStream .
Humidityoperator= (const Humidity &x)
 An assignment operator Humidity = Humidity.
Humidityoperator= (const double d)
 An assignment operator Humidity = double.
Humidityoperator+= (const Humidity &x)
 Operator increment and assign.
Humidityoperator-= (const Humidity &x)
 Operator decrement and assign.
Humidityoperator*= (const double x)
 Operator multiply and assign.
Humidityoperator/= (const double x)
 Operator divide and assign.
Humidity operator+ (const Humidity &x) const
 Addition operator.
Humidity operator- (const Humidity &x) const
 Substraction operator.
Humidity operator* (const double x) const
 Multiplication operator.
Humidity operator/ (const double x) const
 Division operator.
bool operator< (const Humidity &x) const
 Comparison operator.
bool operator> (const Humidity &x) const
 Comparison operator.
bool operator<= (const Humidity &x) const
 Comparison operator.
bool operator>= (const Humidity &x) const
 Comparison operator.
bool operator== (const Humidity &x) const
 Comparision operator.
bool equals (const Humidity &x) const
 Comparison method.
bool operator!= (const Humidity &x) const
 Comparison operator.
bool isZero () const
 Comparison method.
Humidity operator- () const
 Unary operator.
Humidity operator+ () const
 Unary operator.
string toString () const
 Converts into a string.
string toStringI () const
 Idem toString.
 operator string () const
 Conversion operator.
double get () const
 Return the double precision value of the Humidity.
IDLHumidity toIDLHumidity () const
 Return the IDLHumidity representation of the Humidity.
 Humidity ()
 The nullary constructor (default).
 Humidity (const Humidity &)
 The copy constructor.
 Humidity (const string &s)
 A constructor from a string representation.
 Humidity (const IDLHumidity &idlHumidity)
 A constructor from a CORBA/IDL representation.
 Humidity (double value)
 A constructor from a value in double precision.
virtual ~Humidity ()
 The destructor.
void toBin (EndianOSStream &eoss)
 Write the binary representation of this to an EndianOSStream .
Humidityoperator= (const Humidity &x)
 An assignment operator Humidity = Humidity.
Humidityoperator= (const double d)
 An assignment operator Humidity = double.
Humidityoperator+= (const Humidity &x)
 Operator increment and assign.
Humidityoperator-= (const Humidity &x)
 Operator decrement and assign.
Humidityoperator*= (const double x)
 Operator multiply and assign.
Humidityoperator/= (const double x)
 Operator divide and assign.
Humidity operator+ (const Humidity &x) const
 Addition operator.
Humidity operator- (const Humidity &x) const
 Substraction operator.
Humidity operator* (const double x) const
 Multiplication operator.
Humidity operator/ (const double x) const
 Division operator.
bool operator< (const Humidity &x) const
 Comparison operator.
bool operator> (const Humidity &x) const
 Comparison operator.
bool operator<= (const Humidity &x) const
 Comparison operator.
bool operator>= (const Humidity &x) const
 Comparison operator.
bool operator== (const Humidity &x) const
 Comparision operator.
bool equals (const Humidity &x) const
 Comparison method.
bool operator!= (const Humidity &x) const
 Comparison operator.
bool isZero () const
 Comparison method.
Humidity operator- () const
 Unary operator.
Humidity operator+ () const
 Unary operator.
string toString () const
 Converts into a string.
string toStringI () const
 Idem toString.
 operator string () const
 Conversion operator.
double get () const
 Return the double precision value of the Humidity.
IDLHumidity toIDLHumidity () const
 Return the IDLHumidity representation of the Humidity.

Static Public Member Functions

static double fromString (const string &s)
 A static method equivalent to the constructor from a string.
static string toString (double)
 Conversion into string.
static Humidity getHumidity (StringTokenizer &st) throw (NumberFormatException)
 Parse the next (string) token of a StringTokenizer into an angle.
static void toBin (const vector< Humidity > &angle, EndianOSStream &eoss)
 Write the binary representation of a vector of Humidity to a EndianOSStream.
static void toBin (const vector< vector< Humidity > > &angle, EndianOSStream &eoss)
 Write the binary representation of a vector of vector of Humidity to a EndianOSStream.
static void toBin (const vector< vector< vector< Humidity > > > &angle, EndianOSStream &eoss)
 Write the binary representation of a vector of vector of vector of Humidity to a EndianOSStream.
static Humidity fromBin (EndianIStream &eis)
 Read the binary representation of an Humidity from a EndianIStream and use the read value to set an Humidity.
static vector< Humidityfrom1DBin (EndianIStream &eis)
 Read the binary representation of a vector of Humidity from an EndianIStream and use the read value to set a vector of Humidity.
static vector< vector< Humidity > > from2DBin (EndianIStream &eis)
 Read the binary representation of a vector of vector of Humidity from an EndianIStream and use the read value to set a vector of vector of Humidity.
static vector< vector< vector
< Humidity > > > 
from3DBin (EndianIStream &eis)
 Read the binary representation of a vector of vector of vector of Humidity from an EndianIStream and use the read value to set a vector of vector of vector of Humidity.
static string unit ()
 Returns the abbreviated name of the unit implicitely associated to any Humidity.
static double fromString (const string &s)
 A static method equivalent to the constructor from a string.
static string toString (double)
 Conversion into string.
static Humidity getHumidity (StringTokenizer &st) throw (NumberFormatException)
 Parse the next (string) token of a StringTokenizer into an angle.
static void toBin (const vector< Humidity > &angle, EndianOSStream &eoss)
 Write the binary representation of a vector of Humidity to a EndianOSStream.
static void toBin (const vector< vector< Humidity > > &angle, EndianOSStream &eoss)
 Write the binary representation of a vector of vector of Humidity to a EndianOSStream.
static void toBin (const vector< vector< vector< Humidity > > > &angle, EndianOSStream &eoss)
 Write the binary representation of a vector of vector of vector of Humidity to a EndianOSStream.
static Humidity fromBin (EndianIStream &eis)
 Read the binary representation of an Humidity from a EndianIStream and use the read value to set an Humidity.
static vector< Humidityfrom1DBin (EndianIStream &eis)
 Read the binary representation of a vector of Humidity from an EndianIStream and use the read value to set a vector of Humidity.
static vector< vector< Humidity > > from2DBin (EndianIStream &eis)
 Read the binary representation of a vector of vector of Humidity from an EndianIStream and use the read value to set a vector of vector of Humidity.
static vector< vector< vector
< Humidity > > > 
from3DBin (EndianIStream &eis)
 Read the binary representation of a vector of vector of vector of Humidity from an EndianIStream and use the read value to set a vector of vector of vector of Humidity.
static string unit ()
 Returns the abbreviated name of the unit implicitely associated to any Humidity.

Private Attributes

double value

Friends

Humidity operator* (double d, const Humidity &x)
 Overloading of multiplication operator.
ostream & operator<< (ostream &os, const Humidity &x)
 Overloading of << to output the value an Humidity on an ostream.
istream & operator>> (istream &is, Humidity &x)
 Overloading of >> to read an Humidity from an istream.
Humidity operator* (double d, const Humidity &x)
 Overloading of multiplication operator.
ostream & operator<< (ostream &os, const Humidity &x)
 Overloading of << to output the value an Humidity on an ostream.
istream & operator>> (istream &is, Humidity &x)
 Overloading of >> to read an Humidity from an istream.

Detailed Description

The Humidity class implements a quantity of humidity in percent.

Version:
1.00 Jan. 7, 2005
Author:
Allen Farris
Version:
1.1 Aug 8, 2006
Author:
Michel Caillat added toBin/fromBin methods.

Definition at line 59 of file Humidity.h.


Constructor & Destructor Documentation

The nullary constructor (default).

Humidity constructors.

Definition at line 322 of file Humidity.h.

asdm::Humidity::Humidity ( const Humidity t) [inline]

The copy constructor.

Definition at line 324 of file Humidity.h.

asdm::Humidity::Humidity ( const string &  s) [inline]

A constructor from a string representation.

The string passed in argument must be parsable into a double precision number to express the value in radian of the angle.

Parameters:
sa string.

Definition at line 330 of file Humidity.h.

asdm::Humidity::Humidity ( const IDLHumidity &  idlHumidity) [inline]

A constructor from a CORBA/IDL representation.

Parameters:
idlHumiditya cons ref to an IDLHumidity.

Definition at line 327 of file Humidity.h.

asdm::Humidity::Humidity ( double  value) [inline]

A constructor from a value in double precision.

The value passed in argument defines the value of the Humidity in radian.

Definition at line 332 of file Humidity.h.

asdm::Humidity::~Humidity ( ) [inline, virtual]

The destructor.

Humidity destructor.

Definition at line 335 of file Humidity.h.

The nullary constructor (default).

The copy constructor.

asdm::Humidity::Humidity ( const string &  s)

A constructor from a string representation.

The string passed in argument must be parsable into a double precision number to express the value in radian of the angle.

Parameters:
sa string.
asdm::Humidity::Humidity ( const IDLHumidity &  idlHumidity)

A constructor from a CORBA/IDL representation.

Parameters:
idlHumiditya cons ref to an IDLHumidity.
asdm::Humidity::Humidity ( double  value)

A constructor from a value in double precision.

The value passed in argument defines the value of the Humidity in radian.

virtual asdm::Humidity::~Humidity ( ) [virtual]

The destructor.


Member Function Documentation

bool asdm::Humidity::equals ( const Humidity x) const [inline]

Comparison method.

Equality.

Parameters:
xa const reference to a Humidity.

Definition at line 397 of file Humidity.h.

References value.

bool asdm::Humidity::equals ( const Humidity x) const

Comparison method.

Equality.

Parameters:
xa const reference to a Humidity.
static vector<Humidity> asdm::Humidity::from1DBin ( EndianIStream eis) [static]

Read the binary representation of a vector of Humidity from an EndianIStream and use the read value to set a vector of Humidity.

Parameters:
eisa reference to the EndianIStream to be read
Returns:
a vector of Humidity
static vector<Humidity> asdm::Humidity::from1DBin ( EndianIStream eis) [static]

Read the binary representation of a vector of Humidity from an EndianIStream and use the read value to set a vector of Humidity.

Parameters:
eisa reference to the EndianIStream to be read
Returns:
a vector of Humidity
static vector<vector<Humidity> > asdm::Humidity::from2DBin ( EndianIStream eis) [static]

Read the binary representation of a vector of vector of Humidity from an EndianIStream and use the read value to set a vector of vector of Humidity.

Parameters:
eisthe EndianIStream to be read
Returns:
a vector of vector of Humidity
static vector<vector<Humidity> > asdm::Humidity::from2DBin ( EndianIStream eis) [static]

Read the binary representation of a vector of vector of Humidity from an EndianIStream and use the read value to set a vector of vector of Humidity.

Parameters:
eisthe EndianIStream to be read
Returns:
a vector of vector of Humidity
static vector<vector<vector<Humidity> > > asdm::Humidity::from3DBin ( EndianIStream eis) [static]

Read the binary representation of a vector of vector of vector of Humidity from an EndianIStream and use the read value to set a vector of vector of vector of Humidity.

Parameters:
eisthe EndianIStream to be read
Returns:
a vector of vector of vector of Humidity
static vector<vector<vector<Humidity> > > asdm::Humidity::from3DBin ( EndianIStream eis) [static]

Read the binary representation of a vector of vector of vector of Humidity from an EndianIStream and use the read value to set a vector of vector of vector of Humidity.

Parameters:
eisthe EndianIStream to be read
Returns:
a vector of vector of vector of Humidity
static Humidity asdm::Humidity::fromBin ( EndianIStream eis) [static]

Read the binary representation of an Humidity from a EndianIStream and use the read value to set an Humidity.

Parameters:
eisthe EndianStream to be read
Returns:
an Humidity
static Humidity asdm::Humidity::fromBin ( EndianIStream eis) [static]

Read the binary representation of an Humidity from a EndianIStream and use the read value to set an Humidity.

Parameters:
eisthe EndianStream to be read
Returns:
an Humidity
static double asdm::Humidity::fromString ( const string &  s) [static]

A static method equivalent to the constructor from a string.

Parameters:
sa string?.
static double asdm::Humidity::fromString ( const string &  s) [static]

A static method equivalent to the constructor from a string.

Parameters:
sa string?.
double asdm::Humidity::get ( ) const [inline]

Return the double precision value of the Humidity.

Returns:
double

Definition at line 427 of file Humidity.h.

References value.

double asdm::Humidity::get ( ) const

Return the double precision value of the Humidity.

Returns:
double

Parse the next (string) token of a StringTokenizer into an angle.

Parameters:
sta reference to a StringTokenizer.
Returns:
an Humidity.

Parse the next (string) token of a StringTokenizer into an angle.

Parameters:
sta reference to a StringTokenizer.
Returns:
an Humidity.
bool asdm::Humidity::isZero ( ) const

Comparison method.

Test nullity.

Returns:
a bool.
bool asdm::Humidity::isZero ( ) const

Comparison method.

Test nullity.

Returns:
a bool.
asdm::Humidity::operator string ( ) const [inline]

Conversion operator.

Conversion functions.

Converts into a string.

Definition at line 418 of file Humidity.h.

References toString().

asdm::Humidity::operator string ( ) const

Conversion operator.

Converts into a string.

bool asdm::Humidity::operator!= ( const Humidity x) const

Comparison operator.

Not-equal.

Parameters:
xa const reference to a Humidity.
bool asdm::Humidity::operator!= ( const Humidity x) const [inline]

Comparison operator.

Not-equal.

Parameters:
xa const reference to a Humidity.

Definition at line 403 of file Humidity.h.

References value.

Humidity asdm::Humidity::operator* ( const double  x) const [inline]

Multiplication operator.

Parameters:
xa value in double precision.

Definition at line 374 of file Humidity.h.

References value.

Humidity asdm::Humidity::operator* ( const double  x) const

Multiplication operator.

Parameters:
xa value in double precision.
Humidity & asdm::Humidity::operator*= ( const double  x) [inline]

Operator multiply and assign.

Parameters:
xa value in double precision.

Definition at line 355 of file Humidity.h.

References value.

Humidity& asdm::Humidity::operator*= ( const double  x)

Operator multiply and assign.

Parameters:
xa value in double precision.
Humidity asdm::Humidity::operator+ ( const Humidity x) const [inline]

Addition operator.

arithmetic functions

Parameters:
xa const reference to a Humidity.

Definition at line 364 of file Humidity.h.

References value.

Humidity asdm::Humidity::operator+ ( const Humidity x) const

Addition operator.

Parameters:
xa const reference to a Humidity.
Humidity asdm::Humidity::operator+ ( ) const

Unary operator.

Unary plus.

Humidity asdm::Humidity::operator+ ( ) const [inline]

Unary operator.

Unary plus.

Definition at line 412 of file Humidity.h.

References value.

Humidity& asdm::Humidity::operator+= ( const Humidity x)

Operator increment and assign.

Parameters:
xa const reference to an Humidity.
Humidity & asdm::Humidity::operator+= ( const Humidity x) [inline]

Operator increment and assign.

assignment with arithmetic operators

Parameters:
xa const reference to an Humidity.

Definition at line 347 of file Humidity.h.

References value.

Humidity asdm::Humidity::operator- ( const Humidity x) const [inline]

Substraction operator.

Parameters:
xa const reference to a Humidity.

Definition at line 369 of file Humidity.h.

References value.

Humidity asdm::Humidity::operator- ( const Humidity x) const

Substraction operator.

Parameters:
xa const reference to a Humidity.
Humidity asdm::Humidity::operator- ( ) const

Unary operator.

Opposite.

Humidity asdm::Humidity::operator- ( ) const [inline]

Unary operator.

unary - and + operators

Opposite.

Definition at line 407 of file Humidity.h.

References value.

Humidity& asdm::Humidity::operator-= ( const Humidity x)

Operator decrement and assign.

Parameters:
xa const reference to an Humidity.
Humidity & asdm::Humidity::operator-= ( const Humidity x) [inline]

Operator decrement and assign.

Parameters:
xa const reference to an Humidity.

Definition at line 351 of file Humidity.h.

References value.

Humidity asdm::Humidity::operator/ ( const double  x) const [inline]

Division operator.

Parameters:
da value in double precision.

Definition at line 379 of file Humidity.h.

References value.

Humidity asdm::Humidity::operator/ ( const double  x) const

Division operator.

Parameters:
da value in double precision.
Humidity& asdm::Humidity::operator/= ( const double  x)

Operator divide and assign.

Parameters:
xa valye in double precision.
Humidity & asdm::Humidity::operator/= ( const double  x) [inline]

Operator divide and assign.

Parameters:
xa valye in double precision.

Definition at line 359 of file Humidity.h.

References value.

bool asdm::Humidity::operator< ( const Humidity x) const

Comparison operator.

Less-than.

Parameters:
xa const reference to a Humidity.
bool asdm::Humidity::operator< ( const Humidity x) const [inline]

Comparison operator.

comparison operators

Less-than.

Parameters:
xa const reference to a Humidity.

Definition at line 385 of file Humidity.h.

References value.

bool asdm::Humidity::operator<= ( const Humidity x) const

Comparison operator.

Less-than or equal.

Parameters:
xa const reference to a Humidity.
bool asdm::Humidity::operator<= ( const Humidity x) const [inline]

Comparison operator.

Less-than or equal.

Parameters:
xa const reference to a Humidity.

Definition at line 391 of file Humidity.h.

References value.

Humidity & asdm::Humidity::operator= ( const Humidity x) [inline]

An assignment operator Humidity = Humidity.

assignment operator

Parameters:
xa const reference to an Humidity.

Definition at line 337 of file Humidity.h.

References value.

Humidity& asdm::Humidity::operator= ( const Humidity x)

An assignment operator Humidity = Humidity.

Parameters:
xa const reference to an Humidity.
Humidity& asdm::Humidity::operator= ( const double  d)

An assignment operator Humidity = double.

Parameters:
da value in double precision.
Humidity & asdm::Humidity::operator= ( const double  d) [inline]

An assignment operator Humidity = double.

assignment operator

Parameters:
da value in double precision.

Definition at line 342 of file Humidity.h.

References value.

bool asdm::Humidity::operator== ( const Humidity x) const

Comparision operator.

Equal-to.

Parameters:
xa const reference to a Humidity.
bool asdm::Humidity::operator== ( const Humidity x) const [inline]

Comparision operator.

Equal-to.

Parameters:
xa const reference to a Humidity.

Definition at line 400 of file Humidity.h.

References value.

bool asdm::Humidity::operator> ( const Humidity x) const

Comparison operator.

Greater-than.

Parameters:
xa const reference to a Humidity.
bool asdm::Humidity::operator> ( const Humidity x) const [inline]

Comparison operator.

Greater-than.

Parameters:
xa const reference to a Humidity.

Definition at line 388 of file Humidity.h.

References value.

bool asdm::Humidity::operator>= ( const Humidity x) const [inline]

Comparison operator.

Greater-than or equal.

Parameters:
xa const reference to a Humidity.

Definition at line 394 of file Humidity.h.

References value.

bool asdm::Humidity::operator>= ( const Humidity x) const

Comparison operator.

Greater-than or equal.

Parameters:
xa const reference to a Humidity.

Write the binary representation of this to an EndianOSStream .

Parameters:
eossa reference to an EndianOSStream .

Write the binary representation of this to an EndianOSStream .

Parameters:
eossa reference to an EndianOSStream .
static void asdm::Humidity::toBin ( const vector< Humidity > &  angle,
EndianOSStream eoss 
) [static]

Write the binary representation of a vector of Humidity to a EndianOSStream.

Parameters:
anglethe vector of Humidity to be written
eossthe EndianOSStream to be written to
static void asdm::Humidity::toBin ( const vector< Humidity > &  angle,
EndianOSStream eoss 
) [static]

Write the binary representation of a vector of Humidity to a EndianOSStream.

Parameters:
anglethe vector of Humidity to be written
eossthe EndianOSStream to be written to
static void asdm::Humidity::toBin ( const vector< vector< Humidity > > &  angle,
EndianOSStream eoss 
) [static]

Write the binary representation of a vector of vector of Humidity to a EndianOSStream.

Parameters:
anglethe vector of vector of Humidity to be written
eossthe EndianOSStream to be written to
static void asdm::Humidity::toBin ( const vector< vector< Humidity > > &  angle,
EndianOSStream eoss 
) [static]

Write the binary representation of a vector of vector of Humidity to a EndianOSStream.

Parameters:
anglethe vector of vector of Humidity to be written
eossthe EndianOSStream to be written to
static void asdm::Humidity::toBin ( const vector< vector< vector< Humidity > > > &  angle,
EndianOSStream eoss 
) [static]

Write the binary representation of a vector of vector of vector of Humidity to a EndianOSStream.

Parameters:
anglethe vector of vector of vector of Humidity to be written
eossthe EndianOSStream to be written to
static void asdm::Humidity::toBin ( const vector< vector< vector< Humidity > > > &  angle,
EndianOSStream eoss 
) [static]

Write the binary representation of a vector of vector of vector of Humidity to a EndianOSStream.

Parameters:
anglethe vector of vector of vector of Humidity to be written
eossthe EndianOSStream to be written to
IDLHumidity asdm::Humidity::toIDLHumidity ( ) const

Return the IDLHumidity representation of the Humidity.

Returns:
IDLHumidity
IDLHumidity asdm::Humidity::toIDLHumidity ( ) const [inline]

Return the IDLHumidity representation of the Humidity.

Returns:
IDLHumidity

Definition at line 431 of file Humidity.h.

References value.

static string asdm::Humidity::toString ( double  ) [static]

Conversion into string.

The resulting string contains the representation of the value of this Humidity.

Returns:
string
static string asdm::Humidity::toString ( double  ) [static]

Conversion into string.

The resulting string contains the representation of the value of this Humidity.

Returns:
string
string asdm::Humidity::toString ( ) const

Converts into a string.

Returns:
a string containing the representation of a the value in double precision.
string asdm::Humidity::toString ( ) const [inline]

Converts into a string.

Returns:
a string containing the representation of a the value in double precision.

Definition at line 421 of file Humidity.h.

References value.

Referenced by operator string(), and toStringI().

string asdm::Humidity::toStringI ( ) const [inline]

Idem toString.

Definition at line 424 of file Humidity.h.

References toString(), and value.

string asdm::Humidity::toStringI ( ) const

Idem toString.

string asdm::Humidity::unit ( ) [inline, static]

Returns the abbreviated name of the unit implicitely associated to any Humidity.

Returns:
string

Definition at line 451 of file Humidity.h.

static string asdm::Humidity::unit ( ) [static]

Returns the abbreviated name of the unit implicitely associated to any Humidity.

Returns:
string

Friends And Related Function Documentation

Humidity operator* ( double  d,
const Humidity x 
) [friend]

Overloading of multiplication operator.

Parameters:
da value in double precision .
xa const reference to a Humidity .
Returns:
a Humidity
Humidity operator* ( double  d,
const Humidity x 
) [friend]

Overloading of multiplication operator.

Parameters:
da value in double precision .
xa const reference to a Humidity .
Returns:
a Humidity

Overloading of multiplication operator.

Parameters:
da value in double precision .
xa const reference to a Humidity .
Returns:
a Humidity
ostream& operator<< ( ostream &  os,
const Humidity x 
) [friend]

Overloading of << to output the value an Humidity on an ostream.

Parameters:
osa reference to the ostream to be written on.
xa const reference to a Humidity.
ostream& operator<< ( ostream &  os,
const Humidity x 
) [friend]

Overloading of << to output the value an Humidity on an ostream.

Parameters:
osa reference to the ostream to be written on.
xa const reference to a Humidity.
istream& operator>> ( istream &  is,
Humidity x 
) [friend]

Overloading of >> to read an Humidity from an istream.

istream& operator>> ( istream &  is,
Humidity x 
) [friend]

Overloading of >> to read an Humidity from an istream.


Member Data Documentation

double asdm::Humidity::value [private]

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