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

The Angle class implements a quantity of angle in radians. More...

#include <Angle.h>

List of all members.

Public Member Functions

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

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

Private Attributes

double value

Friends

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

Detailed Description

The Angle class implements a quantity of angle in radians.

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


Constructor & Destructor Documentation

asdm::Angle::Angle ( ) [inline]

The nullary constructor (default).

Angle constructors.

Definition at line 322 of file Angle.h.

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

The copy constructor.

Definition at line 324 of file Angle.h.

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

asdm::Angle::Angle ( const IDLAngle &  idlAngle) [inline]

A constructor from a CORBA/IDL representation.

Parameters:
idlAnglea cons ref to an IDLAngle.

Definition at line 327 of file Angle.h.

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

A constructor from a value in double precision.

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

Definition at line 332 of file Angle.h.

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

The destructor.

Angle destructor.

Definition at line 335 of file Angle.h.

The nullary constructor (default).

asdm::Angle::Angle ( const Angle )

The copy constructor.

asdm::Angle::Angle ( 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::Angle::Angle ( const IDLAngle &  idlAngle)

A constructor from a CORBA/IDL representation.

Parameters:
idlAnglea cons ref to an IDLAngle.
asdm::Angle::Angle ( double  value)

A constructor from a value in double precision.

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

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

The destructor.


Member Function Documentation

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

Comparison method.

Equality.

Parameters:
xa const reference to a Angle.

Definition at line 397 of file Angle.h.

References value.

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

Comparison method.

Equality.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

A static method equivalent to the constructor from a string.

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

A static method equivalent to the constructor from a string.

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

Return the double precision value of the Angle.

Returns:
double

Definition at line 427 of file Angle.h.

References value.

double asdm::Angle::get ( ) const

Return the double precision value of the Angle.

Returns:
double

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

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

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

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

Comparison method.

Test nullity.

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

Comparison method.

Test nullity.

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

Conversion operator.

Conversion functions.

Converts into a string.

Definition at line 418 of file Angle.h.

References toString().

asdm::Angle::operator string ( ) const

Conversion operator.

Converts into a string.

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

Comparison operator.

Not-equal.

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

Comparison operator.

Not-equal.

Parameters:
xa const reference to a Angle.

Definition at line 403 of file Angle.h.

References value.

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

Multiplication operator.

Parameters:
xa value in double precision.

Definition at line 374 of file Angle.h.

References value.

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

Multiplication operator.

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

Operator multiply and assign.

Parameters:
xa value in double precision.

Definition at line 355 of file Angle.h.

References value.

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

Operator multiply and assign.

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

Addition operator.

arithmetic functions

Parameters:
xa const reference to a Angle.

Definition at line 364 of file Angle.h.

References value.

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

Addition operator.

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

Unary operator.

Unary plus.

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

Unary operator.

Unary plus.

Definition at line 412 of file Angle.h.

References value.

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

Operator increment and assign.

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

Operator increment and assign.

assignment with arithmetic operators

Parameters:
xa const reference to an Angle.

Definition at line 347 of file Angle.h.

References value.

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

Substraction operator.

Parameters:
xa const reference to a Angle.

Definition at line 369 of file Angle.h.

References value.

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

Substraction operator.

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

Unary operator.

Opposite.

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

Unary operator.

unary - and + operators

Opposite.

Definition at line 407 of file Angle.h.

References value.

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

Operator decrement and assign.

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

Operator decrement and assign.

Parameters:
xa const reference to an Angle.

Definition at line 351 of file Angle.h.

References value.

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

Division operator.

Parameters:
da value in double precision.

Definition at line 379 of file Angle.h.

References value.

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

Division operator.

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

Operator divide and assign.

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

Operator divide and assign.

Parameters:
xa valye in double precision.

Definition at line 359 of file Angle.h.

References value.

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

Comparison operator.

Less-than.

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

Comparison operator.

comparison operators

Less-than.

Parameters:
xa const reference to a Angle.

Definition at line 385 of file Angle.h.

References value.

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

Comparison operator.

Less-than or equal.

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

Comparison operator.

Less-than or equal.

Parameters:
xa const reference to a Angle.

Definition at line 391 of file Angle.h.

References value.

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

An assignment operator Angle = Angle.

assignment operator

Parameters:
xa const reference to an Angle.

Definition at line 337 of file Angle.h.

References value.

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

An assignment operator Angle = Angle.

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

An assignment operator Angle = double.

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

An assignment operator Angle = double.

assignment operator

Parameters:
da value in double precision.

Definition at line 342 of file Angle.h.

References value.

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

Comparision operator.

Equal-to.

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

Comparision operator.

Equal-to.

Parameters:
xa const reference to a Angle.

Definition at line 400 of file Angle.h.

References value.

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

Comparison operator.

Greater-than.

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

Comparison operator.

Greater-than.

Parameters:
xa const reference to a Angle.

Definition at line 388 of file Angle.h.

References value.

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

Comparison operator.

Greater-than or equal.

Parameters:
xa const reference to a Angle.

Definition at line 394 of file Angle.h.

References value.

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

Comparison operator.

Greater-than or equal.

Parameters:
xa const reference to a Angle.

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

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

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

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

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

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

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

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

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

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

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

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

Parameters:
anglethe vector of vector of vector of Angle to be written
eossthe EndianOSStream to be written to
IDLAngle asdm::Angle::toIDLAngle ( ) const

Return the IDLAngle representation of the Angle.

Returns:
IDLAngle
IDLAngle asdm::Angle::toIDLAngle ( ) const [inline]

Return the IDLAngle representation of the Angle.

Returns:
IDLAngle

Definition at line 431 of file Angle.h.

References value.

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

Conversion into string.

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

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

Conversion into string.

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

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

Converts into a string.

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

References value.

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

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

Idem toString.

Definition at line 424 of file Angle.h.

References toString(), and value.

string asdm::Angle::toStringI ( ) const

Idem toString.

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

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

Returns:
string

Definition at line 451 of file Angle.h.

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

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

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

Returns:
string

Friends And Related Function Documentation

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

Overloading of multiplication operator.

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

Overloading of multiplication operator.

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

Overloading of multiplication operator.

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

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

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

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

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

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

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

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


Member Data Documentation

double asdm::Angle::value [private]

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