Public interface of class 'VarsHandler'. More...
#include <VarsHandler.h>
Related Functions | |
(Note that these are not member functions.) | |
boolean | VarsHandler_can_group (const VarsHandler_ptr self, int from_lev, int size, int chunk) |
Returns true if currently it is possible to create/reuse the given group of levels. | |
VarsHandler_ptr | VarsHandler_create (DDMgr_ptr dd) |
The VarsHandler class constructor. | |
void | VarsHandler_destroy (VarsHandler_ptr self) |
The VarsHandler class destructor. | |
void | VarsHandler_dissolve_group (VarsHandler_ptr self, GroupInfo_ptr bid) |
Releases the given block (previously created with reserve_group). Differently from release_group, this method actually dissolves the group, all its children (contained groups) and all groups containing it (i.e. all parents). | |
DDMgr_ptr | VarsHandler_get_dd_manager (const VarsHandler_ptr self) |
Returns the contained dd manager. | |
void | VarsHandler_print (const VarsHandler_ptr self, FILE *_file) |
Prints the content of the VarsHandler. | |
boolean | VarsHandler_release_group (VarsHandler_ptr self, GroupInfo_ptr bid) |
Releases the group (previously created with reserve_group). | |
GroupInfo_ptr | VarsHandler_reserve_group (VarsHandler_ptr self, int from_lev, int size, int chunk, boolean can_share, int *lev_low) |
Constructs a group, with minimal level from_level, size and chunk size. Returns a structure which has to be used to release the group later. | |
void | VarsHandler_update_levels (VarsHandler_ptr self) |
After a reordering, levels in the dd package may do not correspond to the levels in the vars handler. This method re-align the vars handler wrt the current levels. |
Public interface of class 'VarsHandler'.
Definition of the public accessor for class VarsHandler
boolean VarsHandler_can_group | ( | const VarsHandler_ptr | self, | |
int | from_lev, | |||
int | size, | |||
int | chunk | |||
) | [related] |
Returns true if currently it is possible to create/reuse the given group of levels.
This method can be used to check if a group can be created at given level.
VarsHandler_ptr VarsHandler_create | ( | DDMgr_ptr | dd | ) | [related] |
The VarsHandler class constructor.
AutomaticStart
The VarsHandler class constructor
void VarsHandler_destroy | ( | VarsHandler_ptr | self | ) | [related] |
void VarsHandler_dissolve_group | ( | VarsHandler_ptr | self, | |
GroupInfo_ptr | bid | |||
) | [related] |
Releases the given block (previously created with reserve_group). Differently from release_group, this method actually dissolves the group, all its children (contained groups) and all groups containing it (i.e. all parents).
After this method has been called, gid cannot be used anymore. Also, all other GroupInfo instances possibly pointing to any of the removed groups will be invalidated, so later removals will be handled correctly.
DDMgr_ptr VarsHandler_get_dd_manager | ( | const VarsHandler_ptr | self | ) | [related] |
Returns the contained dd manager.
void VarsHandler_print | ( | const VarsHandler_ptr | self, | |
FILE * | _file | |||
) | [related] |
Prints the content of the VarsHandler.
This is used for debugging/verosity purposes
boolean VarsHandler_release_group | ( | VarsHandler_ptr | self, | |
GroupInfo_ptr | bid | |||
) | [related] |
Releases the group (previously created with reserve_group).
The group is not necessarily released, at it (or part of it) may be shared with other created groups. After this method has been called, gid cannot be used anymore. Returns true iff the group is actually removed.
GroupInfo_ptr VarsHandler_reserve_group | ( | VarsHandler_ptr | self, | |
int | from_lev, | |||
int | size, | |||
int | chunk, | |||
boolean | can_share, | |||
int * | lev_low | |||
) | [related] |
Constructs a group, with minimal level from_level, size and chunk size. Returns a structure which has to be used to release the group later.
The reservation does not necessarily create a group at given level, but may allocate it at a greater level (this is why the parameter is called from_level). Returns the group ID, and the actual minimal level allocated. When done with it, the caller has to release the returned groupinfo with VarsHandler_release_group or VarsHandler_dissolve_group
void VarsHandler_update_levels | ( | VarsHandler_ptr | self | ) | [related] |
After a reordering, levels in the dd package may do not correspond to the levels in the vars handler. This method re-align the vars handler wrt the current levels.
Realigns the whole internal groups structure, and all currently existing GroupInfo instances.