cta_method.h File Reference

The interface description of the COSTA method component (this component is still under construction). For user implementation see cta_usr_method.h. More...

#include "cta_system.h"
#include "cta_errors.h"
#include "cta_handles.h"
#include "cta_datatypes.h"
#include "cta_functions.h"

Go to the source code of this file.

Defines
#define	CTA_METH_CREATE_SIZE   ( 1)
#define	CTA_METH_CREATE_INIT   ( 2)
#define	CTA_METH_RUN   ( 3)
#define	CTA_METH_FREE   ( 4)
#define	CTA_METH_NUMFUNC   ( 5)
Typedefs
typedef CTA_Handle	CTA_Method
typedef CTA_Handle	CTA_MethClass
Functions
CTAEXPORT int	CTA_Meth_DefineClass (const char *name, const CTA_Func h_func[CTA_METH_NUMFUNC], CTA_MethClass *hmethcl)
	Create a new class (=implementation) of a COSTA method.
CTAEXPORT int	CTA_Meth_Create (CTA_Method hmethcl, CTA_Handle userdata, CTA_Method *hmeth)
	Create an instance of a method.
CTAEXPORT int	CTA_Meth_Run (CTA_Method hmeth)
	Run method.
CTAEXPORT int	CTA_Meth_Free (CTA_Method *hmeth)
	Free the method object.

---

Detailed Description

The interface description of the COSTA method component (this component is still under construction). For user implementation see cta_usr_method.h.

The COSTA method component is provided for calling data assimilation and calibration methods in a uniform way.

Definition in file cta_method.h.

---

Define Documentation

#define CTA_METH_CREATE_INIT   ( 2)

Definition at line 41 of file cta_method.h.

#define CTA_METH_CREATE_SIZE   ( 1)

Definition at line 40 of file cta_method.h.

#define CTA_METH_FREE   ( 4)

Definition at line 43 of file cta_method.h.

#define CTA_METH_NUMFUNC   ( 5)

Definition at line 44 of file cta_method.h.

#define CTA_METH_RUN   ( 3)

Definition at line 42 of file cta_method.h.

---

Typedef Documentation

typedef CTA_Handle CTA_MethClass

Definition at line 37 of file cta_method.h.

typedef CTA_Handle CTA_Method

Definition at line 36 of file cta_method.h.

---

Function Documentation

CTAEXPORT int CTA_Meth_Create	(	CTA_Method	hmethcl,
		CTA_Handle	userdata,
		CTA_Method *	hmeth
	)

Create an instance of a method.

Parameters:

	hmethcl	I method class of new object
	userdata	IO user data for creation (depends on class)
	hmeth	O receives handle of new method

Returns:

error status: CTA_OK if successful

CTAEXPORT int CTA_Meth_DefineClass	(	const char *	name,
		const CTA_Func	h_func[CTA_METH_NUMFUNC],
		CTA_MethClass *	hmethcl
	)

Create a new class (=implementation) of a COSTA method.

Parameters:

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

Returns:

error status: CTA_OK if successful

CTAEXPORT int CTA_Meth_Free

(

CTA_Method *

hmeth

)

Free the method object.

hmeth=CTA_NULL is allowed

Parameters:

hmeth

IO handle of method, replaced by CTA_NULL on return.

Returns:

error status: CTA_OK if successful

CTAEXPORT int CTA_Meth_Run

(

CTA_Method

hmeth

)

Run method.

Parameters:

hmeth

I handle of method

Returns:

error status: CTA_OK if successful