osa_micro_checkpoint osa_node_tree_admin
API Reference Manual  /  7 Simulator-to-Simulator Interfaces  / 

osa_node_path

Description

matching_nodes function returns a list of all nodes rooted at root_id that matches the given node_path_pattern. The node_path_pattern should be either an integer representing a node id or a string, see Analyzer User's Guide for more details.

Upon success, the return value is a list where the first entry is true and the second entry is a list containing all the matching node ids.

Upon failure, the return value is a list where the first entry is false and the second entry is a string describing the error.

node_path function translates a node id into a fully qualified node path string. See Analyzer User's Guide for more details.

Upon success, the return value is a list where the first entry is true and the second entry is the node path string.

Upon failure, the return value is a list where the first entry is false and the second entry is a string describing the error.

SIM_INTERFACE(osa_node_path) {
        attr_value_t (*matching_nodes)(conf_object_t *NOTNULL obj,
                                       node_id_t root_id,
                                       attr_value_t node_path_pattern);
        attr_value_t (*node_path)(conf_object_t *NOTNULL obj,
                                  node_id_t node_id);
};

#define OSA_NODE_PATH_INTERFACE "osa_node_path"

Execution Context
Global Context for all methods.

osa_micro_checkpoint osa_node_tree_admin