E57 Foundation API v1.1.312  Aug. 10, 2011
ustring elementName ( ) const

Get elementName string, that identifies the node in its parent.

The elementName is a string associated with each parent-child link between nodes. For a given parent, the elementName uniquely identifies each of its children. Thus, any node in a tree can be identified by a sequence of elementNames that form a path from the tree's root node (see Node::pathName for more details).

Three types of nodes (the container node types) can be parents: StructureNode, VectorNode, and CompressedVectorNode. The children of a StructureNode are explicitly given unique elementNames when they are attached to the parent (using StructureNode::set). The children of VectorNode and CompressedVectorNode are implicitly given elementNames based on their position in the list (starting at "0"). In a CompressedVectorNode, the elementName can become quite large: "1000000000" or more. However in a CompressedVectorNode, the elementName string is not stored in the file and is deduced by the position of the child.

Precondition:
The destination ImageFile must be open (i.e. destImageFile().isOpen()).
Postcondition:
No visible state is modified.
Returns:
The element name of the node, or "" if a root node.
Exceptions:
E57_ERROR_IMAGEFILE_NOT_OPEN
E57_ERROR_INTERNALAll objects in undocumented state
See also:
NodeFunctions.cpp example, Node::pathName, Node::parent, Node::isRoot
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines