asdm::Complex Class Reference

The Complex class extends the Complex class in the C++ standard library. More...

#include <ComplexWrapper.h>

Public Member Functions
	Complex ()
	Complex constructors.
	Complex (const Complex &)
	Complex (const string &s)
	Complex (const IDLComplex &)
	Complex (double re, double im)
double	getReal () const
double	getImg () const
void	setReal (double re)
void	setImg (double im)
bool	isZero () const
bool	equals (const Complex &) const
string	toString () const
IDLComplex	toIDLComplex () const
void	toBin (EndianOSStream &eoss)
	Write the binary representation of this to a EndianOSStream.
Static Public Member Functions
static Complex	fromString (const string &) throw (NumberFormatException)
static string	toString (const Complex &)
static Complex	getComplex (StringTokenizer &t) throw (NumberFormatException)
static void	toBin (const vector< Complex > &cmplx, EndianOSStream &eoss)
	Write the binary representation of a vector of Complex to a EndianOSStream.
static void	toBin (const vector< vector< Complex > > &cmplx, EndianOSStream &eoss)
	Write the binary representation of a vector of vector of Complex to a EndianOSStream.
static void	toBin (const vector< vector< vector< Complex > > > &cmplx, EndianOSStream &eoss)
	Write the binary representation of a vector of vector of vector of Complex to a EndianOSStream.
static Complex	fromBin (EndianIStream &eis)
	Read the binary representation of an Complex from a EndianIStream and use the read value to set an Complex.
static vector< Complex >	from1DBin (EndianIStream &eis)
	Read the binary representation of a vector of Complex from an EndianIStream and use the read value to set a vector of Complex.
static vector< vector< Complex > >	from2DBin (EndianIStream &eis)
	Read the binary representation of a vector of vector of Complex from an EndianIStream and use the read value to set a vector of vector of Complex.
static vector< vector< vector < Complex > > >	from3DBin (EndianIStream &eis)
	Read the binary representation of a vector of vector of vector of Complex from an EndianIStream and use the read value to set a vector of vector of vector of Complex.

Detailed Description

The Complex class extends the Complex class in the C++ standard library.

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 64 of file ComplexWrapper.h.

Constructor & Destructor Documentation

asdm::Complex::Complex ( ) [inline]

Complex constructors.

Definition at line 153 of file ComplexWrapper.h.

Referenced by setImg(), and setReal().

asdm::Complex::Complex ( const Complex & t ) [inline]

Definition at line 156 of file ComplexWrapper.h.

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

Definition at line 159 of file ComplexWrapper.h.

asdm::Complex::Complex ( const IDLComplex & l ) [inline]

Definition at line 163 of file ComplexWrapper.h.

asdm::Complex::Complex	(	double	re,
		double	im
	)			`[inline]`

Definition at line 167 of file ComplexWrapper.h.

Member Function Documentation

bool asdm::Complex::equals ( const Complex & x ) const [inline]

Definition at line 190 of file ComplexWrapper.h.

References std::imag(), and std::real().

static vector<Complex> asdm::Complex::from1DBin ( EndianIStream & eis ) [static]

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

Parameters:

dis

the EndianIStream to be read

Returns:: a vector of Complex

static vector<vector<Complex> > asdm::Complex::from2DBin ( EndianIStream & eis ) [static]

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

Parameters:

eiis

the EndianIStream to be read

Returns:: a vector of vector of Complex

static vector<vector<vector<Complex> > > asdm::Complex::from3DBin ( EndianIStream & eis ) [static]

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

Parameters:

eis

the EndianIStream to be read

Returns:: a vector of vector of vector of Complex

static Complex asdm::Complex::fromBin ( EndianIStream & eis ) [static]

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

Parameters:

eis

the EndianStream to be read

Returns:: an Complex

static Complex asdm::Complex::fromString ( const string & ) throw (NumberFormatException) [static]

static Complex asdm::Complex::getComplex ( StringTokenizer & t ) throw (NumberFormatException) [static]

double asdm::Complex::getImg ( ) const [inline]

Definition at line 174 of file ComplexWrapper.h.

References std::imag().

Referenced by toIDLComplex(), and toString().

double asdm::Complex::getReal ( ) const [inline]

Definition at line 170 of file ComplexWrapper.h.

References std::real().

Referenced by toIDLComplex(), and toString().

bool asdm::Complex::isZero ( ) const [inline]

Definition at line 186 of file ComplexWrapper.h.

References std::imag(), and std::real().

void asdm::Complex::setImg ( double im ) [inline]

Definition at line 182 of file ComplexWrapper.h.

References Complex(), and std::real().

void asdm::Complex::setReal ( double re ) [inline]

Definition at line 178 of file ComplexWrapper.h.

References Complex(), and std::imag().

static void asdm::Complex::toBin	(	const vector< vector< vector< Complex > > > &	cmplx,
		EndianOSStream &	eoss
	)			`[static]`

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

Parameters:

	cmplx	the vector of vector of vector of Complex to be written
	eoss	the EndianOSStream to be written to

static void asdm::Complex::toBin	(	const vector< vector< Complex > > &	cmplx,
		EndianOSStream &	eoss
	)			`[static]`

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

Parameters:

	cmplx	the vector of vector of Complex to be written
	eoss	the EndianOSStream to be written to

static void asdm::Complex::toBin	(	const vector< Complex > &	cmplx,
		EndianOSStream &	eoss
	)			`[static]`

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

Parameters:

	cmplx	the vector of Complex to be written
	eoss	the EndianOSStream to be written to

void asdm::Complex::toBin ( EndianOSStream & eoss )

Write the binary representation of this to a EndianOSStream.

IDLComplex asdm::Complex::toIDLComplex ( ) const [inline]

Definition at line 195 of file ComplexWrapper.h.

References getImg(), and getReal().

string asdm::Complex::toString ( ) const [inline]

Definition at line 203 of file ComplexWrapper.h.

References getImg(), and getReal().

static string asdm::Complex::toString ( const Complex & ) [static]

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

code/alma/ASDM/ComplexWrapper.h

asdm::Complex Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation