Main Page | Class List | Directories | File List | Class Members | File Members

ObitGBTIFInfo.h File Reference

ObitGBTIFInfo class definition. More...

#include <glib.h>
#include "Obit.h"
#include "ObitErr.h"

Go to the source code of this file.

Classes

struct  ObitGBTIFInfo
 ObitGBTIFInfo Class. More...
struct  ObitGBTIFInfoClassInfo
 ClassInfo Structure. More...

Defines

#define MAXNUMIF   50
#define ObitGBTIFInfoUnref(in)   ObitUnref (in)
 Macro to unreference (and possibly destroy) an ObitGBTIFInfo returns a ObitGBTIFInfo*.
#define ObitGBTIFInfoRef(in)   ObitRef (in)
 Macro to reference (update reference count) an ObitGBTIFInfo.
#define ObitGBTIFInfoIsA(in)   ObitIsA (in, ObitGBTIFInfoGetClass())
 Macro to determine if an object is the member of this or a derived class.

Functions

void ObitGBTIFInfoClassInit (void)
 Public: Class initializer.
ObitGBTIFInfonewObitGBTIFInfo (gchar *name)
 Public: Constructor.
ObitGBTIFInfonewObitGBTIFInfoValue (gchar *name, gchar *backend, gint disk, gchar *scan, ObitErr *err)
 Public: Constructor from values.
gconstpointer ObitGBTIFInfoGetClass (void)
 Public: ClassInfo pointer.
ObitGBTIFInfoObitGBTIFInfoCopy (ObitGBTIFInfo *in, ObitGBTIFInfo *out, ObitErr *err)
 Public: Copy constructor.


Detailed Description

ObitGBTIFInfo class definition.

This class is derived from the Obit class.

This class contains information about a GBT IF setup. Frequency and polarization information are retrieved from GBT archive files.

Usage

Instances can be obtained using the newObitGBTIFInfo constructor, the ObitGBTIFInfoCopy constructor or a pointer duplicated using the ObitGBTIFInfoRef macro. When an instance is no longer needed, use the ObitGBTIFInfoUnref macro to release it.

Define Documentation

#define MAXNUMIF   50
 

#define ObitGBTIFInfoIsA in   )     ObitIsA (in, ObitGBTIFInfoGetClass())
 

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

Macro to reference (update reference count) an ObitGBTIFInfo.

returns a ObitGBTIFInfo*. in = object to reference

#define ObitGBTIFInfoUnref in   )     ObitUnref (in)
 

Macro to unreference (and possibly destroy) an ObitGBTIFInfo returns a ObitGBTIFInfo*.

in = object to unreference


Function Documentation

ObitGBTIFInfo* newObitGBTIFInfo gchar *  name  ) 
 

Public: Constructor.

Initializes class if needed on first call.

Parameters:
name A name for the object
Returns:
the new object.

ObitGBTIFInfo* newObitGBTIFInfoValue gchar *  name,
gchar *  backend,
gint  disk,
gchar *  scan,
ObitErr *  err
 

Public: Constructor from values.

Parameters:
name A name for the object
backend Name of the backend for which the information is desired (e.g. "DCR", "SpectralProcessor")
disk Obit FITS disk number
scan Date/time scan name (e.g. "2003_05_05_05:32:56")
err Obit error stack object.
Returns:
the new object.

void ObitGBTIFInfoClassInit void   ) 
 

Public: Class initializer.

ObitGBTIFInfo* ObitGBTIFInfoCopy ObitGBTIFInfo in,
ObitGBTIFInfo out,
ObitErr *  err
 

Public: Copy constructor.

Parent class members are included but any derived class info is ignored.

Parameters:
in The object to copy
out An existing object pointer for output or NULL if none exists.
err Obit error stack object.
Returns:
pointer to the new object.

gconstpointer ObitGBTIFInfoGetClass void   ) 
 

Public: ClassInfo pointer.

Initializes class if needed on first call.

Returns:
pointer to the class structure.


Generated on Mon Sep 3 20:43:53 2007 by  doxygen 1.3.9.1