ObitGBTDCRStateInfo.h File Reference

ObitGBTDCRStateInfo class definition. More...

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

Go to the source code of this file.

Classes
struct	ObitGBTDCRStateInfo
	ObitGBTDCRStateInfo Class. More...
struct	ObitGBTDCRStateInfoClassInfo
	ClassInfo Structure. More...
Defines
#define	MAXNUMDCRSTATE   10
#define	ObitGBTDCRStateInfoUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitGBTDCRStateInfo returns a ObitGBTDCRStateInfo*.
#define	ObitGBTDCRStateInfoRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitGBTDCRStateInfo.
#define	ObitGBTDCRStateInfoIsA(in)   ObitIsA (in, ObitGBTDCRStateInfoGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitGBTDCRStateInfoClassInit (void)
	Public: Class initializer.
ObitGBTDCRStateInfo *	newObitGBTDCRStateInfo (gchar *name)
	Public: Constructor.
ObitGBTDCRStateInfo *	newObitGBTDCRStateInfoValue (gchar *name, gint disk, gchar *scan, ObitErr *err)
	Public: Constructor from values.
gconstpointer	ObitGBTDCRStateInfoGetClass (void)
	Public: ClassInfo pointer.
ObitGBTDCRStateInfo *	ObitGBTDCRStateInfoCopy (ObitGBTDCRStateInfo *in, ObitGBTDCRStateInfo *out, ObitErr *err)
	Public: Copy constructor.

---

Detailed Description

ObitGBTDCRStateInfo class definition.

This class is derived from the Obit class.

This class contains information about the GBT observing DCRState. Frequency and polarization information are retrieved from GBT archive files.

Usage

Instances can be obtained using the newObitGBTDCRStateInfo constructor, the ObitGBTDCRStateInfoCopy constructor or a pointer duplicated using the ObitGBTDCRStateInfoRef macro. When an instance is no longer needed, use the ObitGBTDCRStateInfoUnref macro to release it.

---

Define Documentation

#define MAXNUMDCRSTATE   10

#define ObitGBTDCRStateInfoIsA (  in   )     ObitIsA (in, ObitGBTDCRStateInfoGetClass())

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

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

#define ObitGBTDCRStateInfoUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitGBTDCRStateInfo* newObitGBTDCRStateInfo (  gchar *  name  )

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

ObitGBTDCRStateInfo* newObitGBTDCRStateInfoValue (  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 ObitGBTDCRStateInfoClassInit (  void   )

Public: Class initializer.

ObitGBTDCRStateInfo* ObitGBTDCRStateInfoCopy (  ObitGBTDCRStateInfo *  in, ObitGBTDCRStateInfo *  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 ObitGBTDCRStateInfoGetClass (  void   )

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

---