ObitGBTCCBStateInfo.h File Reference

ObitGBTCCBStateInfo class definition. More...

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

Go to the source code of this file.

Classes
struct	ObitGBTCCBStateInfo
	ObitGBTCCBStateInfo Class. More...
struct	ObitGBTCCBStateInfoClassInfo
	ClassInfo Structure. More...
Defines
#define	MAXNUMCCBSTATE   10
#define	ObitGBTCCBStateInfoUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitGBTCCBStateInfo returns a ObitGBTCCBStateInfo*.
#define	ObitGBTCCBStateInfoRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitGBTCCBStateInfo.
#define	ObitGBTCCBStateInfoIsA(in)   ObitIsA (in, ObitGBTCCBStateInfoGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitGBTCCBStateInfoClassInit (void)
	Public: Class initializer.
ObitGBTCCBStateInfo *	newObitGBTCCBStateInfo (gchar *name)
	Public: Constructor.
ObitGBTCCBStateInfo *	newObitGBTCCBStateInfoValue (gchar *name, gint disk, gchar *scan, ObitErr *err)
	Public: Constructor from values.
gconstpointer	ObitGBTCCBStateInfoGetClass (void)
	Public: ClassInfo pointer.
ObitGBTCCBStateInfo *	ObitGBTCCBStateInfoCopy (ObitGBTCCBStateInfo *in, ObitGBTCCBStateInfo *out, ObitErr *err)
	Public: Copy constructor.

---

Detailed Description

ObitGBTCCBStateInfo class definition.

This class is derived from the Obit class.

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

Usage

Instances can be obtained using the newObitGBTCCBStateInfo constructor, the ObitGBTCCBStateInfoCopy constructor or a pointer duplicated using the ObitGBTCCBStateInfoRef macro. When an instance is no longer needed, use the ObitGBTCCBStateInfoUnref macro to release it.

---

Define Documentation

#define MAXNUMCCBSTATE   10

#define ObitGBTCCBStateInfoIsA (  in   )     ObitIsA (in, ObitGBTCCBStateInfoGetClass())

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

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

#define ObitGBTCCBStateInfoUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitGBTCCBStateInfo* newObitGBTCCBStateInfo (  gchar *  name  )

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

ObitGBTCCBStateInfo* newObitGBTCCBStateInfoValue (  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 ObitGBTCCBStateInfoClassInit (  void   )

Public: Class initializer.

ObitGBTCCBStateInfo* ObitGBTCCBStateInfoCopy (  ObitGBTCCBStateInfo *  in, ObitGBTCCBStateInfo *  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 ObitGBTCCBStateInfoGetClass (  void   )

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

---