ObitSourceList.h File Reference

ObitSourceList class definition. More...

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

Go to the source code of this file.

Classes
struct	ObitSourceList
	ObitSourceList Class. More...
struct	ObitSourceListClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitSourceListUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitSourceList returns a ObitSourceList*.
#define	ObitSourceListRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitSourceList.
#define	ObitSourceListIsA(in)   ObitIsA (in, ObitSourceListGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitSourceListClassInit (void)
	Public: Class initializer.
ObitSourceList *	newObitSourceList (gchar *name)
	Public: Constructor.
gconstpointer	ObitSourceListGetClass (void)
	Public: ClassInfo pointer.
ObitSourceList *	ObitSourceListCopy (ObitSourceList *in, ObitSourceList *out, ObitErr *err)
	Public: Copy constructor.
ObitSourceList *	ObitSourceListCreate (gchar *name, glong nsou)
	Public: Create from value.

---

Detailed Description

ObitSourceList class definition.

This class is derived from the Obit class.

This class is a list of sources.

Usage

Instances can be obtained using the newObitSourceList constructor, the ObitSourceListCopy constructor or a pointer duplicated using the ObitSourceListRef macro. When an instance is no longer needed, use the ObitSourceListUnref macro to release it.

---

Define Documentation

#define ObitSourceListIsA (  in   )     ObitIsA (in, ObitSourceListGetClass())

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

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

#define ObitSourceListUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitSourceList* newObitSourceList (  gchar *  name  )

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

void ObitSourceListClassInit (  void   )

Public: Class initializer.

ObitSourceList* ObitSourceListCopy (  ObitSourceList *  in, ObitSourceList *  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.

ObitSourceList* ObitSourceListCreate (  gchar *  name, glong  nsou )

Public: Create from value. Parameters: name  An optional name for the object. nsou  Number of sources (actually, the highest Source ID). Returns: the new object.

gconstpointer ObitSourceListGetClass (  void   )

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

---