ObitAIPSObject.h File Reference

ObitAIPSObject module definition. More...

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

Go to the source code of this file.

Classes
union	ObitAIPSCatEquiv
	AIPS catalog header. More...
Defines
#define	MAXAIPSOBJDIM   5
	Maximum number of dimensions.
Typedefs
typedef gchar	AIPSObj [32]
	Typedef for AIPS Object name.
typedef gchar	AIPSObjClass [8]
	Typedef for AIPS Object class.
typedef gchar	AIPSKey [8]
	Typedef for AIPS Object keyword.
typedef oint	AIPSKeyDim [MAXAIPSOBJDIM]
	Typedef for AIPS Object keyword dimension.
Enumerations
enum	obitAIPSObjectType {   OBIT_AIPSObjectInt = 4, OBIT_AIPSObjectRe = 2, OBIT_AIPSObjectDP = 1, OBIT_AIPSObjectCar = 3,   OBIT_AIPSObjectLog = 5 }
	enum for AIPS object keyword type. More...
Functions
void	ObitAIPSObjectOBinit (oint *ierr)
	Public: Initialize AIPS Object manager.
void	ObitAIPSObjectOBvhkw (AIPSObjClass class, AIPSKey keyword, ObitAIPSObjectType type, oint *ierr)
	Public: Add a Catalog header keyword to the virtual keyword list.
void	ObitAIPSObjectOBkeyv (oint objnum, AIPSKey keywrd, oint *keypnt, gint *ierr, ObitErr *err)
	Public: See if keyword is an object dependent, virtual keyword.
void	ObitAIPSObjectOBrget (oint objnum, AIPSKey keywrd, ObitAIPSObjectType *type, AIPSKeyDim dim, gpointer value, gchar *valuec, ObitErr *err)
	Public: Fetch the value (array) for a specified real (non-virtual) keyword.
void	ObitAIPSObjectOBcrea (AIPSObj name, AIPSObjClass class, ObitErr *err)
	Public: Associate an object slot with an object name.
void	ObitAIPSObjectOBfree (AIPSObj name, ObitErr *err)
	Public: Free the object slot associated with an object.
void	ObitAIPSObjectOBname (AIPSObj name, oint *objnum, ObitErr *err)
	Public: Look up the object slot number of object with name "name".
void	ObitAIPSObjectOBclass (oint objnum, oint *classno, AIPSObjClass name, ObitErr *err)
	Public: Look up the class number/name of object number objnum.
void	ObitAIPSObjectOBput (oint objnum, AIPSKey keywrd, ObitAIPSObjectType type, AIPSKeyDim dim, gpointer value, gchar *valuec, ObitErr *err)
	Public: Save an entry in an object creating it if necessary.
void	ObitAIPSObjectOBget (oint objnum, AIPSKey keywrd, ObitAIPSObjectType *type, AIPSKeyDim dim, gpointer value, gchar *valuec, ObitErr *err)
	Public: Fetch the value (array) for a specified keyword.
gboolean	ObitAIPSObjectOBinfo (oint objnum, AIPSKey keywrd, ObitAIPSObjectType *type, AIPSKeyDim dim, ObitErr *err)
	Public: Check for for a specified keyword.
void	ObitAIPSObjectOBdskc (AIPSObj name, oint *disk, oint *cno, ObitErr *err)
	Public: Return Disk and slot information for object.
void	ObitAIPSObjectOBhget (AIPSObj name, union ObitAIPSCatEquiv cat, ObitErr *err)
	Public: Return catalog header record for an object.
void	ObitAIPSObjectOBhput (AIPSObj name, union ObitAIPSCatEquiv cat, ObitErr *err)
	Public: Store catalog header record for an object.
void	ObitAIPSObjectOBcopy (AIPSObj namein, AIPSObj namout, ObitErr *err)
	Public: Copies one image to another.

---

Detailed Description

ObitAIPSObject module definition.

This is a Utility module to handle the interface with the AIPS object system.

---

Define Documentation

#define MAXAIPSOBJDIM   5

Maximum number of dimensions.

---

Typedef Documentation

typedef gchar AIPSKey[8]

Typedef for AIPS Object keyword.

typedef oint AIPSKeyDim[MAXAIPSOBJDIM]

Typedef for AIPS Object keyword dimension.

typedef gchar AIPSObj[32]

Typedef for AIPS Object name.

typedef gchar AIPSObjClass[8]

Typedef for AIPS Object class.

---

Enumeration Type Documentation

enum obitAIPSObjectType

enum for AIPS object keyword type. Defined in $INC/PAOOF.INC Enumeration values: OBIT_AIPSObjectInt  Integer type. OBIT_AIPSObjectRe  Float type. OBIT_AIPSObjectDP  Double type. OBIT_AIPSObjectCar  Character type. OBIT_AIPSObjectLog  Boolean type.

---

Function Documentation

void ObitAIPSObjectOBclass (  oint  objnum, oint *  classno, AIPSObjClass  name, ObitErr *  err )

Public: Look up the class number/name of object number objnum. Parameters: objnum  object slot number classno  Class number name  name of class of object err  ObitErr for reporting errors.

void ObitAIPSObjectOBcopy (  AIPSObj  namein, AIPSObj  namout, ObitErr *  err )

Public: Copies one image to another. Parameters: namein  Input AIPS object name namout  Output AIPS object name err  ObitErr for reporting errors.

void ObitAIPSObjectOBcrea (  AIPSObj  name, AIPSObjClass  class, ObitErr *  err )

Public: Associate an object slot with an object name. Parameters: name  Name of object to create class  Class name of new object err  ObitErr for reporting errors.

void ObitAIPSObjectOBdskc (  AIPSObj  name, oint *  disk, oint *  cno, ObitErr *  err )

Public: Return Disk and slot information for object. Parameters: name  Name of object to lookup disk  AIPS disk number cno  AIPS catalog slot number err  ObitErr for reporting errors.

void ObitAIPSObjectOBfree (  AIPSObj  name, ObitErr *  err )

Public: Free the object slot associated with an object. Parameters: name  Name of object to free err  ObitErr for reporting errors.

void ObitAIPSObjectOBget (  oint  objnum, AIPSKey  keywrd, ObitAIPSObjectType *  type, AIPSKeyDim  dim, gpointer  value, gchar *  valuec, ObitErr *  err )

Public: Fetch the value (array) for a specified keyword. Parameters: objnum  object slot number keywrd  keyword type  data type OBIT_AIPSObjectInt, OBIT_AIPSObjectRe, OBIT_AIPSObjectDP, OBIT_AIPSObjectCar dim  dimensionality of value (valuec) value  numeric data value (array) valuec  character data array err  ObitErr for reporting errors.

void ObitAIPSObjectOBhget (  AIPSObj  name, union ObitAIPSCatEquiv  cat, ObitErr *  err )

Public: Return catalog header record for an object. Parameters: name  Name of object cat  AIPS catalog header block err  ObitErr for reporting errors.

void ObitAIPSObjectOBhput (  AIPSObj  name, union ObitAIPSCatEquiv  cat, ObitErr *  err )

Public: Store catalog header record for an object. Parameters: name  Name of object cat  AIPS catalog header block err  ObitErr for reporting errors.

gboolean ObitAIPSObjectOBinfo (  oint  objnum, AIPSKey  keywrd, ObitAIPSObjectType *  type, AIPSKeyDim  dim, ObitErr *  err )

Public: Check for for a specified keyword. Parameters: objnum  object slot number keywrd  keyword type  data type OBIT_AIPSObjectInt, OBIT_AIPSObjectRe, OBIT_AIPSObjectDP, OBIT_AIPSObjectCar dim  dimensionality of value (valuec) err  ObitErr for reporting errors. Returns: TRUE if found, else FALSE

void ObitAIPSObjectOBinit (  oint *  ierr  )

Public: Initialize AIPS Object manager. Parameters: ierr  return code, 0=>OK

void ObitAIPSObjectOBkeyv (  oint  objnum, AIPSKey  keywrd, oint *  keypnt, gint *  ierr, ObitErr *  err )

Public: See if keyword is an object dependent, virtual keyword. Parameters: objnum  object slot number keywrd  keyword keypnt  index in tables , set if keywrd found ierr  return code, 0=>found, -1=not found, >0 => error err  Error stack

void ObitAIPSObjectOBname (  AIPSObj  name, oint *  objnum, ObitErr *  err )

Public: Look up the object slot number of object with name "name". Parameters: name  Name of object to lookup objnum  object slot number err  ObitErr for reporting errors.

void ObitAIPSObjectOBput (  oint  objnum, AIPSKey  keywrd, ObitAIPSObjectType  type, AIPSKeyDim  dim, gpointer  value, gchar *  valuec, ObitErr *  err )

Public: Save an entry in an object creating it if necessary. Parameters: objnum  object slot number keywrd  keyword type  data type OBIT_AIPSObjectInt, OBIT_AIPSObjectRe, OBIT_AIPSObjectDP, OBIT_AIPSObjectCar dim  dimensionality of value (valuec) value  numeric data value (array) valuec  character data array err  ObitErr for reporting errors.

void ObitAIPSObjectOBrget (  oint  objnum, AIPSKey  keywrd, ObitAIPSObjectType *  type, AIPSKeyDim  dim, gpointer  value, gchar *  valuec, ObitErr *  err )

Public: Fetch the value (array) for a specified real (non-virtual) keyword. Parameters: objnum  object slot number keywrd  keyword type  data type OBIT_AIPSObjectInt, OBIT_AIPSObjectRe, OBIT_AIPSObjectDP, OBIT_AIPSObjectCar dim  dimensionality of value (valuec) value  numeric data value (array) valuec  character data array err  ObitErr for reporting errors.

void ObitAIPSObjectOBvhkw (  AIPSObjClass  class, AIPSKey  keyword, ObitAIPSObjectType  type, oint *  ierr )

Public: Add a Catalog header keyword to the virtual keyword list. Parameters: class  object class keyword  keyword to add type  data type OBIT_AIPSObjectInt, OBIT_AIPSObjectRe, OBIT_AIPSObjectDP, OBIT_AIPSObjectCar ierr  return code, 0=>OK

---