[All Packages] [This Package] [Previous Class] [Next Class]
Class: NamedNodeMap
This class contains methods for accessing the number of nodes in a node map
and fetching individual nodes.
item
- Function:
- Return nth node in node map
- Prototype:
- Node* item(size_t index)
- Arguments:
- size_t index-- zero-based node number
- Returns:
- Node* -- Pointer to index'th node in map
getLength
- Function:
- Return number of nodes in map
- Prototype:
- size_t getLength()
- Arguments:
- None
- Returns:
- size_t -- Number of nodes in map
getNamedItem
- Function:
- Selects the node with the given name from the map
- Prototype:
- Node* getNamedItem(String name)
- Arguments:
- name -- Name of node to select
- Returns:
- Node* -- Pointer to named node, NULL of none such exists
setNamedItem
- Function:
- Adds a node to the map, replacing any node that already exists with
the same name
- Prototype:
- boolean setNamedItem(Node *node, Node **old)
- Arguments:
- node -- Name of node to add
- old -- Pointer to replaced node, NULL if node is new
- Returns:
- boolean -- Success
removeNamedItem
- Function:
- Removes the node with the given name from the node map
- Prototype:
- Node* removeNamedItem(String name)
- Arguments:
- name -- Name of node to remove
- Returns:
- Node* -- Pointer to removed node, NULL if none such exists
free
- Function:
- Frees the named node map
- Prototype:
- void free()
- Arguments:
- None
- Returns:
- Nothing