iufCompoundFile.h File Reference

#include "iufData.h"
#include "iufOffset.h"

Go to the source code of this file.

Macros
#define	IUCF_INVALID   (iucf_t) NULL
#define	IUF_DEFAULT_NUM_FRAMES   1

Typedefs
typedef IufCompoundFile *	iucf_t

Functions
iucf_t	iufCompoundFileCreate (const char *filename)
	Create an empty file instance with a filename. More...
int	iufCompoundFileDelete (iucf_t inputFile)
	Creates a datablock for a single channel (i.e. numSamplesPerLine floats) for the acquisition with the name label. More...
iucf_t	iufCompoundFileNodeLoad (const char *pFilename)
	Load an inputFile instance from a file. More...
int	iufCompoundFileNodeSave (iucf_t inputFile)
	Save (serialize) the inputFile instance to file. More...
int	iufCompoundFileClose (iucf_t inputFile)
	Closes access to the inputFile. More...
int	iufCompoundFileCompare (iucf_t reference, iucf_t actual)
	Compares two inputFile instances with each other. More...

Macro Definition Documentation

IUCF_INVALID

#define IUCF_INVALID   (iucf_t) NULL

IUF_DEFAULT_NUM_FRAMES

#define IUF_DEFAULT_NUM_FRAMES   1

Typedef Documentation

iucf_t

typedef IufCompoundFile* iucf_t

Function Documentation

iufCompoundFileClose()

int iufCompoundFileClose

(

iucf_t

inputFile

)

Closes access to the inputFile.

Returns

Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error

Parameters

inputFile

The IufCompoundFile of interest

iufCompoundFileCompare()

int iufCompoundFileCompare	(	iucf_t	reference,
		iucf_t	actual
	)

Compares two inputFile instances with each other.

Returns

Returns IUF_TRUE when the inputFiles are equal and IUF_FALSE otherwise.

Parameters

reference	The IufCompoundFile to compare to
actual	The IufCompoundFile to compare with

iufCompoundFileCreate()

iucf_t iufCompoundFileCreate

(

const char *

filename

)

Create an empty file instance with a filename.

Returns

Returns the empty file instance when succesful or IUCF_INVALID in case of an error.

Parameters

filename

The filename for the file instance.

iufCompoundFileDelete()

int iufCompoundFileDelete

(

iucf_t

inputFile

)

Creates a datablock for a single channel (i.e. numSamplesPerLine floats) for the acquisition with the name label.

Returns

Returns an allocated memory block of a "label"-channel or IUD_INVALID in case of an error.

Parameters

inputFile

The IufCompoundFile of interest

iufCompoundFileNodeLoad()

iucf_t iufCompoundFileNodeLoad

(

const char *

pFilename

)

Load an inputFile instance from a file.

Returns

Returns an input file instance or IUIF_INVALID the file could not be read.

Parameters

pFilename

The filename of the inputFile

iufCompoundFileNodeSave()

int iufCompoundFileNodeSave

(

iucf_t

inputFile

)

Save (serialize) the inputFile instance to file.

Returns

Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error

Parameters

inputFile

The IufCompoundFile of interest