ObitSystem.h File Reference

ObitSystem manager class. More...

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

Go to the source code of this file.

Classes
struct	ObitSystem
	ObitSystem Class structure. More...
struct	ObitSystemClassInfo
	ClassInfo Structure. More...
Typedefs
typedef ObitSystem *(*	ObitSystemStartupFP )(gchar *pgmName, gint pgmNumber, gint AIPSuser, gint numberAIPSdisk, gchar *AIPSdir[], gint numberFITSdisk, gchar *FITSdir[], ObitErr *err)
	define type for ClassInfo structure
typedef ObitSystem *(*	ObitSystemShutdownFP )(ObitSystem *in)
typedef void(*	ObitSystemGetScratchFP )(ObitIOType FileType, gchar *type, ObitInfoList *info, ObitErr *err)
typedef void(*	ObitSystemAddScratchFP )(Obit *in, ObitErr *err)
typedef void(*	ObitSystemFreeScratchFP )(Obit *in, ObitErr *err)
Functions
void	ObitSystemClassInit (void)
	Public: Class initializer.
ObitSystem *	ObitSystemStartup (gchar *pgmName, gint pgmNumber, gint AIPSuser, gint numberAIPSdisk, gchar *AIPSdir[], gint numberFITSdisk, gchar *FITSdir[], oint F_TRUE, oint F_FALSE, ObitErr *err)
	Public: startup/Constructor.
gconstpointer	ObitSystemGetClass (void)
	Public: Return class pointer.
ObitSystem *	ObitSystemShutdown (ObitSystem *in)
	Public: Shutdown.
void	ObitSystemGetScratch (ObitIOType FileType, gchar *type, ObitInfoList *info, ObitErr *err)
	Public: Get Scratch file assignments.
void	ObitSystemAddScratch (Obit *in, ObitErr *err)
	Public: Add Scratch file assignments.
void	ObitSystemFreeScratch (Obit *in, ObitErr *err)
	Public: Free Scratch file assignments.
gboolean	ObitSystemIsInit (void)
	Public: Tell If Obit is initialized.
gchar *	ObitSystemGetPgmName (void)
	Public: Tell Program Name.
void	ObitSystemSetPgmName (gchar *pgmName)
	Public: Reset Program Name.
gint	ObitSystemGetPgmNumber (void)
	Public: Tell Program Number.
void	ObitSystemSetPgmNumber (gint pgmNumber)
	Public: Reset Program Number.
gint	ObitSystemGetAIPSuser (void)
	Public: Tell AIPS user ID.
void	ObitSystemSetAIPSuser (gint AIPSuser)
	Public: Reset AIPS user ID.

---

Detailed Description

ObitSystem manager class.

This class is derived from the Obit class.

This system wide information and controls creation and destruction of Scratch files. There should be one and only one instance of ObitSystem.

Scratch files.

The ObitSystem assists in creating and maintains a registry of scratch files.

• ObitSystemGetScratch assigns naming information to an info for a scratch object and assigns whatever resources are needed (e.g. assign AIPS catalog slot)
• ObitSystemAddScratch registers a scratch file. Any scratch files remaining in the list when ObitSystemShutdown is called will be Unreffed causing their destruction.
• ObitSystemFreeScratch removes an entry from the scratch file list.

Usage

Instances can be obtained using the ObitSystemStartup constructor and deleted using the ObitSystemShutdown function. Obit function calls should only be made between these two ObitSystem calls.

---

Typedef Documentation

typedef void(* ObitSystemAddScratchFP)(Obit *in, ObitErr *err)

typedef void(* ObitSystemFreeScratchFP)(Obit *in, ObitErr *err)

typedef void(* ObitSystemGetScratchFP)(ObitIOType FileType, gchar *type, ObitInfoList *info, ObitErr *err)

typedef ObitSystem*(* ObitSystemShutdownFP)(ObitSystem *in)

typedef ObitSystem*(* ObitSystemStartupFP)(gchar *pgmName, gint pgmNumber, gint AIPSuser, gint numberAIPSdisk, gchar *AIPSdir[], gint numberFITSdisk, gchar *FITSdir[], ObitErr *err)

define type for ClassInfo structure

---

Function Documentation

void ObitSystemAddScratch (  Obit *  in, ObitErr *  err )

Public: Add Scratch file assignments. Parameters: in  Object (ObitUV or ObitImage) to add to list err  Obit error stack for any error messages.

void ObitSystemClassInit (  void   )

Public: Class initializer.

void ObitSystemFreeScratch (  Obit *  in, ObitErr *  err )

Public: Free Scratch file assignments. Parameters: in  Object (ObitUV or ObitImage) to remove from list err  Obit error stack for any error messages.

gint ObitSystemGetAIPSuser (  void   )

Public: Tell AIPS user ID. Returns: AIPS user number

gconstpointer ObitSystemGetClass (  void   )

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

gchar* ObitSystemGetPgmName (  void   )

Public: Tell Program Name. Returns: Program name

gint ObitSystemGetPgmNumber (  void   )

Public: Tell Program Number. Returns: Program number

void ObitSystemGetScratch (  ObitIOType  FileType, gchar *  type, ObitInfoList *  info, ObitErr *  err )

Public: Get Scratch file assignments. Parameters: FileType  File system type (OBIT_IO_FITS, OBIT_IO_AIPS); type  File type ("MA", "UV" for AIPS, not used for FITS) info  ObitInfoList to write assignments to err  Obit error stack for any error messages.

gboolean ObitSystemIsInit (  void   )

Public: Tell If Obit is initialized. Returns: TRUE if Obit initialized, else FALSE

void ObitSystemSetAIPSuser (  gint  AIPSuser  )

Public: Reset AIPS user ID. Parameters: AIPSuser  AIPS user number

void ObitSystemSetPgmName (  gchar *  pgmName  )

Public: Reset Program Name. Parameters: pgmName  Program name

void ObitSystemSetPgmNumber (  gint  pgmNumber  )

Public: Reset Program Number. Parameters: pgmNumber  Program number

ObitSystem* ObitSystemShutdown (  ObitSystem *  in  )

Public: Shutdown. Parameters: in  Object to shutdown Returns: NULL pointer for object destroyed..

ObitSystem* ObitSystemStartup (  gchar *  pgmName, gint  pgmNumber, gint  AIPSuser, gint  numberAIPSdisk, gchar *  AIPSdir[], gint  numberFITSdisk, gchar *  FITSdir[], oint  F_TRUE, oint  F_FALSE, ObitErr *  err )

Public: startup/Constructor. Parameters: pgmName  Name of program (max 5 char if AIPS) If NULL or empty (zero length), no start/shutdown messages pgmNumber  Version number of program (e.g. POPS number). AIPSuser  AIPS user number if using AIPS files numberAIPSdisk  Number of AIPS disks If 0, no AIPS files. AIPSdir  List of AIPS directory names If NULL none. numberFITSdisk  Number of FITS disks If 0, no FITS files. FITSdir  List of FITS directory names If NULL none. F_TRUE  Value of Fortran TRUE (used in Fortran interface) F_FALSE  Value of Fortran FALSE err  Obit error stack for any error messages. Returns: pointer to object created.

---