ObitTableDesc.h File Reference

ObitTableDesc Obit table descriptor class definition. More...

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

Go to the source code of this file.

Classes
struct	ObitTableDesc
	ObitTableDesc Class structure. More...
struct	ObitTableDescClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitTableDescUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitTableDesc returns a ObitTableDesc* (NULL).
#define	ObitTableDescRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitTableDesc.
#define	ObitTableDescIsA(in)   ObitIsA (in, ObitTableDescGetClass())
	Macro to determine if an object is the member of this or a derived class.
#define	Table_MAXDIM   7
	Maximum number of dimensions in regular data array.
#define	Table_MAX_RANP   14
	Maximum number of "random" parameters.
#define	TableLEN_VALUE   41
	Maximum length of descriptor string value.
#define	TableLEN_KEYWORD   21
	Maximum length of descriptor keyword.
Functions
void	ObitTableDescClassInit (void)
	Public: Class initializer.
ObitTableDesc *	newObitTableDesc (gchar *name)
	Public: Constructor.
ObitTableDesc *	ObitTableDescCopy (ObitTableDesc *in, ObitTableDesc *out, ObitErr *err)
	Public: Copy TableDesc.
gconstpointer	ObitTableDescGetClass (void)
	Public: Return class pointer.
void	ObitTableDescCopyDesc (ObitTableDesc *in, ObitTableDesc *out, ObitErr *err)
	Public: Copy descriptive (nonstructural) information.
void	ObitTableDescIndex (ObitTableDesc *in)
	Public: Index for easier access.
void	ObitTableDescRealloc (ObitTableDesc *in, glong nfield)
	Public: Reallocate arrays.
gboolean	ObitTableDescCompatible (ObitTableDesc *in1, ObitTableDesc *in2)
	Public: Check compatibility.

---

Detailed Description

ObitTableDesc Obit table descriptor class definition.

This class is derived from the Obit class. This contains information about the observations and the size and structure of the data.

Usage

Instances can be obtained using the newObitTableDesc constructor the ObitTableDescCopy copy constructor or a pointer duplicated using the ObitTableDescRef function. When an instance is no longer needed, use the ObitTableDescUnref macro to release it.

---

Define Documentation

#define ObitTableDescIsA (  in   )     ObitIsA (in, ObitTableDescGetClass())

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 ObitTableDescRef (  in   )     ObitRef (in)

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

#define ObitTableDescUnref (  in   )     ObitUnref (in)

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

#define Table_MAX_RANP   14

Maximum number of "random" parameters.

#define Table_MAXDIM   7

Maximum number of dimensions in regular data array.

#define TableLEN_KEYWORD   21

Maximum length of descriptor keyword.

#define TableLEN_VALUE   41

Maximum length of descriptor string value.

---

Function Documentation

ObitTableDesc* newObitTableDesc (  gchar *  name  )

Public: Constructor. Returns: pointer to object created.

void ObitTableDescClassInit (  void   )

Public: Class initializer.

gboolean ObitTableDescCompatible (  ObitTableDesc *  in1, ObitTableDesc *  in2 )

Public: Check compatibility. Checks number, type, label and dimension of each column Parameters: in1  Pointer first object in2  Pointer second object Returns: TRUE if Compatible, else FALSE

ObitTableDesc* ObitTableDescCopy (  ObitTableDesc *  in, ObitTableDesc *  out, ObitErr *  err )

Public: Copy TableDesc. The output descriptor will have the structure and values of the input 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 ObitTableDescCopyDesc (  ObitTableDesc *  in, ObitTableDesc *  out, ObitErr *  err )

Public: Copy descriptive (nonstructural) information. things that don't define the structure). Parameters: in  Pointer to object to be copied. out  Pointer to object to be written. err  ObitErr error stack

gconstpointer ObitTableDescGetClass (  void   )

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

void ObitTableDescIndex (  ObitTableDesc *  in  )

Public: Index for easier access. Parameters: in  Pointer to object.

void ObitTableDescRealloc (  ObitTableDesc *  in, glong  nfield )

Public: Reallocate arrays. Parameters: in  Pointer to object to reallocate. nfield  number of columns to allocate

---