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

The Speed class implements a quantity of speed in meters per second. More...

#include <Speed.h>

List of all members.

Public Member Functions

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

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

Private Attributes

double value

Friends

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

Detailed Description

The Speed class implements a quantity of speed in meters per second.

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


Constructor & Destructor Documentation

asdm::Speed::Speed ( ) [inline]

The nullary constructor (default).

Speed constructors.

Definition at line 322 of file Speed.h.

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

The copy constructor.

Definition at line 324 of file Speed.h.

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

asdm::Speed::Speed ( const IDLSpeed &  idlSpeed) [inline]

A constructor from a CORBA/IDL representation.

Parameters:
idlSpeeda cons ref to an IDLSpeed.

Definition at line 327 of file Speed.h.

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

A constructor from a value in double precision.

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

Definition at line 332 of file Speed.h.

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

The destructor.

Speed destructor.

Definition at line 335 of file Speed.h.

The nullary constructor (default).

asdm::Speed::Speed ( const Speed )

The copy constructor.

asdm::Speed::Speed ( 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::Speed::Speed ( const IDLSpeed &  idlSpeed)

A constructor from a CORBA/IDL representation.

Parameters:
idlSpeeda cons ref to an IDLSpeed.
asdm::Speed::Speed ( double  value)

A constructor from a value in double precision.

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

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

The destructor.


Member Function Documentation

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

Comparison method.

Equality.

Parameters:
xa const reference to a Speed.

Definition at line 397 of file Speed.h.

References value.

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

Comparison method.

Equality.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

A static method equivalent to the constructor from a string.

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

A static method equivalent to the constructor from a string.

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

Return the double precision value of the Speed.

Returns:
double

Definition at line 427 of file Speed.h.

References value.

double asdm::Speed::get ( ) const

Return the double precision value of the Speed.

Returns:
double

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

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

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

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

Comparison method.

Test nullity.

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

Comparison method.

Test nullity.

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

Conversion operator.

Conversion functions.

Converts into a string.

Definition at line 418 of file Speed.h.

References toString().

asdm::Speed::operator string ( ) const

Conversion operator.

Converts into a string.

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

Comparison operator.

Not-equal.

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

Comparison operator.

Not-equal.

Parameters:
xa const reference to a Speed.

Definition at line 403 of file Speed.h.

References value.

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

Multiplication operator.

Parameters:
xa value in double precision.

Definition at line 374 of file Speed.h.

References value.

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

Multiplication operator.

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

Operator multiply and assign.

Parameters:
xa value in double precision.

Definition at line 355 of file Speed.h.

References value.

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

Operator multiply and assign.

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

Addition operator.

arithmetic functions

Parameters:
xa const reference to a Speed.

Definition at line 364 of file Speed.h.

References value.

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

Addition operator.

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

Unary operator.

Unary plus.

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

Unary operator.

Unary plus.

Definition at line 412 of file Speed.h.

References value.

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

Operator increment and assign.

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

Operator increment and assign.

assignment with arithmetic operators

Parameters:
xa const reference to an Speed.

Definition at line 347 of file Speed.h.

References value.

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

Substraction operator.

Parameters:
xa const reference to a Speed.

Definition at line 369 of file Speed.h.

References value.

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

Substraction operator.

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

Unary operator.

Opposite.

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

Unary operator.

unary - and + operators

Opposite.

Definition at line 407 of file Speed.h.

References value.

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

Operator decrement and assign.

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

Operator decrement and assign.

Parameters:
xa const reference to an Speed.

Definition at line 351 of file Speed.h.

References value.

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

Division operator.

Parameters:
da value in double precision.

Definition at line 379 of file Speed.h.

References value.

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

Division operator.

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

Operator divide and assign.

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

Operator divide and assign.

Parameters:
xa valye in double precision.

Definition at line 359 of file Speed.h.

References value.

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

Comparison operator.

Less-than.

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

Comparison operator.

comparison operators

Less-than.

Parameters:
xa const reference to a Speed.

Definition at line 385 of file Speed.h.

References value.

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

Comparison operator.

Less-than or equal.

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

Comparison operator.

Less-than or equal.

Parameters:
xa const reference to a Speed.

Definition at line 391 of file Speed.h.

References value.

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

An assignment operator Speed = Speed.

assignment operator

Parameters:
xa const reference to an Speed.

Definition at line 337 of file Speed.h.

References value.

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

An assignment operator Speed = Speed.

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

An assignment operator Speed = double.

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

An assignment operator Speed = double.

assignment operator

Parameters:
da value in double precision.

Definition at line 342 of file Speed.h.

References value.

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

Comparision operator.

Equal-to.

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

Comparision operator.

Equal-to.

Parameters:
xa const reference to a Speed.

Definition at line 400 of file Speed.h.

References value.

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

Comparison operator.

Greater-than.

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

Comparison operator.

Greater-than.

Parameters:
xa const reference to a Speed.

Definition at line 388 of file Speed.h.

References value.

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

Comparison operator.

Greater-than or equal.

Parameters:
xa const reference to a Speed.

Definition at line 394 of file Speed.h.

References value.

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

Comparison operator.

Greater-than or equal.

Parameters:
xa const reference to a Speed.

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

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

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

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

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

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

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

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

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

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

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

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

Parameters:
anglethe vector of vector of vector of Speed to be written
eossthe EndianOSStream to be written to
IDLSpeed asdm::Speed::toIDLSpeed ( ) const

Return the IDLSpeed representation of the Speed.

Returns:
IDLSpeed
IDLSpeed asdm::Speed::toIDLSpeed ( ) const [inline]

Return the IDLSpeed representation of the Speed.

Returns:
IDLSpeed

Definition at line 431 of file Speed.h.

References value.

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

Conversion into string.

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

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

Conversion into string.

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

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

Converts into a string.

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

References value.

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

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

Idem toString.

Definition at line 424 of file Speed.h.

References toString(), and value.

string asdm::Speed::toStringI ( ) const

Idem toString.

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

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

Returns:
string

Definition at line 451 of file Speed.h.

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

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

Returns:
string

Friends And Related Function Documentation

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

Overloading of multiplication operator.

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

Overloading of multiplication operator.

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

Overloading of multiplication operator.

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

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

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

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

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

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

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

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


Member Data Documentation

double asdm::Speed::value [private]

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