bufrex_codec.h File Reference

---

Detailed Description

High level encoding and decoding functions.

#include <dballe/core/rawmsg.h>
#include <dballe/msg/msgs.h>
#include <dballe/bufrex/msg.h>

Go to the source code of this file.

Functions
dba_err	bufrex_decode_bufr (dba_rawmsg raw, dba_msgs *msgs)
	Decode a BUFR message into a dba_msg.
dba_err	bufrex_decode_crex (dba_rawmsg raw, dba_msgs *msgs)
	Decode a CREX message into a dba_msg.
dba_err	bufrex_encode_bufr (dba_msgs msgs, int type, int subtype, dba_rawmsg *raw)
	Encode a dba_msg into a BUFR message.
dba_err	bufrex_encode_crex (dba_msgs msgs, int type, int subtype, dba_rawmsg *raw)
	Encode a dba_msg into a CREX message.
dba_err	bufrex_msg_from_dba_msg (bufrex_msg raw, dba_msg msg)
	Fill in the bufrex_msg with the contents of a dba_msg.
dba_err	bufrex_msg_from_dba_msgs (bufrex_msg raw, dba_msgs msgs)
	Fill in the bufrex_msg with the contents of a dba_msgs.
dba_err	bufrex_msg_to_dba_msgs (bufrex_msg raw, dba_msgs *msgs)
	Fill in a dba_msgs with the contents of the bufrex_msg.
dba_err	bufrex_infer_type_subtype (dba_msg msg, int *type, int *subtype)
	Infer good type and subtype from a dba_msg.

---

Function Documentation

dba_err bufrex_decode_bufr	(	dba_rawmsg	raw,
		dba_msgs *	msgs
	)

Decode a BUFR message into a dba_msg.

Parameters:

raw

The message to decode

Return values:

msgs

The decoded message

Returns:

The error status (See error.h)

dba_err bufrex_decode_crex	(	dba_rawmsg	raw,
		dba_msgs *	msgs
	)

Decode a CREX message into a dba_msg.

Parameters:

raw

The message to decode

Return values:

msgs

The decoded message

Returns:

The error status (See error.h)

dba_err bufrex_encode_bufr	(	dba_msgs	msgs,
		int	type,
		int	subtype,
		dba_rawmsg *	raw
	)

Encode a dba_msg into a BUFR message.

Parameters:

	msgs	The message to encode
	type	The type of the encoded message. Use 0 to let the encoder make a good choice.
	subtype	The subtype of the encoded message. Use 0 to let the encoder make a good choice.

Return values:

raw

The raw encoded message

Returns:

The error status (See error.h)

dba_err bufrex_encode_crex	(	dba_msgs	msgs,
		int	type,
		int	subtype,
		dba_rawmsg *	raw
	)

Encode a dba_msg into a CREX message.

Parameters:

	msgs	The message to encode
	type	The type of the encoded message. Use 0 to let the encoder make a good choice.
	subtype	The subtype of the encoded message. Use 0 to let the encoder make a good choice.

Return values:

raw

The raw encoded message

Returns:

The error status (See error.h)

dba_err bufrex_infer_type_subtype	(	dba_msg	msg,
		int *	type,
		int *	subtype
	)

Infer good type and subtype from a dba_msg.

Parameters:

msg

The message for which to infer the encoding template

Return values:

	type	The type of the encoding template to use
	subtype	The subtype of the encoding template to use

Returns:

The error indicator for the function (See error.h)

dba_err bufrex_msg_from_dba_msg	(	bufrex_msg	raw,
		dba_msg	msg
	)

Fill in the bufrex_msg with the contents of a dba_msg.

Parameters:

	raw	The bufrex message that will be filled with the data from msg
	msg	The dba_msg to take the data from

Returns:

The error indicator for the function (See error.h)

dba_err bufrex_msg_from_dba_msgs	(	bufrex_msg	raw,
		dba_msgs	msgs
	)

Fill in the bufrex_msg with the contents of a dba_msgs.

Parameters:

	raw	The bufrex message that will be filled with the data from msg
	msgs	The dba_msgs to take the data from

Returns:

The error indicator for the function (See error.h)

dba_err bufrex_msg_to_dba_msgs	(	bufrex_msg	raw,
		dba_msgs *	msgs
	)

Fill in a dba_msgs with the contents of the bufrex_msg.

Parameters:

raw

The bufrex message with the data to interpret

Return values:

msgs

The dba_msgs with the interpreted data

Returns:

The error indicator for the function (See error.h)

---