ObitAntenna.h File Reference

ObitAntenna class definition. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitDef.h"
#include "ObitClassDef.h"

Go to the source code of this file.

Classes
struct	ObitAntenna
	ObitAntenna Class. More...
struct	ObitAntennaClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitAntennaUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitAntenna returns a ObitAntenna*.
#define	ObitAntennaRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitAntenna.
#define	ObitAntennaIsA(in)   ObitIsA (in, ObitAntennaGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitAntennaClassInit (void)
	Public: Class initializer.
ObitAntenna *	newObitAntenna (gchar *name)
	Public: Constructor.
gconstpointer	ObitAntennaGetClass (void)
	Public: ClassInfo pointer.
ObitAntenna *	ObitAntennaCopy (ObitAntenna *in, ObitAntenna *out, ObitErr *err)
	Public: Copy constructor.

---

Detailed Description

ObitAntenna class definition.

This class is derived from the Obit class.

This class contains information about a given antenna.

Usage

Instances can be obtained using the newObitAntenna constructor, the ObitAntennaCopy constructor or a pointer duplicated using the ObitAntennaRef macro. When an instance is no longer needed, use the ObitAntennaUnref macro to release it.

---

Define Documentation

#define ObitAntennaIsA (  in   )     ObitIsA (in, ObitAntennaGetClass())

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

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

#define ObitAntennaUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitAntenna* newObitAntenna (  gchar *  name  )

Public: Constructor. Initializes class if needed on first call. Returns: the new object.

void ObitAntennaClassInit (  void   )

Public: Class initializer.

ObitAntenna* ObitAntennaCopy (  ObitAntenna *  in, ObitAntenna *  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 ObitAntennaGetClass (  void   )

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

---