rave_bufr_io.h File Reference

Adaptor for polar BUFR files. More...

#include "rave_object.h"
#include "polarscan.h"
#include "polarvolume.h"

Go to the source code of this file.

Typedefs
typedef struct _RaveBufrIO_t	RaveBufrIO_t
	Defines the bufr adaptor.

Functions
int	RaveBufrIO_setTableDir (RaveBufrIO_t *self, const char *dirname)
	Sets the table dir name where the descriptor information resides.
const char *	RaveBufrIO_getTableDir (RaveBufrIO_t *self)
	Returns the table dir name.
RaveCoreObject *	RaveBufrIO_read (RaveBufrIO_t *self, const char *filename)
	Reads the bufr file.
int	RaveBufrIO_isBufr (const char *filename)
	Tests if the specified file is a bufr file.

Variables
RaveCoreObjectType	RaveBufrIO_TYPE
	Type definition to use when creating a rave object.

Detailed Description

Adaptor for polar BUFR files.

This object supports RAVE_OBJECT_CLONE.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2011-11-07

Typedef Documentation

RaveBufrIO_t

typedef struct _RaveBufrIO_t RaveBufrIO_t

Defines the bufr adaptor.

Function Documentation

RaveBufrIO_getTableDir()

const char * RaveBufrIO_getTableDir

(

RaveBufrIO_t *

self

)

Returns the table dir name.

Parameters

[in]

self

- self

Returns

the directory name

RaveBufrIO_isBufr()

int RaveBufrIO_isBufr

(

const char *

filename

)

Tests if the specified file is a bufr file.

Parameters

[in]

filename

- the name to check

Returns

1 if file is a BUFR file, otherwise 0

RaveBufrIO_read()

RaveCoreObject * RaveBufrIO_read	(	RaveBufrIO_t *	self,
		const char *	filename )

Reads the bufr file.

Parameters

[in]	self	- self
[in]	filename	- the filename that should be read

Returns

the rave core object on success otherwise NULL

RaveBufrIO_setTableDir()

int RaveBufrIO_setTableDir	(	RaveBufrIO_t *	self,
		const char *	dirname )

Sets the table dir name where the descriptor information resides.

Parameters

[in]	self	- self
[in]	dirname	- the directory name

Returns

1 on success otherwise 0

Variable Documentation

RaveBufrIO_TYPE

RaveCoreObjectType RaveBufrIO_TYPE

extern

Type definition to use when creating a rave object.