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::Temperature Class Reference

The Temperature class implements a quantity of temperature in degrees Kelvin. More...

#include <Temperature.h>

List of all members.

Public Member Functions

 Temperature ()
 The nullary constructor (default).
 Temperature (const Temperature &)
 The copy constructor.
 Temperature (const string &s)
 A constructor from a string representation.
 Temperature (const IDLTemperature &idlTemperature)
 A constructor from a CORBA/IDL representation.
 Temperature (double value)
 A constructor from a value in double precision.
virtual ~Temperature ()
 The destructor.
void toBin (EndianOSStream &eoss)
 Write the binary representation of this to an EndianOSStream .
Temperatureoperator= (const Temperature &x)
 An assignment operator Temperature = Temperature.
Temperatureoperator= (const double d)
 An assignment operator Temperature = double.
Temperatureoperator+= (const Temperature &x)
 Operator increment and assign.
Temperatureoperator-= (const Temperature &x)
 Operator decrement and assign.
Temperatureoperator*= (const double x)
 Operator multiply and assign.
Temperatureoperator/= (const double x)
 Operator divide and assign.
Temperature operator+ (const Temperature &x) const
 Addition operator.
Temperature operator- (const Temperature &x) const
 Substraction operator.
Temperature operator* (const double x) const
 Multiplication operator.
Temperature operator/ (const double x) const
 Division operator.
bool operator< (const Temperature &x) const
 Comparison operator.
bool operator> (const Temperature &x) const
 Comparison operator.
bool operator<= (const Temperature &x) const
 Comparison operator.
bool operator>= (const Temperature &x) const
 Comparison operator.
bool operator== (const Temperature &x) const
 Comparision operator.
bool equals (const Temperature &x) const
 Comparison method.
bool operator!= (const Temperature &x) const
 Comparison operator.
bool isZero () const
 Comparison method.
Temperature operator- () const
 Unary operator.
Temperature 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 Temperature.
IDLTemperature toIDLTemperature () const
 Return the IDLTemperature representation of the Temperature.
 Temperature ()
 The nullary constructor (default).
 Temperature (const Temperature &)
 The copy constructor.
 Temperature (const string &s)
 A constructor from a string representation.
 Temperature (const IDLTemperature &idlTemperature)
 A constructor from a CORBA/IDL representation.
 Temperature (double value)
 A constructor from a value in double precision.
virtual ~Temperature ()
 The destructor.
void toBin (EndianOSStream &eoss)
 Write the binary representation of this to an EndianOSStream .
Temperatureoperator= (const Temperature &x)
 An assignment operator Temperature = Temperature.
Temperatureoperator= (const double d)
 An assignment operator Temperature = double.
Temperatureoperator+= (const Temperature &x)
 Operator increment and assign.
Temperatureoperator-= (const Temperature &x)
 Operator decrement and assign.
Temperatureoperator*= (const double x)
 Operator multiply and assign.
Temperatureoperator/= (const double x)
 Operator divide and assign.
Temperature operator+ (const Temperature &x) const
 Addition operator.
Temperature operator- (const Temperature &x) const
 Substraction operator.
Temperature operator* (const double x) const
 Multiplication operator.
Temperature operator/ (const double x) const
 Division operator.
bool operator< (const Temperature &x) const
 Comparison operator.
bool operator> (const Temperature &x) const
 Comparison operator.
bool operator<= (const Temperature &x) const
 Comparison operator.
bool operator>= (const Temperature &x) const
 Comparison operator.
bool operator== (const Temperature &x) const
 Comparision operator.
bool equals (const Temperature &x) const
 Comparison method.
bool operator!= (const Temperature &x) const
 Comparison operator.
bool isZero () const
 Comparison method.
Temperature operator- () const
 Unary operator.
Temperature 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 Temperature.
IDLTemperature toIDLTemperature () const
 Return the IDLTemperature representation of the Temperature.

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

Private Attributes

double value

Friends

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

Detailed Description

The Temperature class implements a quantity of temperature in degrees Kelvin.

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 Temperature.h.


Constructor & Destructor Documentation

The nullary constructor (default).

Temperature constructors.

Definition at line 322 of file Temperature.h.

The copy constructor.

Definition at line 324 of file Temperature.h.

asdm::Temperature::Temperature ( 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 Temperature.h.

asdm::Temperature::Temperature ( const IDLTemperature &  idlTemperature) [inline]

A constructor from a CORBA/IDL representation.

Parameters:
idlTemperaturea cons ref to an IDLTemperature.

Definition at line 327 of file Temperature.h.

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

A constructor from a value in double precision.

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

Definition at line 332 of file Temperature.h.

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

The destructor.

Temperature destructor.

Definition at line 335 of file Temperature.h.

The nullary constructor (default).

The copy constructor.

asdm::Temperature::Temperature ( 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::Temperature::Temperature ( const IDLTemperature &  idlTemperature)

A constructor from a CORBA/IDL representation.

Parameters:
idlTemperaturea cons ref to an IDLTemperature.
asdm::Temperature::Temperature ( double  value)

A constructor from a value in double precision.

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

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

The destructor.


Member Function Documentation

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

Comparison method.

Equality.

Parameters:
xa const reference to a Temperature.

Definition at line 397 of file Temperature.h.

References value.

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

Comparison method.

Equality.

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

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

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

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

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

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

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

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

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

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

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

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

Parameters:
eisthe EndianIStream to be read
Returns:
a vector of vector of vector of Temperature

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

Parameters:
eisthe EndianStream to be read
Returns:
an Temperature

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

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

A static method equivalent to the constructor from a string.

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

A static method equivalent to the constructor from a string.

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

Return the double precision value of the Temperature.

Returns:
double

Definition at line 427 of file Temperature.h.

References value.

double asdm::Temperature::get ( ) const

Return the double precision value of the Temperature.

Returns:
double

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

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

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

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

Comparison method.

Test nullity.

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

Comparison method.

Test nullity.

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

Conversion operator.

Conversion functions.

Converts into a string.

Definition at line 418 of file Temperature.h.

References toString().

asdm::Temperature::operator string ( ) const

Conversion operator.

Converts into a string.

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

Comparison operator.

Not-equal.

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

Comparison operator.

Not-equal.

Parameters:
xa const reference to a Temperature.

Definition at line 403 of file Temperature.h.

References value.

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

Multiplication operator.

Parameters:
xa value in double precision.

Definition at line 374 of file Temperature.h.

References value.

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

Multiplication operator.

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

Operator multiply and assign.

Parameters:
xa value in double precision.

Definition at line 355 of file Temperature.h.

References value.

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

Operator multiply and assign.

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

Addition operator.

arithmetic functions

Parameters:
xa const reference to a Temperature.

Definition at line 364 of file Temperature.h.

References value.

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

Addition operator.

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

Unary operator.

Unary plus.

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

Unary operator.

Unary plus.

Definition at line 412 of file Temperature.h.

References value.

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

Operator increment and assign.

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

Operator increment and assign.

assignment with arithmetic operators

Parameters:
xa const reference to an Temperature.

Definition at line 347 of file Temperature.h.

References value.

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

Substraction operator.

Parameters:
xa const reference to a Temperature.

Definition at line 369 of file Temperature.h.

References value.

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

Substraction operator.

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

Unary operator.

Opposite.

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

Unary operator.

unary - and + operators

Opposite.

Definition at line 407 of file Temperature.h.

References value.

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

Operator decrement and assign.

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

Operator decrement and assign.

Parameters:
xa const reference to an Temperature.

Definition at line 351 of file Temperature.h.

References value.

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

Division operator.

Parameters:
da value in double precision.

Definition at line 379 of file Temperature.h.

References value.

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

Division operator.

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

Operator divide and assign.

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

Operator divide and assign.

Parameters:
xa valye in double precision.

Definition at line 359 of file Temperature.h.

References value.

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

Comparison operator.

Less-than.

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

Comparison operator.

comparison operators

Less-than.

Parameters:
xa const reference to a Temperature.

Definition at line 385 of file Temperature.h.

References value.

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

Comparison operator.

Less-than or equal.

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

Comparison operator.

Less-than or equal.

Parameters:
xa const reference to a Temperature.

Definition at line 391 of file Temperature.h.

References value.

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

An assignment operator Temperature = Temperature.

assignment operator

Parameters:
xa const reference to an Temperature.

Definition at line 337 of file Temperature.h.

References value.

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

An assignment operator Temperature = Temperature.

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

An assignment operator Temperature = double.

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

An assignment operator Temperature = double.

assignment operator

Parameters:
da value in double precision.

Definition at line 342 of file Temperature.h.

References value.

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

Comparision operator.

Equal-to.

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

Comparision operator.

Equal-to.

Parameters:
xa const reference to a Temperature.

Definition at line 400 of file Temperature.h.

References value.

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

Comparison operator.

Greater-than.

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

Comparison operator.

Greater-than.

Parameters:
xa const reference to a Temperature.

Definition at line 388 of file Temperature.h.

References value.

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

Comparison operator.

Greater-than or equal.

Parameters:
xa const reference to a Temperature.

Definition at line 394 of file Temperature.h.

References value.

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

Comparison operator.

Greater-than or equal.

Parameters:
xa const reference to a Temperature.

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::Temperature::toBin ( const vector< Temperature > &  angle,
EndianOSStream eoss 
) [static]

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

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

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

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

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

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

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

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

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

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

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

Parameters:
anglethe vector of vector of vector of Temperature to be written
eossthe EndianOSStream to be written to
IDLTemperature asdm::Temperature::toIDLTemperature ( ) const

Return the IDLTemperature representation of the Temperature.

Returns:
IDLTemperature
IDLTemperature asdm::Temperature::toIDLTemperature ( ) const [inline]

Return the IDLTemperature representation of the Temperature.

Returns:
IDLTemperature

Definition at line 431 of file Temperature.h.

References value.

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

Conversion into string.

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

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

Conversion into string.

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

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

Converts into a string.

Returns:
a string containing the representation of a the value in double precision.
string asdm::Temperature::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 Temperature.h.

References value.

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

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

Idem toString.

Definition at line 424 of file Temperature.h.

References toString(), and value.

string asdm::Temperature::toStringI ( ) const

Idem toString.

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

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

Returns:
string

Definition at line 451 of file Temperature.h.

Referenced by casa::MS2ASDM::unitASDMTemp().

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

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

Returns:
string

Friends And Related Function Documentation

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

Overloading of multiplication operator.

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

Overloading of multiplication operator.

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

Overloading of multiplication operator.

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

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

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

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

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

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

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

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


Member Data Documentation

double asdm::Temperature::value [private]

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