Stack Low Level Access
[Stack Access]


Functions

int hps_pick (int level, hpobj_t *obj)
 Picks a RPL object from the stack and stores it into a C hpobj_t object.
int hps_pick_type (int level, int type, void *data)
 Picks a RPL object of a given type from the stack and stores it into a C hpobj_t object.
int hps_pop (hpobj_t *obj)
 Pops a RPL object from the stack and stores it into a C hpobj_t object.
int hps_pop_type (int type, void *data)
 Pops a RPL object of a given type from the stack and stores it into a C hpobj_t object.
int hps_push (hpobj_t *obj)
 Pushes an object passed as parameter onto the stack.
int hps_push_type (int type, void *data)
 Pushes an object which type and data area passed as parameter onto the stack.

Function Documentation

int hps_pick int  level,
hpobj_t obj
 

Picks a RPL object from the stack and stores it into a C hpobj_t object.

This function reads a RPL object at the given level of the stack, and stores it into a pre-allocated hpobj_t object.

Parameters:
level The stack level from which pick the object
obj Pointer to the target C hpobj_t object
Returns:
HPS_ERROR_STACK if the stack is too small, HPS_ERROR_NOT_IMPLEMENTED if the object type is not addressed by HPStack, HPS_OK otherwise

int hps_pick_type int  level,
int  type,
void *  data
 

Picks a RPL object of a given type from the stack and stores it into a C hpobj_t object.

This function reads a RPL object at the given level of the stack, checks its type against the type passed as a parameter, and stores it into a pre-allocated hpobj_t object.

Parameters:
level The stack level from which pick the object
type The type used as a filter
data Pointer to the data of C hpobj_t object
Returns:
HPS_ERROR_STACK if the stack is too small, HPS_ERROR_TYPE if the type ogf the object at this level does not match the parameter, HPS_ERROR_NOT_IMPLEMENTED if the object type is not addressed by HPStack, HPS_OK otherwise

int hps_pop hpobj_t obj  ) 
 

Pops a RPL object from the stack and stores it into a C hpobj_t object.

This function reads the RPL object located at the top of the stack, stores it into a pre-allocated hpobj_t object, and then drops the top of the stack.

Parameters:
obj Pointer to the target C hpobj_t object
Returns:
HPS_ERROR_STACK if the stack is too small, HPS_ERROR_NOT_IMPLEMENTED if the object type is not addressed by HPStack, HPS_OK otherwise

int hps_pop_type int  type,
void *  data
 

Pops a RPL object of a given type from the stack and stores it into a C hpobj_t object.

This function reads the RPL object located at the top of the stack, checks its type against the type passed as a parameter, stores it into a pre-allocated hpobj_t object, and then drops the top level of the stack.

Parameters:
type The type used as a filter
data Pointer to the data of C hpobj_t object
Returns:
HPS_ERROR_STACK if the stack is too small, HPS_ERROR_TYPE if the type ogf the object at this level does not match the parameter, HPS_ERROR_NOT_IMPLEMENTED if the object type is not addressed by HPStack, HPS_OK otherwise

int hps_push hpobj_t obj  ) 
 

Pushes an object passed as parameter onto the stack.

This function pushes a RPL object, built from a C hpobj_t object, onto the stack.

Parameters:
obj The pointer to the object to push onto the stack
Returns:
HPS_ERROR_PAR if the pointer parameter is NULL, HPS_ERROR_SAT_MEMORY if not enough room to allocate the RPL object, HPS_ERROR_NOT_IMPLEMENTED if the object type is not addressed by HPStack, HPS_OK otherwise

int hps_push_type int  type,
void *  data
 

Pushes an object which type and data area passed as parameter onto the stack.

This function pushes a RPL object, built from type and data passed as parameter, onto the stack.

Parameters:
type The type of the object to push onto the stack
data The data of the object
Returns:
HPS_ERROR_SAT_MEMORY if not enough room to allocate the RPL object, HPS_ERROR_NOT_IMPLEMENTED if the object type is not addressed by HPStack, HPS_OK otherwise


Generated on Sat Sep 16 18:23:57 2006 for HPStack by  doxygen 1.4.5