casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
asdm::Complex Class Reference

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

#include <ComplexWrapper.h>

Inheritance diagram for asdm::Complex:

Public Member Functions

 Complex ()
 Complex constructors. More...
 
 Complex (const Complex &)
 
 Complex (const std::string &s)
 
 Complex (const asdmIDLTypes::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
 
std::string toString () const
 
asdmIDLTypes::IDLComplex toIDLComplex () const
 
void toBin (EndianOSStream &eoss)
 Write the binary representation of this to a EndianOSStream. More...
 

Static Public Member Functions

static Complex fromString (const std::string &) throw (NumberFormatException)
 
static std::string toString (const Complex &)
 
static Complex getComplex (StringTokenizer &t) throw (NumberFormatException)
 
static void toBin (const std::vector< Complex > &cmplx, EndianOSStream &eoss)
 Write the binary representation of a vector of Complex to a EndianOSStream. More...
 
static void toBin (const std::vector< std::vector< Complex > > &cmplx, EndianOSStream &eoss)
 Write the binary representation of a vector of vector of Complex to a EndianOSStream. More...
 
static void toBin (const std::vector< std::vector< std::vector< Complex > > > &cmplx, EndianOSStream &eoss)
 Write the binary representation of a vector of vector of vector of Complex to a EndianOSStream. More...
 
static Complex fromBin (EndianIStream &eis)
 Read the binary representation of an Complex from a EndianIStream and use the read value to set an Complex. More...
 
static std::vector< Complexfrom1DBin (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. More...
 
static std::vector
< std::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. More...
 
static std::vector
< std::vector< std::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. More...
 

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

Constructor & Destructor Documentation

asdm::Complex::Complex ( )
inline

Complex constructors.

Definition at line 145 of file ComplexWrapper.h.

Referenced by setImg(), and setReal().

asdm::Complex::Complex ( const Complex t)
inline

Definition at line 148 of file ComplexWrapper.h.

asdm::Complex::Complex ( const std::string &  s)
inline

Definition at line 151 of file ComplexWrapper.h.

asdm::Complex::Complex ( const asdmIDLTypes::IDLComplex &  l)
inline

Definition at line 155 of file ComplexWrapper.h.

asdm::Complex::Complex ( double  re,
double  im 
)
inline

Definition at line 159 of file ComplexWrapper.h.

Member Function Documentation

bool asdm::Complex::equals ( const Complex x) const
inline

Definition at line 182 of file ComplexWrapper.h.

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

static std::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
disthe EndianIStream to be read
Returns
a vector of Complex
static std::vector<std::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
eiisthe EndianIStream to be read
Returns
a vector of vector of Complex
static std::vector<std::vector<std::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
eisthe 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
eisthe EndianStream to be read
Returns
an Complex
static Complex asdm::Complex::fromString ( const std::string &  )
throw (NumberFormatException
)
static
static Complex asdm::Complex::getComplex ( StringTokenizer t)
throw (NumberFormatException
)
static
double asdm::Complex::getImg ( ) const
inline

Definition at line 166 of file ComplexWrapper.h.

References casacore::imag().

Referenced by toIDLComplex(), and toString().

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

Definition at line 162 of file ComplexWrapper.h.

References casacore::real().

Referenced by toIDLComplex(), and toString().

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

Definition at line 178 of file ComplexWrapper.h.

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

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

Definition at line 174 of file ComplexWrapper.h.

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

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

Definition at line 170 of file ComplexWrapper.h.

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

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

Write the binary representation of this to a EndianOSStream.

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

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

Parameters
cmplxthe vector of Complex to be written
eossthe EndianOSStream to be written to
static void asdm::Complex::toBin ( const std::vector< std::vector< Complex > > &  cmplx,
EndianOSStream eoss 
)
static

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

Parameters
cmplxthe vector of vector of Complex to be written
eossthe EndianOSStream to be written to
static void asdm::Complex::toBin ( const std::vector< std::vector< std::vector< Complex > > > &  cmplx,
EndianOSStream eoss 
)
static

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

Parameters
cmplxthe vector of vector of vector of Complex to be written
eossthe EndianOSStream to be written to
asdmIDLTypes::IDLComplex asdm::Complex::toIDLComplex ( ) const
inline

Definition at line 187 of file ComplexWrapper.h.

References getImg(), and getReal().

static std::string asdm::Complex::toString ( const Complex )
static
std::string asdm::Complex::toString ( ) const
inline

Definition at line 195 of file ComplexWrapper.h.

References getImg(), getReal(), and asdm::Double::toString().


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