omni::graph::core::IConstBundle2_abi

Defined in omni/graph/core/bundle/IConstBundle2.h

Inheritance Relationships

Base Type

  • public omni::core::Inherits< omni::core::IObject, OMNI_TYPE_ID("omni.graph.core.IConstBundle2")>

class IConstBundle2_abi : public omni::core::Inherits<omni::core::IObject, OMNI_TYPE_ID("omni.graph.core.IConstBundle2")>

Provide read only access to recursive bundles.

Protected Functions

virtual bool isValid_abi() noexcept = 0

Return true if this bundle is valid, false otherwise.

virtual GraphContextObj getContext_abi() noexcept = 0

Return the context of this bundle.

virtual ConstBundleHandle getConstHandle_abi() noexcept = 0

Return Handle to this bundle. Invalid handle is returned if this bundle is invalid.

virtual omni::fabric::PathC getPath_abi() noexcept = 0

Return full path of this bundle.

virtual NameToken getName_abi() noexcept = 0

Return name of this bundle.

virtual ConstBundleHandle getConstParentBundle_abi() noexcept = 0

Return handle to the parent of this bundle. Invalid handle is returned if bundle has no parent.

virtual omni::core::Result getAttributeNamesAndTypes_abi(NameToken *const names, Type *const types, size_t *const nameAndTypeCount) noexcept = 0

Get the names and types of all attributes in this bundle.

This method operates in two modes: query mode or get mode.

Query mode is enabled when names and types are nullptr. When in this mode, *nameAndTypeCount will be populated with the number of attributes in the bundle.

Get mode is enabled when names or types is not nullptr. Upon entering the function, *nameAndTypeCount stores the number of entries in names and types. In Get mode names are not nullptr, names array is populated with attribute names. In Get mode types are not nullptr, types array is populated with attribute types.

Parameters

  • names – The names of the attributes.

  • types – The types of the attributes.

  • nameAndTypeCount – must not be nullptr in both modes.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.

virtual omni::core::Result getConstAttributes_abi(ConstAttributeDataHandle *const attributes, size_t *const attributeCount) noexcept = 0

Get read only handles to all attributes in this bundle.

This method operates in two modes: query mode or get mode.

Query mode is enabled when attributes is nullptr. When in this mode, *attributeCount will be populated with the number of attributes in the bundle.

Get mode is enabled when attributes is not nullptr. Upon entering the function, *attributeCount stores the number of entries in attributes. In Get mode attributes are not nullptr, attributes array is populated with attribute handles in the bundle.

Parameters

  • attributes – The buffer to store handles of the attributes in this bundle.

  • attributeCount – Size of attributes buffer. Must not be nullptr in both modes.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.

virtual omni::core::Result getConstAttributesByName_abi(NameToken const *const names, size_t nameCount, ConstAttributeDataHandle *const attributes) noexcept = 0

Search for read only handles of the attribute in this bundle by using attribute names.

Parameters

  • names – The name of the attributes to be searched for.

  • nameCount – Size of names buffer.

  • attributes – The buffer to store handles of the attributes.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.

virtual omni::core::Result getConstChildBundles_abi(ConstBundleHandle *const bundles, size_t *const bundleCount) noexcept = 0

Get read only handles to all child bundles in this bundle.

This method operates in two modes: query mode or get mode.

Query mode is enabled when bundles is nullptr. When in this mode, *bundleCount will be populated with the number of bundles in the bundle.

Get mode is enabled when bundles is not nullptr. Upon entering the function, *bundleCount stores the number of entries in bundles. In Get mode bundles are not nullptr, bundles array is populated with bundle handles in the bundle.

Parameters

  • bundles – The buffer to save child bundle handles.

  • bundleCount – Size of the bundles buffer. Must not be nullptr in both modes.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.

virtual omni::core::Result getConstChildBundle_abi(size_t bundleIndex, ConstBundleHandle *const bundle) noexcept = 0

Get read only handle to child bundle by index.

Parameters

  • bundleIndex – Bundle index in range [0, childBundleCount).

  • bundle – Handle under the index. If bundle index is out of range, then invalid handle is returned.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.

virtual omni::core::Result getConstChildBundlesByName_abi(NameToken const *const names, size_t nameCount, ConstBundleHandle *const foundBundles) noexcept = 0

Lookup for read only handles to child bundles under specified names.

For children that are not found invalid handles are returned.

Parameters

  • names – The names of the child bundles in this bundle.

  • nameCount – The number of child bundles to be searched.

  • foundBundles – Output handles to the found bundles.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.

virtual ConstBundleHandle getConstMetadataStorage_abi() noexcept = 0

Deprecated:

Metadata storage is deprecated and invalid handle is returned.

virtual omni::core::Result getBundleMetadataNamesAndTypes_abi(NameToken *const fieldNames, Type *const fieldTypes, size_t *const fieldCount) noexcept = 0

Get the names and types of all bundle metadata fields in this bundle.

This method operates in two modes: query mode or get mode.

Query mode is enabled when fieldNames and fieldTypes are nullptr. When in this mode, *fieldCount will be populated with the number of metadata fields in this bundle.

Get mode is enabled when fieldNames or fieldTypes is not nullptr. Upon entering the function, *fieldCount stores the number of entries in fieldNames and fieldTypes.

In Get mode fieldNames are not nullptr, fieldNames array is populated with field names. In Get mode fieldTypes are not nullptr, fieldTypes array is populated with field types.

Parameters

  • fieldNames – Output field names in this bundle.

  • fieldTypes – Output field types in this bundle.

  • fieldCount – must not be nullptr in both modes.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.

virtual omni::core::Result getConstBundleMetadataByName_abi(NameToken const *const fieldNames, size_t fieldCount, ConstAttributeDataHandle *const bundleMetadata) noexcept = 0

Search for field handles in this bundle by using field names.

Parameters

  • fieldNames – Name of bundle metadata fields to be searched for.

  • fieldCount – Size of fieldNames and bundleMetadata arrays.

  • bundleMetadata – Handle to metadata fields in this bundle.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.

virtual omni::core::Result getAttributeMetadataNamesAndTypes_abi(NameToken attribute, NameToken *const fieldNames, Type *const fieldTypes, size_t *const fieldCount) noexcept = 0

Get the names and types of all attribute metadata fields in the attribute.

This method operates in two modes: query mode or get mode.

Query mode is enabled when fieldNames and fieldTypes are nullptr. When in this mode, *fieldCount will be populated with the number of metadata fields in the attribute.

Get mode is enabled when fieldNames or fieldTypes is not nullptr. Upon entering the function, *fieldCount stores the number of entries in fieldNames and fieldTypes.

In Get mode fieldNames are not nullptr, fieldNames array is populated with field names. In Get mode fieldTypes are not nullptr, fieldTypes array is populated with field types.

Parameters

  • attribute – Name of the attribute.

  • fieldNames – Output field names in the attribute.

  • fieldTypes – Output field types in the attribute.

  • fieldCount – must not be nullptr in both modes.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.

virtual omni::core::Result getConstAttributeMetadataByName_abi(NameToken attribute, NameToken const *const fieldNames, size_t fieldCount, ConstAttributeDataHandle *const attributeMetadata) noexcept = 0

Search for read only field handles in the attribute by using field names.

Parameters

  • attribute – The name of the attribute.

  • fieldNames – The names of attribute metadata fields to be searched for.

  • fieldCount – Size of fieldNames and attributeMetadata arrays.

  • attributeMetadata – Handles to attribute metadata fields in the attribute.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.