axiom_navigator_ops Struct Reference
[navigator]

node ops struct Encapsulator struct for ops of axiom_node More...

#include <axiom_navigator.h>

List of all members.

Public Attributes

axis2_status_t(* free )(axiom_navigator_t *om_navigator, const axis2_env_t *env)
axis2_bool_t(* is_navigable )(axiom_navigator_t *om_navigator, const axis2_env_t *env)
axis2_bool_t(* is_completed )(axiom_navigator_t *om_navigator, const axis2_env_t *env)
axiom_node_t *(* next )(axiom_navigator_t *om_navigator, const axis2_env_t *env)
axis2_bool_t(* visited )(axiom_navigator_t *om_navigator, const axis2_env_t *env)


Detailed Description

node ops struct Encapsulator struct for ops of axiom_node


Member Data Documentation

axis2_status_t( * axiom_navigator_ops::free)(axiom_navigator_t *om_navigator, const axis2_env_t *env)

free function , free the axiom_navigator struct

Parameters:
om_navigator axiom_navigator_struct
env environment MUST not be NULL
Returns:
AXIS2_SUCCESS

axis2_bool_t( * axiom_navigator_ops::is_completed)(axiom_navigator_t *om_navigator, const axis2_env_t *env)

returns the build status of this node if the node is completly build returns AXIS2_TRUE otherwise AXIS2_FALSE

Parameters:
om_navigator axiom_navigator struct
env environment MUST not be NULL
Returns:
AXIS2_TRUE if this node is completly built otherwise return AXIS2_FALSE

axis2_bool_t( * axiom_navigator_ops::is_navigable)(axiom_navigator_t *om_navigator, const axis2_env_t *env)

returns the navigable status

Parameters:
om_navigator axiom_navigator_struct
env environment MUST not be NULL
Returns:
AXIS2_TRUE if the om is navigable otherwise returns AXIS2_FALSE

axiom_node_t*( * axiom_navigator_ops::next)(axiom_navigator_t *om_navigator, const axis2_env_t *env)

gets the next node

Parameters:
om_navigator om_navigaot struct
env environment MUST not be NULL
Returns:
axiom_node_t pointer in the sequence of preorder travasal however the an element node is treated slightly differently Once the om_element type om node is passed it returns the same om_node pointer in the next , returns NULL on error or if there is no more nodes

axis2_bool_t( * axiom_navigator_ops::visited)(axiom_navigator_t *om_navigator, const axis2_env_t *env)

method visited

Parameters:
om_navigator om_navigaot struct
env environment MUST not be NULL
Returns:
AXIS2_TRUE if this node is alrady visited otherwise AXIS2_FALSE


The documentation for this struct was generated from the following file:
Generated on Thu Oct 26 21:11:45 2006 for Axis2/C by  doxygen 1.4.7