SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Types
SE_Packed_Hierarchy
/*
 * STRUCT: SE_Packed_Hierarchy
 *
 *   The primary data structure returned from SE_GetPackedHierarchy() or
 *   SE_GetRemainingPackedHierarchiesList(). This structure represents the
 *   entry point in the the packed hierarchy.
 */
typedef struct
{

SE_Packed_Hierarchy_Object_Access hierarchy_root_object;1
SE_Integer_Unsigned object_count;2
SE_Packed_Hierarchy_Object *object_list;3
SE_Integer_Unsigned reference_list_length;4
SE_Packed_Hierarchy_Reference *reference_list;5
} SE_Packed_Hierarchy;


Field Notes

hierarchy_root_object

A pointer to a structure representing the root object of the packed hierarchy. This root object will be the object that was passed in as the root of the call to SE_GetPackedHierarchy().

object_count

The number of entries in object_list, including the entry for the root object of the packed hierarchy.

object_list

An array of SE_Packed_Hierarchy_Objects, representing the objects of the packed hierarchy. This list is provided as an alternative access method (as opposed to walking the hierarchy tree). The hierarchy_root_object is included in this list. All references included in reference_list will contain pointers into this list of objects.

reference_list_length

The number of entries in reference_list.

reference_list

An array of SE_Packed_Hierarchy_References, specifically, the references within this SE_Packed_Hierarchy. This list is provided as an alternate access point to the references. However, the primary access will be through the components and aggregates within the SE_Packed_Hierarchy_Object structure. These "arrays" of references will be contiguous sections of this reference_list. All references in the components and aggregates must resolve to SE_Packed_Hierarchy_Reference structures within this list.




Prev: SE_Octant_Select_Parameters. Next: SE_Packed_Hierarchy_Object.


Return to: Top of this Page, Type Index