Previous Next Contents

5.6   Frame Sets






5.6.1   PmCreateFrameSet

Synopsis
PmFrameSet PmCreateFrameSet (int nb_of_frames, int nb_of_paramsets)
Creates a new FrameSet.

nb_of_frames : max number of frames of the FrameSet.

nb_of_paramsets : max number of ParamSets the FrameSet can support.

Returns a new FrameSet, or NULL if there is no available memory.






5.6.2   PmReallocFrameSet

Synopsis
PmFrameSet PmReallocFrameSet (PmFrameSet aFS, int nb_of_frames, int nb_of_paramsets)
Reallocates FrameSet aFS in the two dimensions: frames and sets of parameters.

nb_of_frames : new max number of frames of the FrameSet.

nb_of_paramsets : new max number of ParamSets the FrameSet can support. If a new dimension size (i.e. nb_of_frames or nb_of_paramsets) is smaller than the current dimension size, reallocation of this dimension is ignored.

Returns

If reallocation is successful, returns the same input FrameSet aFS with reallocated number of frames and ParamSets.

If reallocation fails, returns NULL and the size of aFS remains unchanged.

If aFS is NULL, returns a new FrameSet or NULL if reallocation failed.

Reallocation is performed in two stages: first for ParamSets, secondly for Frames. It can eventually fail at the second stage; in this case reallocation of ParamSets remains valid even if the function returns NULL.

Most functions that operate on FrameSets provide for automatic reallocation.






5.6.3   PmFreeFrameSet

Synopsis
void PmFreeFrameSet (PmFrameSet aFS)
Frees FrameSet aFS.






5.6.4   PmCreateParamSet

Synopsis
PmParamSetId PmCreateParamSet (PmFrameSet aFS, int paramset_length, int paramset_type, char *paramset_name)
Allocates memory for a set of paramset_length elements of paramset_type type in each frame of FrameSet aFS.

paramset_type possible values are:

C basic data types:

PM_CHAR, PM_SHORT, PM_INT, PM_LONG, PM_FLOAT, PM_DOUBLE
Pm specific data types:

PM_PARTIAL
Returns an identifier of the new ParamSet, or -1 if there is no available memory to create the new paramset, or if paramset_type is unknown for the library.






5.6.5   PmFreeParamSet

Synopsis
void PmFreeParamSet (PmFrameSet aFS, PmParamSetId aParamSetId)
Frees ParamSet identified by aParamSetId in FrameSet aFS.



Formatted and maintained by Diemo Schwarz --- last change
Previous Next Contents