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

The Flux class implements a quantity of flux in janskys. More...

#include <Flux.h>

List of all members.

Public Member Functions

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

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

Private Attributes

double value

Friends

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

Detailed Description

The Flux class implements a quantity of flux in janskys.

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


Constructor & Destructor Documentation

asdm::Flux::Flux ( ) [inline]

The nullary constructor (default).

Flux constructors.

Definition at line 322 of file Flux.h.

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

The copy constructor.

Definition at line 324 of file Flux.h.

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

asdm::Flux::Flux ( const IDLFlux &  idlFlux) [inline]

A constructor from a CORBA/IDL representation.

Parameters:
idlFluxa cons ref to an IDLFlux.

Definition at line 327 of file Flux.h.

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

A constructor from a value in double precision.

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

Definition at line 332 of file Flux.h.

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

The destructor.

Flux destructor.

Definition at line 335 of file Flux.h.

The nullary constructor (default).

asdm::Flux::Flux ( const Flux )

The copy constructor.

asdm::Flux::Flux ( 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::Flux::Flux ( const IDLFlux &  idlFlux)

A constructor from a CORBA/IDL representation.

Parameters:
idlFluxa cons ref to an IDLFlux.
asdm::Flux::Flux ( double  value)

A constructor from a value in double precision.

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

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

The destructor.


Member Function Documentation

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

Comparison method.

Equality.

Parameters:
xa const reference to a Flux.

Definition at line 397 of file Flux.h.

References value.

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

Comparison method.

Equality.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

A static method equivalent to the constructor from a string.

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

A static method equivalent to the constructor from a string.

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

Return the double precision value of the Flux.

Returns:
double

Definition at line 427 of file Flux.h.

References value.

double asdm::Flux::get ( ) const

Return the double precision value of the Flux.

Returns:
double

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

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

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

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

Comparison method.

Test nullity.

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

Comparison method.

Test nullity.

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

Conversion operator.

Conversion functions.

Converts into a string.

Definition at line 418 of file Flux.h.

References toString().

asdm::Flux::operator string ( ) const

Conversion operator.

Converts into a string.

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

Comparison operator.

Not-equal.

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

Comparison operator.

Not-equal.

Parameters:
xa const reference to a Flux.

Definition at line 403 of file Flux.h.

References value.

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

Multiplication operator.

Parameters:
xa value in double precision.

Definition at line 374 of file Flux.h.

References value.

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

Multiplication operator.

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

Operator multiply and assign.

Parameters:
xa value in double precision.

Definition at line 355 of file Flux.h.

References value.

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

Operator multiply and assign.

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

Addition operator.

arithmetic functions

Parameters:
xa const reference to a Flux.

Definition at line 364 of file Flux.h.

References value.

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

Addition operator.

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

Unary operator.

Unary plus.

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

Unary operator.

Unary plus.

Definition at line 412 of file Flux.h.

References value.

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

Operator increment and assign.

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

Operator increment and assign.

assignment with arithmetic operators

Parameters:
xa const reference to an Flux.

Definition at line 347 of file Flux.h.

References value.

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

Substraction operator.

Parameters:
xa const reference to a Flux.

Definition at line 369 of file Flux.h.

References value.

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

Substraction operator.

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

Unary operator.

Opposite.

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

Unary operator.

unary - and + operators

Opposite.

Definition at line 407 of file Flux.h.

References value.

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

Operator decrement and assign.

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

Operator decrement and assign.

Parameters:
xa const reference to an Flux.

Definition at line 351 of file Flux.h.

References value.

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

Division operator.

Parameters:
da value in double precision.

Definition at line 379 of file Flux.h.

References value.

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

Division operator.

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

Operator divide and assign.

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

Operator divide and assign.

Parameters:
xa valye in double precision.

Definition at line 359 of file Flux.h.

References value.

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

Comparison operator.

Less-than.

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

Comparison operator.

comparison operators

Less-than.

Parameters:
xa const reference to a Flux.

Definition at line 385 of file Flux.h.

References value.

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

Comparison operator.

Less-than or equal.

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

Comparison operator.

Less-than or equal.

Parameters:
xa const reference to a Flux.

Definition at line 391 of file Flux.h.

References value.

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

An assignment operator Flux = Flux.

assignment operator

Parameters:
xa const reference to an Flux.

Definition at line 337 of file Flux.h.

References value.

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

An assignment operator Flux = Flux.

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

An assignment operator Flux = double.

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

An assignment operator Flux = double.

assignment operator

Parameters:
da value in double precision.

Definition at line 342 of file Flux.h.

References value.

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

Comparision operator.

Equal-to.

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

Comparision operator.

Equal-to.

Parameters:
xa const reference to a Flux.

Definition at line 400 of file Flux.h.

References value.

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

Comparison operator.

Greater-than.

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

Comparison operator.

Greater-than.

Parameters:
xa const reference to a Flux.

Definition at line 388 of file Flux.h.

References value.

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

Comparison operator.

Greater-than or equal.

Parameters:
xa const reference to a Flux.

Definition at line 394 of file Flux.h.

References value.

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

Comparison operator.

Greater-than or equal.

Parameters:
xa const reference to a Flux.

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

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

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

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

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

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

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

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

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

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

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

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

Parameters:
anglethe vector of vector of vector of Flux to be written
eossthe EndianOSStream to be written to
IDLFlux asdm::Flux::toIDLFlux ( ) const

Return the IDLFlux representation of the Flux.

Returns:
IDLFlux
IDLFlux asdm::Flux::toIDLFlux ( ) const [inline]

Return the IDLFlux representation of the Flux.

Returns:
IDLFlux

Definition at line 431 of file Flux.h.

References value.

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

Conversion into string.

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

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

Conversion into string.

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

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

Converts into a string.

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

References value.

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

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

Idem toString.

Definition at line 424 of file Flux.h.

References toString(), and value.

string asdm::Flux::toStringI ( ) const

Idem toString.

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

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

Returns:
string

Definition at line 451 of file Flux.h.

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

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

Returns:
string

Friends And Related Function Documentation

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

Overloading of multiplication operator.

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

Overloading of multiplication operator.

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

Overloading of multiplication operator.

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

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

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

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

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

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

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

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


Member Data Documentation

double asdm::Flux::value [private]

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