CARMA C++
carma::sdp::MiriadUV Class Referenceabstract

Abstract base class for access to MIRIAD uv-data. More...

#include <carma/sdp/MiriadUV.h>

Inheritance diagram for carma::sdp::MiriadUV:
carma::sdp::Miriad carma::sdp::MiriadUVBin

Public Member Functions

 MiriadUV ()
 Constructor. More...
 
virtual void uvclose ()=0
 Close a UV dataset. More...
 
virtual void uvnext ()=0
 Go to next record. More...
 
virtual void uvopen (const char *name, const char *mode)=0
 Open a UV dataset. More...
 
virtual bool uvprobvr (const char *name, char &type, int &length, bool &update)=0
 Gives change information about a variable. More...
 
virtual void uvread (double preamble[5], float *data, int *flags, int n, int &nread)=0
 Read UV data. More...
 
virtual void uvset (const char *object, const char *type, int n, double p1, double p2, double p3)=0
 Set UV dataset processing options. More...
 
virtual void uvwread (float *data, int *flags, int n, int &nread)=0
 Similar to uvread but for 'wide'. More...
 
virtual void uvwrite (const double preamble[5], const float *data, const int *flags, int n)=0
 Write UV data. More...
 
virtual void uvwwrite (const float *data, const int *flags, int n)=0
 Similar to uvwrite but for 'wide'. More...
 
virtual ~MiriadUV ()
 Destructor. More...
 
UV variable I/O routines.
virtual void uvgetvra (const char *name, char *buf, size_t n)=0
 Get ASCII. More...
 
virtual void uvgetvrj (const char *name, int &buf)
 Get one short. More...
 
virtual void uvgetvrj (const char *name, int *buf, int n)=0
 Get array of shorts (Note use of int array!). More...
 
virtual void uvgetvri (const char *name, int &buf)
 Get an integer value. More...
 
virtual void uvgetvri (const char *name, int *buf, int n)=0
 Get an array of ints. More...
 
virtual void uvgetvrr (const char *name, float &buf)
 Get a float value. More...
 
virtual void uvgetvrr (const char *name, float *buf, int n)=0
 Get an array of floats. More...
 
virtual void uvgetvrd (const char *name, double &buf)
 Get a double value. More...
 
virtual void uvgetvrd (const char *name, double *buf, int n)=0
 Get an array of doubles. More...
 
virtual void uvgetvrc (const char *name, float &buf)
 Get a complex value. More...
 
virtual void uvgetvrc (const char *name, float *buf, int n)=0
 Get an array of complex values. More...
 
virtual void uvputvra (const char *name, const char *buf)=0
 Output an ASCII buffer. More...
 
virtual void uvputvrj (const char *name, const int *buf, int n)=0
 Output an array of shorts. More...
 
virtual void uvputvrj (const char *name, const int buf)
 Output a short value. More...
 
virtual void uvputvri (const char *name, const int buf)
 Output an int value. More...
 
virtual void uvputvri (const char *name, const int *buf, int n)=0
 Output an array of ints. More...
 
virtual void uvputvrr (const char *name, const float buf)
 Output a float value. More...
 
virtual void uvputvrr (const char *name, const float *buf, int n)=0
 Output an array of floats. More...
 
virtual void uvputvrd (const char *name, const double buf)
 Output a double value. More...
 
virtual void uvputvrd (const char *name, const double *buf, int n)=0
 Output an array of doubles. More...
 
virtual void uvputvrc (const char *name, const float &buf)
 Output a complex value. More...
 
virtual void uvputvrc (const char *name, const float *buf, int n)=0
 Output an array of complex values. More...
 
- Public Member Functions inherited from carma::sdp::Miriad
const std::string & getFileName () const
 Return name of dataset. More...
 
int getHandle () const
 Return handle for dataset. More...
 
bool isOld () const
 Is this an 'old' dataset? More...
 
bool isOpen () const
 Is dataset open? More...
 
bool justGather ()
 
 Miriad ()
 Constructor. More...
 
const std::string & name () const
 Return name of dataset. More...
 
void setGather (const bool gather)
 
virtual ~Miriad ()
 Destructor. More...
 
virtual void hisopen (const char *status=0)=0
 Opens history file. More...
 
virtual void hisclose ()=0
 Close history file. More...
 
bool isHistoryOpen () const
 Is history files open? More...
 
virtual bool hisread (char *line, int linelength)=0
 Read one line from history file. More...
 
virtual void hiswrite (const char *line)=0
 Write one history line. More...
 
virtual void hopen (const char *name, const char *status, int &iostat)=0
 Open a MIRIAD dataset. More...
 
virtual void hclose ()=0
 Close a MIRIAD dataset. More...
 
virtual void haccess (int &handle, const char *name, const char *status, int &iostat)=0
 Open a file as some part of a data set. More...
 
virtual void hreada (int handle, char *buf, int buflen, int &iostat)=0
 Read ascii string terminated by a newline. More...
 
virtual void hdaccess (int handle, int &iostat)=0
 Close file. More...
 
virtual void hwritea (int handle, const char *buf, int buflen, int &iostat)=0
 Write ASCII text. More...
 

Additional Inherited Members

- Protected Member Functions inherited from carma::sdp::Miriad
void mirclose ()
 Sets the isOpen_ and hisOpen flags to false and tno_ to -1. More...
 
void miropen (int tno, const std::string &name, bool isOld)
 Sets various variables relating to an open dataset. More...
 
void setHistoryIsOpen (bool isopen)
 Sets the flag indicating the history file status. More...
 

Detailed Description

Abstract base class for access to MIRIAD uv-data.

Definition at line 24 of file MiriadUV.h.

Constructor & Destructor Documentation

carma::sdp::MiriadUV::MiriadUV ( )

Constructor.

virtual carma::sdp::MiriadUV::~MiriadUV ( )
virtual

Destructor.

Member Function Documentation

virtual void carma::sdp::MiriadUV::uvclose ( )
pure virtual

Close a UV dataset.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvgetvra ( const char *  name,
char *  buf,
size_t  n 
)
pure virtual

Get ASCII.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvgetvrc ( const char *  name,
float &  buf 
)
virtual

Get a complex value.

Reimplemented in carma::sdp::MiriadUVBin.

Definition at line 90 of file MiriadUV.h.

virtual void carma::sdp::MiriadUV::uvgetvrc ( const char *  name,
float *  buf,
int  n 
)
pure virtual

Get an array of complex values.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvgetvrd ( const char *  name,
double &  buf 
)
virtual

Get a double value.

Reimplemented in carma::sdp::MiriadUVBin.

Definition at line 83 of file MiriadUV.h.

virtual void carma::sdp::MiriadUV::uvgetvrd ( const char *  name,
double *  buf,
int  n 
)
pure virtual

Get an array of doubles.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvgetvri ( const char *  name,
int &  buf 
)
virtual

Get an integer value.

Reimplemented in carma::sdp::MiriadUVBin.

Definition at line 68 of file MiriadUV.h.

virtual void carma::sdp::MiriadUV::uvgetvri ( const char *  name,
int *  buf,
int  n 
)
pure virtual

Get an array of ints.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvgetvrj ( const char *  name,
int &  buf 
)
virtual

Get one short.

(Note use of int variable!).

Reimplemented in carma::sdp::MiriadUVBin.

Definition at line 60 of file MiriadUV.h.

virtual void carma::sdp::MiriadUV::uvgetvrj ( const char *  name,
int *  buf,
int  n 
)
pure virtual

Get array of shorts (Note use of int array!).

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvgetvrr ( const char *  name,
float &  buf 
)
virtual

Get a float value.

Reimplemented in carma::sdp::MiriadUVBin.

Definition at line 76 of file MiriadUV.h.

virtual void carma::sdp::MiriadUV::uvgetvrr ( const char *  name,
float *  buf,
int  n 
)
pure virtual

Get an array of floats.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvnext ( )
pure virtual

Go to next record.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvopen ( const char *  name,
const char *  mode 
)
pure virtual

Open a UV dataset.

Implemented in carma::sdp::MiriadUVBin.

virtual bool carma::sdp::MiriadUV::uvprobvr ( const char *  name,
char &  type,
int &  length,
bool &  update 
)
pure virtual

Gives change information about a variable.

Parameters
nameName of variable.
typeType of variable. (a, j, i, r, d, c).
lengthLength of variable.
updateIf true, the variable has changed.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvputvra ( const char *  name,
const char *  buf 
)
pure virtual

Output an ASCII buffer.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvputvrc ( const char *  name,
const float &  buf 
)
virtual

Output a complex value.

Reimplemented in carma::sdp::MiriadUVBin.

Definition at line 133 of file MiriadUV.h.

virtual void carma::sdp::MiriadUV::uvputvrc ( const char *  name,
const float *  buf,
int  n 
)
pure virtual

Output an array of complex values.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvputvrd ( const char *  name,
const double  buf 
)
virtual

Output a double value.

Reimplemented in carma::sdp::MiriadUVBin.

Definition at line 125 of file MiriadUV.h.

virtual void carma::sdp::MiriadUV::uvputvrd ( const char *  name,
const double *  buf,
int  n 
)
pure virtual

Output an array of doubles.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvputvri ( const char *  name,
const int  buf 
)
virtual

Output an int value.

Reimplemented in carma::sdp::MiriadUVBin.

Definition at line 109 of file MiriadUV.h.

virtual void carma::sdp::MiriadUV::uvputvri ( const char *  name,
const int *  buf,
int  n 
)
pure virtual

Output an array of ints.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvputvrj ( const char *  name,
const int *  buf,
int  n 
)
pure virtual

Output an array of shorts.

(Note use of int buffer)!

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvputvrj ( const char *  name,
const int  buf 
)
virtual

Output a short value.

Reimplemented in carma::sdp::MiriadUVBin.

Definition at line 105 of file MiriadUV.h.

virtual void carma::sdp::MiriadUV::uvputvrr ( const char *  name,
const float  buf 
)
virtual

Output a float value.

Reimplemented in carma::sdp::MiriadUVBin.

Definition at line 117 of file MiriadUV.h.

virtual void carma::sdp::MiriadUV::uvputvrr ( const char *  name,
const float *  buf,
int  n 
)
pure virtual

Output an array of floats.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvread ( double  preamble[5],
float *  data,
int *  flags,
int  n,
int &  nread 
)
pure virtual

Read UV data.

Parameters
preamble
data
flags
n
nread

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvset ( const char *  object,
const char *  type,
int  n,
double  p1,
double  p2,
double  p3 
)
pure virtual

Set UV dataset processing options.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvwread ( float *  data,
int *  flags,
int  n,
int &  nread 
)
pure virtual

Similar to uvread but for 'wide'.

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvwrite ( const double  preamble[5],
const float *  data,
const int *  flags,
int  n 
)
pure virtual

Write UV data.

Parameters
preamble
data
flags
n

Implemented in carma::sdp::MiriadUVBin.

virtual void carma::sdp::MiriadUV::uvwwrite ( const float *  data,
const int *  flags,
int  n 
)
pure virtual

Similar to uvwrite but for 'wide'.

Implemented in carma::sdp::MiriadUVBin.


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