Typedefs | |
| typedef _cpl_frameset_ | cpl_frameset |
| The frame set data type. | |
Functions | |
| cpl_frameset * | cpl_frameset_new (void) |
| Create a new, empty frame set. | |
| cpl_frameset * | cpl_frameset_duplicate (const cpl_frameset *other) |
| Create a copy of the given frame set. | |
| void | cpl_frameset_delete (cpl_frameset *self) |
| Destroy a frame set. | |
| int | cpl_frameset_get_size (const cpl_frameset *self) |
| Get the current size of a frame set. | |
| int | cpl_frameset_is_empty (const cpl_frameset *self) |
| Check whether a frame set is empty. | |
| int | cpl_frameset_count_tags (const cpl_frameset *self, const char *tag) |
| Counts the frames stored in a frame set having the given tag. | |
| cpl_frame * | cpl_frameset_find (const cpl_frameset *self, const char *tag) |
| Find a frame with the given tag in a frame set. | |
| cpl_frame * | cpl_frameset_get_first (const cpl_frameset *self) |
| Get the first frame in the given set. | |
| cpl_frame * | cpl_frameset_get_next (const cpl_frameset *self) |
| Get the next frame in the given set. | |
| cpl_error_code | cpl_frameset_insert (cpl_frameset *self, cpl_frame *frame) |
| Insert a frame into the given frame set. | |
| int | cpl_frameset_erase (cpl_frameset *self, const char *tag) |
| Erase all frames with the given tag from a frame set. | |
| cpl_error_code | cpl_frameset_erase_frame (cpl_frameset *self, cpl_frame *frame) |
| Erase the given frame from a frame set. | |
| int * | cpl_frameset_labelise (cpl_frameset *set, int(*compare)(cpl_frame *, cpl_frame *), int *nb_labels) |
| Separate a list of frames into groups, using a comparison function. | |
| cpl_frame * | cpl_frameset_get_frame (const cpl_frameset *set, int position) |
| Get a frame from a frame set. | |
| cpl_frameset * | cpl_frameset_extract (cpl_frameset *set, int *labels, int desired_label) |
| Extract a subset of frames from a set of frames. | |
#include <cpl_frameset.h>
|
|
The frame set data type. This data type is opaque. |
|
||||||||||||
|
Counts the frames stored in a frame set having the given tag.
The function scans the frame set self for frames with the tag tag and returns the number of frames found. |
|
|
Destroy a frame set.
|
|
|
Create a copy of the given frame set.
The function creates a deep copy, i.e. the frame set object and its contents, of the frame set other. The created copy and the original set do not share any resources. |
|
||||||||||||
|
Erase all frames with the given tag from a frame set.
The function searches the frame set self for frames having the tag tag and removes them from the set. The removed frames are destroyed. If no frame with the tag tag is found the function has no effect. |
|
||||||||||||
|
Erase the given frame from a frame set.
The function searches the frame set self for the first occurrance of frame. If it is present, the frame is removed from the set and destroyed. If frame is not present in self the function has no effect. |
|
||||||||||||||||
|
Extract a subset of frames from a set of frames.
The returned object has to be deallocated with cpl_frameset_delete() |
|
||||||||||||
|
Find a frame with the given tag in a frame set.
The function searches the frame set self for the frames with the tag tag. If such a frame is present, a handle for it is returned. If the set contains several frames with the tag tag the first one is returned. The remaining frames with this tag can be accessed sequentially by using |
|
|
Get the first frame in the given set.
The function returns the first frame in the frame set self if it exists. If a first frame does not exist, i.e. the frame set is empty,
|
|
||||||||||||
|
Get a frame from a frame set.
The function returns a handle to the frame at the index position in the set. The frame position ranges from The returned frame is still owned by the frame set set, i.e. the obtained frame must not be deleted through the returned handle and also its tag must not be modified. As an alternative to using this function, the functions cpl_frameset_get_first() and cpl_frameset_get_next() should be considered, if performance is an issue.
|
|
|
Get the next frame in the given set.
The function returns the next frame in the frame set self if it exists and otherwise
|
|
|
Get the current size of a frame set.
The reports the current number of frames stored in the frame set self. |
|
||||||||||||
|
Insert a frame into the given frame set.
The function adds the frame frame to the frame set self using the frame's tag as key. The insertion of a frame into a frameset transfers the ownership of the frame frame to the frameset self. This means that the frame must not be deallocated through the pointer frame. In addition, the frame pointer returned by any member function call returning a handle to a frameset's member frame, must not be used to insert the returned frame into another framset without prior duplication of this frame, and, it must not be used to modify the frames tag without removing it from the frameset first and re-inserting it with the new tag afterwards. |
|
|
Check whether a frame set is empty.
The function checks if self contains any frames. |
|
||||||||||||||||
|
Separate a list of frames into groups, using a comparison function.
This function takes a set of frames and groups the frames that are 'identical' together. The user provided comparison function defines what being identical means for two frames. A label (int) is associated to each group of identical frames, these labels are returned in an array. This compare function takes two frames and returns 1 if they are identical, 0 if they are different, and -1 in error case. The returned object has to be deallocated with cpl_free() |
|
|
Create a new, empty frame set.
|
1.4.6