hlhdf_node_private.h File Reference

Private functions for working with HL_Node's. More...

Go to the source code of this file.

Functions
void	HLNodePrivate_setData (HL_Node *node, size_t datasize, unsigned char *data)
	Sets data and datasize in the node.
void	HLNodePrivate_setRawdata (HL_Node *node, size_t datasize, unsigned char *data)
	Sets rawdata and rawdatasize in the node.
int	HLNodePrivate_setTypeIdAndDeriveFormat (HL_Node *node, hid_t typid)
	Copies the typid and sets it in the node and also atempts to derive the format name.
void	HLNodePrivate_setHdfID (HL_Node *node, hid_t hdfid)
	Sets the HDF identifier.
hid_t	HLNodePrivate_getHdfID (HL_Node *node)
	Returns the HDF identifier.
const hsize_t *	HLNodePrivate_getDims (HL_Node *node)
	Returns an internal pointer to the dimensions.
hid_t	HLNodePrivate_getTypeId (HL_Node *node)
	Returns the internal type id.

Detailed Description

Private functions for working with HL_Node's.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2009-06-24

Function Documentation

HLNodePrivate_getDims()

const hsize_t * HLNodePrivate_getDims

(

HL_Node *

node

)

Returns an internal pointer to the dimensions.

Parameters

[in]

node

the node

Returns

the internal dimension pointer (Do not free and be careful when using it).

HLNodePrivate_getHdfID()

hid_t HLNodePrivate_getHdfID

(

HL_Node *

node

)

Returns the HDF identifier.

Parameters

[in]

node

the node

Returns

the hdf identifier (Do not close).

HLNodePrivate_getTypeId()

hid_t HLNodePrivate_getTypeId

(

HL_Node *

node

)

Returns the internal type id.

Parameters

[in]

node

the node

Returns

the internal type identifier (Do not close).

HLNodePrivate_setData()

void HLNodePrivate_setData	(	HL_Node *	node,
		size_t	datasize,
		unsigned char *	data )

Sets data and datasize in the node.

When this function has been called, responsibility for the data has been taken over so do not release that memory.

Parameters

[in]	node	the node (MAY NOT BE NULL)
[in]	datasize	the size of the data type as get by H5Tget_size.
[in]	data	the data (responsibility taken over so do not release after call).

HLNodePrivate_setHdfID()

void HLNodePrivate_setHdfID	(	HL_Node *	node,
		hid_t	hdfid )

Sets the HDF identifier.

Parameters

[in]	node	the node
[in]	hdfid	the hdf id. (The responsibility is taken over so do not delete)

HLNodePrivate_setRawdata()

void HLNodePrivate_setRawdata	(	HL_Node *	node,
		size_t	datasize,
		unsigned char *	data )

Sets rawdata and rawdatasize in the node.

When this function has been called, responsibility for the data has been taken over so do not release that memory.

Parameters

[in]	node	the node (MAY NOT BE NULL)
[in]	datasize	the size of the data type as get by H5Tget_size.
[in]	data	the data (responsibility taken over so do not release after call).

HLNodePrivate_setTypeIdAndDeriveFormat()

int HLNodePrivate_setTypeIdAndDeriveFormat	(	HL_Node *	node,
		hid_t	typid )

Copies the typid and sets it in the node and also atempts to derive the format name.

Parameters

[in]	node	the node
[in]	typid	the type identifier

Returns

1 on success, otherwise 0.