cta_metainfo.h File Reference

#include "cta_system.h"
#include "cta_handles.h"
#include "cta_datatypes.h"
#include "cta_functions.h"
#include "cta_string.h"
#include "cta_vector.h"
#include "cta_matrix.h"
#include "cta_sobs.h"

Go to the source code of this file.

Data Structures
struct	CTAI_Gridm
Defines
#define	CTA_METAINFO_CREATE_SIZE ( 1)
#define	CTA_METAINFO_CREATE_INIT ( 2)
#define	I_CTA_METAINFO_FREE ( 3)
#define	I_CTA_METAINFO_GET_REST ( 4)
#define	I_CTA_METAINFO_GET_KEYS ( 5)
#define	I_CTA_METAINFO_COUNT_OBSERVATIONS ( 6)
#define	I_CTA_METAINFO_COUNT_PROPERTIES ( 7)
#define	I_CTA_METAINFO_EXPORT ( 8)
#define	CTA_METAINFO_NUMFUNC ( 9)
Typedefs
typedef CTA_Handle	CTA_Grid
typedef CTA_Handle	CTA_Metainfo
typedef CTA_Handle	CTA_MetainfoClass
Functions
CTAEXPORT int	CTA_Metainfo_DefineClass (const char name, const CTA_Func h_func[CTA_METAINFO_NUMFUNC], CTA_MetainfoClass hobsdscrcl)
	Create a new class (=implementation) of a COSTA observation description component.
CTAEXPORT int	CTA_Metainfo_Create (CTA_Metainfo *hobsdscr)
	Create a new observation description instance.
CTAEXPORT int	CTA_Metainfo_SetUnit (CTA_Metainfo hobsdscr, char *Key)
	Check whether given stochastic observer corresponds to this observation description.
CTAEXPORT int	CTA_Metainfo_GetDescription (CTA_Metainfo hobsdescr, char **description)
	Get all keys names.
CTAEXPORT int	CTA_Metainfo_IsEqual (CTA_Metainfo hmeta_x, CTA_Metainfo hmeta_y)
CTAEXPORT int	CTAI_Grid_IsEqual (CTAI_Gridm hgrid1, CTAI_Gridm hgrid2)
CTAEXPORT int	CTA_Metainfo_Import (CTA_Metainfo minfo, CTA_Handle usrdata)
CTAEXPORT int	CTA_Metainfo_SetTag (CTA_Metainfo hobsdescr, char *tagname)
CTAEXPORT int	CTA_Metainfo_Free (CTA_Metainfo *hobsdscr)
CTAEXPORT int	CTA_Metainfo_SetDescription (CTA_Metainfo hobsdescr, char *description)
CTAEXPORT int	CTA_Metainfo_SetRest (CTA_Metainfo hobsdescr, int *rest)
CTAEXPORT int	CTA_Metainfo_SetGrid (CTA_Metainfo hobsdescr, CTAI_Gridm *hgrid)
CTAEXPORT int	CTA_Metainfo_GetGrid (CTA_Metainfo hobsdescr, CTAI_Gridm *hgrid)
CTAEXPORT int	CTA_Metainfo_Copy (CTA_Metainfo hmeta_x, CTA_Metainfo hmeta_y)
CTAEXPORT int	CTA_Metainfo_GetRest (CTA_Metainfo hobsdescr, int *rest)
CTAEXPORT int	CTA_Metainfo_GetTag (CTA_Metainfo hobsdescr, char *tagname)
CTAEXPORT int	CTA_Metainfo_SetBelongsTo (CTA_Metainfo hobsdescr, char *tagname)
CTAEXPORT int	CTA_Metainfo_GetBelongsTo (CTA_Metainfo hobsdescr, char *tagname)
CTAEXPORT int	CTAI_Grid_Interpolate (CTAI_Gridm gridy, CTAI_Gridm gridx, CTA_Vector vecx, CTA_Vector vecx_to_y)
CTAEXPORT int	CTA_Metainfo_Export (CTA_Metainfo minfo, CTA_Handle usrdata)
CTAEXPORT int	CTA_Metainfo_GetUnit (CTA_Metainfo hobsdescr, char *nameofunit)
CTAEXPORT int	CTAI_XML_CreateGrid (xmlNode cur_node, CTAI_Gridm thisgrid)
CTAEXPORT int	CTA_Metainfo_setRegGrid (CTA_Metainfo hdescr, char *name, int nx, int ny, int nz, double x_origin, double y_origin, double z_origin, double dx, double dy, double dz)
int	CTA_Metainfo_getRegGrid (CTA_Metainfo hdescr, char name, int nx, int ny, int nz, double x_origin, double y_origin, double z_origin, double dx, double dy, double dz)

Define Documentation

#define CTA_METAINFO_CREATE_INIT ( 2)

Definition at line 46 of file cta_metainfo.h.

#define CTA_METAINFO_CREATE_SIZE ( 1)

Definition at line 45 of file cta_metainfo.h.

#define CTA_METAINFO_NUMFUNC ( 9)

Definition at line 53 of file cta_metainfo.h.

#define I_CTA_METAINFO_COUNT_OBSERVATIONS ( 6)

Definition at line 50 of file cta_metainfo.h.

#define I_CTA_METAINFO_COUNT_PROPERTIES ( 7)

Definition at line 51 of file cta_metainfo.h.

#define I_CTA_METAINFO_EXPORT ( 8)

Definition at line 52 of file cta_metainfo.h.

#define I_CTA_METAINFO_FREE ( 3)

Definition at line 47 of file cta_metainfo.h.

#define I_CTA_METAINFO_GET_KEYS ( 5)

Definition at line 49 of file cta_metainfo.h.

#define I_CTA_METAINFO_GET_REST ( 4)

Definition at line 48 of file cta_metainfo.h.

Typedef Documentation

typedef CTA_Handle CTA_Grid

Definition at line 38 of file cta_metainfo.h.

typedef CTA_Handle CTA_Metainfo

Definition at line 39 of file cta_metainfo.h.

typedef CTA_Handle CTA_MetainfoClass

Definition at line 40 of file cta_metainfo.h.

Function Documentation

CTAEXPORT int CTA_Metainfo_Copy	(	CTA_Metainfo	hmeta_x,
		CTA_Metainfo	hmeta_y
	)

CTAEXPORT int CTA_Metainfo_Create ( CTA_Metainfo * hobsdscr )

Create a new observation description instance.

Parameters:

	hsobscl	I class of new observation description
	usrdat	IO data of the stochastic observer for which a descriptor is to be created
	hobsdscr	O receives handle of created observation description object

Returns:: error status: CTA_OK if successful

CTAEXPORT int CTA_Metainfo_DefineClass	(	const char *	name,
		const CTA_Func	h_func[CTA_METAINFO_NUMFUNC],
		CTA_MetainfoClass *	hobsdscrcl
	)

Create a new class (=implementation) of a COSTA observation description component.

Parameters:

	name	I name of the new observation description class
	h_func	I COSTA function handles for functions that implement class, missing functions must have value CTA_NULL
	hobsdscrcl	O receives handle of new observation description class

Returns:: error status: CTA_OK if successful

CTAEXPORT int CTA_Metainfo_Export	(	CTA_Metainfo	minfo,
		CTA_Handle	usrdata
	)

CTAEXPORT int CTA_Metainfo_Free ( CTA_Metainfo * hobsdscr )

CTAEXPORT int CTA_Metainfo_GetBelongsTo	(	CTA_Metainfo	hobsdescr,
		char *	tagname
	)

CTAEXPORT int CTA_Metainfo_GetDescription	(	CTA_Metainfo	hobsdescr,
		char **	description
	)

Get all keys names.

Parameters:

	hobsdscr	I handle of observation description
	Keys	O receives all keys (COSTA-string vector); must exist before calling and be large enough

Returns:: error status: CTA_OK if successful set tag of metainfo

CTAEXPORT int CTA_Metainfo_GetGrid	(	CTA_Metainfo	hobsdescr,
		CTAI_Gridm *	hgrid
	)

int CTA_Metainfo_getRegGrid	(	CTA_Metainfo	hdescr,
		char *	name,
		int *	nx,
		int *	ny,
		int *	nz,
		double *	x_origin,
		double *	y_origin,
		double *	z_origin,
		double *	dx,
		double *	dy,
		double *	dz
	)

CTAEXPORT int CTA_Metainfo_GetRest	(	CTA_Metainfo	hobsdescr,
		int *	rest
	)

CTAEXPORT int CTA_Metainfo_GetTag	(	CTA_Metainfo	hobsdescr,
		char *	tagname
	)

CTAEXPORT int CTA_Metainfo_GetUnit	(	CTA_Metainfo	hobsdescr,
		char *	nameofunit
	)

CTAEXPORT int CTA_Metainfo_Import	(	CTA_Metainfo	minfo,
		CTA_Handle	usrdata
	)

CTAEXPORT int CTA_Metainfo_IsEqual	(	CTA_Metainfo	hmeta_x,
		CTA_Metainfo	hmeta_y
	)

CTAEXPORT int CTA_Metainfo_SetBelongsTo	(	CTA_Metainfo	hobsdescr,
		char *	tagname
	)

CTAEXPORT int CTA_Metainfo_SetDescription	(	CTA_Metainfo	hobsdescr,
		char *	description
	)

CTAEXPORT int CTA_Metainfo_SetGrid	(	CTA_Metainfo	hobsdescr,
		CTAI_Gridm *	hgrid
	)

CTAEXPORT int CTA_Metainfo_setRegGrid	(	CTA_Metainfo	hdescr,
		char *	name,
		int	nx,
		int	ny,
		int	nz,
		double	x_origin,
		double	y_origin,
		double	z_origin,
		double	dx,
		double	dy,
		double	dz
	)

CTAEXPORT int CTA_Metainfo_SetRest	(	CTA_Metainfo	hobsdescr,
		int *	rest
	)

CTAEXPORT int CTA_Metainfo_SetTag	(	CTA_Metainfo	hobsdescr,
		char *	tagname
	)

CTAEXPORT int CTA_Metainfo_SetUnit	(	CTA_Metainfo	hobsdscr,
		char *	Key
	)

Check whether given stochastic observer corresponds to this observation description.

Parameters:

	hobsdscr	I handle of observation description
	hsobs	I handle of stochastic observer

Returns:: error status: CTA_OK if successful Get properties/values that correspond to a given key.

Parameters:

	hobsdscr	I handle of observation description
	Key	I key for which the value is asked
	Properties	IO COSTA-vector that is to receive the values
	datatype	I data type of elements in properties vector, must be the same as of queried properties

Returns:: error status: CTA_OK if successful

CTAEXPORT int CTAI_Grid_Interpolate	(	CTAI_Gridm	gridy,
		CTAI_Gridm	gridx,
		CTA_Vector	vecx,
		CTA_Vector	vecx_to_y
	)

CTAEXPORT int CTAI_Grid_IsEqual	(	CTAI_Gridm *	hgrid1,
		CTAI_Gridm *	hgrid2
	)

CTAEXPORT int CTAI_XML_CreateGrid	(	xmlNode *	cur_node,
		CTAI_Gridm *	thisgrid
	)

cta_metainfo.h File Reference

Data Structures

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation

Function Documentation