ObitTableSel.h File Reference

ObitTableSel Obit Table selector class definition. More...

#include <glib.h>
#include "Obit.h"
#include "ObitTableDesc.h"
#include "ObitErr.h"
#include "ObitDef.h"
#include "ObitClassDef.h"

Go to the source code of this file.

Classes
struct	ObitTableSel
	ObitTableSel Class structure. More...
struct	ObitTableSelClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitTableSelUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitTableSel returns a ObitTableSel* (NULL).
#define	ObitTableSelRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitTableSel.
#define	ObitTableSelIsA(in)   ObitIsA (in, ObitTableSelGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitTableSelClassInit (void)
	Public: Class initializer.
ObitTableSel *	newObitTableSel (gchar *name)
	Public: Constructor.
gconstpointer	ObitTableSelGetClass (void)
	Public: Return class pointer.
ObitTableSel *	ObitTableSelCopy (ObitTableSel *in, ObitTableSel *out, ObitErr *err)
	Public: Copy TableSel.
glong	ObitTableSelBufferSize (ObitTableDesc *desc, ObitTableSel *sel)
	Public: How big a buffer is needed for a data transfer?
void	ObitTableSelDefault (ObitTableDesc *in, ObitTableSel *sel)
	Public: Enforces defaults in inaxes, blc, trc.
void	ObitTableSelSetDesc (ObitTableDesc *in, ObitTableSel *sel, ObitTableDesc *out, ObitErr *err)
	Public: Applies selection to a Descriptor.

---

Detailed Description

ObitTableSel Obit Table selector class definition.

This class is derived from the Obit class. This contains the descriptions of data selection and calibration.

Usage

Instances can be obtained using the newObitTableSel constructor the ObitTableSelCopy copy constructor or a pointer duplicated using the ObitTableSelRef function. When an instance is no longer needed, use the ObitTableSelUnref macro to release it.

---

Define Documentation

#define ObitTableSelIsA (  in   )     ObitIsA (in, ObitTableSelGetClass())

Macro to determine if an object is the member of this or a derived class. Returns TRUE if a member, else FALSE in = object to reference

#define ObitTableSelRef (  in   )     ObitRef (in)

Macro to reference (update reference count) an ObitTableSel. returns a ObitTableSel*. in = object to reference

#define ObitTableSelUnref (  in   )     ObitUnref (in)

Macro to unreference (and possibly destroy) an ObitTableSel returns a ObitTableSel* (NULL). in = object to unreference.

---

Function Documentation

ObitTableSel* newObitTableSel (  gchar *  name  )

Public: Constructor. Returns: pointer to object created.

glong ObitTableSelBufferSize (  ObitTableDesc *  desc, ObitTableSel *  sel )

Public: How big a buffer is needed for a data transfer? Parameters: desc  Pointer input descriptor. sel  Table selector. Returns: size in bytes needed for I/O.

void ObitTableSelClassInit (  void   )

Public: Class initializer.

ObitTableSel* ObitTableSelCopy (  ObitTableSel *  in, ObitTableSel *  out, ObitErr *  err )

Public: Copy TableSel. Parameters: in  Pointer to object to be copied. out  Pointer to object to be written. If NULL then a new structure is created. err  ObitErr error stack Returns: Pointer to new object.

void ObitTableSelDefault (  ObitTableDesc *  in, ObitTableSel *  sel )

Public: Enforces defaults in inaxes, blc, trc. Also indexes structure. Parameters: in  Pointer to descriptor. sel  Table selector.

gconstpointer ObitTableSelGetClass (  void   )

Public: Return class pointer. Initializes class if needed on first call. Returns: pointer to the class structure.

void ObitTableSelSetDesc (  ObitTableDesc *  in, ObitTableSel *  sel, ObitTableDesc *  out, ObitErr *  err )

Public: Applies selection to a Descriptor. Parameters: in  Pointer to input descriptor, this described the data as they appear on disk (possible compressed). sel  Table selector, blc, trc members changed if needed. out  Pointer to output descriptor, this describes the data after any processing when read, or before any compression on output. err  Obit error stack

---