ObitGBTBeamOffInfo.h File Reference

ObitGBTBeamOffInfo class definition. More...

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

Go to the source code of this file.

Classes
struct	ObitGBTBeamOffInfo
	ObitGBTBeamOffInfo Class. More...
struct	ObitGBTBeamOffInfoClassInfo
	ClassInfo Structure. More...
Defines
#define	MAXNUMBEAMOFF   10
#define	ObitGBTBeamOffInfoUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitGBTBeamOffInfo returns a ObitGBTBeamOffInfo*.
#define	ObitGBTBeamOffInfoRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitGBTBeamOffInfo.
#define	ObitGBTBeamOffInfoIsA(in)   ObitIsA (in, ObitGBTBeamOffInfoGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitGBTBeamOffInfoClassInit (void)
	Public: Class initializer.
ObitGBTBeamOffInfo *	newObitGBTBeamOffInfo (gchar *name)
	Public: Constructor.
ObitGBTBeamOffInfo *	newObitGBTBeamOffInfoValue (gchar *name, gint disk, gchar *scan, ObitErr *err)
	Public: Constructor from values.
gconstpointer	ObitGBTBeamOffInfoGetClass (void)
	Public: ClassInfo pointer.
ObitGBTBeamOffInfo *	ObitGBTBeamOffInfoCopy (ObitGBTBeamOffInfo *in, ObitGBTBeamOffInfo *out, ObitErr *err)
	Public: Copy constructor.

---

Detailed Description

ObitGBTBeamOffInfo class definition.

This class is derived from the Obit class.

This class contains information about GBT Beam Offsets Frequency and polarization information are retrieved from GBT archive files.

Usage

Instances can be obtained using the newObitGBTBeamOffInfo constructor, the ObitGBTBeamOffInfoCopy constructor or a pointer duplicated using the ObitGBTBeamOffInfoRef macro. When an instance is no longer needed, use the ObitGBTBeamOffInfoUnref macro to release it.

---

Define Documentation

#define MAXNUMBEAMOFF   10

#define ObitGBTBeamOffInfoIsA (  in   )     ObitIsA (in, ObitGBTBeamOffInfoGetClass())

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

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

#define ObitGBTBeamOffInfoUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitGBTBeamOffInfo* newObitGBTBeamOffInfo (  gchar *  name  )

Public: Constructor. Initializes class if needed on first call. Parameters: name  A name for the object Returns: the new object.

ObitGBTBeamOffInfo* newObitGBTBeamOffInfoValue (  gchar *  name, gint  disk, gchar *  scan, ObitErr *  err )

Public: Constructor from values. Parameters: name  A name for the object 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 ObitGBTBeamOffInfoClassInit (  void   )

Public: Class initializer.

ObitGBTBeamOffInfo* ObitGBTBeamOffInfoCopy (  ObitGBTBeamOffInfo *  in, ObitGBTBeamOffInfo *  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 ObitGBTBeamOffInfoGetClass (  void   )

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

---