ContainerID Class Reference

Inheritance diagram for ContainerID:

Detailed Description

Represents "path" from root container to specific nested object inside config hierarchy. Each ContainerIdPathEntry item represent one level of hierarchy, and it has:

• PropertyName: name of Object or Object array property
• Index: if the property defined by PropertyName is an array, index is used, otherwise leave it -1 (the default)

Let's have the following config:

Shape { // <- top level container
    Points { // <- array of points
        ShapePoint { // <- first element
            Position 2 3 1
            Metadata {
                Name name1
            }
        }
        ShapePoint { // <- second element
            Position 0 1 1
            Metadata { // <- for example: path to this object is: Points[1]/Metadata
                Name name2
            }
        }
    }
}

Setup ContainerID pointing to second ShapePoint Metadata:

BaseContainer rootContainer; // the root container point to "Shape"
 
ContainerID containerPath = {
    new ContainerIdPathEntry("Points", 1), // second item in "Points" object array
    new ContainerIdPathEntry("Metadata") // "Metadata" nested object of the second point
};

Definition at line 48 of file ContainerID.c.

---

The documentation for this class was generated from the following file:

• scripts/Core/generated/WorkbenchAPI/ContainerID.c