IConstBundle2

class omni.graph.core.IConstBundle2

Bases: omni.graph.core._omni_graph_core._IConstBundle2, omni.core._core.IObject

Provide read only access to recursive bundles.

Methods

__init__(*args, **kwargs)

Overloaded function.

add_attribute(self, type, name)

add_attributes(self, types, names)

clear(self)

get_attribute_by_name(*args, **kwargs)

Overloaded function.

get_attribute_count(self)

returns

Number of attributes in this bundle.

get_attribute_data(self[, write])

get_attribute_data_count(self)

get_attribute_metadata_by_name(*args, **kwargs)

Overloaded function.

get_attribute_metadata_count(self, attribute)

param attribute

Name of the attribute to count metadata for.

get_attribute_metadata_names(self, attribute)

Get names of all metadata fields in the attribute.

get_attribute_metadata_types(self, attribute)

Get types of all metadata fields in the attribute.

get_attribute_names(self)

Get the names of all attributes in this bundle.

get_attribute_names_and_types(self)

get_attribute_types(self)

Get the types of all attributes in this bundle.

get_attributes(self)

Get all attributes in this bundle.

get_attributes_by_name(self, names)

Searches for attributes in this bundle by using attribute names.

get_bundle_metadata_by_name(*args, **kwargs)

Overloaded function.

get_bundle_metadata_count(self)

returns

Number of metadata fields in this bundle.

get_bundle_metadata_names(self)

Get the names of all metadata fields in this bundle.

get_bundle_metadata_types(self)

Get the types of all metadata fields in this bundle.

get_child_bundle(self, index)

Get the child bundle by index.

get_child_bundle_by_name(self, path)

Lookup for child under specified path.

get_child_bundle_count(self)

returns

Number of child bundles in this bundle.

get_child_bundles(self)

Get all child bundle handles in this bundle.

get_child_bundles_by_name(self, names)

Lookup for children under specified names.

get_context(self)

returns

The context of this bundle.

get_metadata_storage(self)

Get access to metadata storage that contains all metadata information

get_name(self)

returns

The name of this bundle.

get_parent_bundle(self)

returns

The parent of this bundle, or invalid bundle if there is no parent.

get_path(self)

returns

The path to this bundle.

get_prim_path(self)

insert_attribute(self, attribute_to_copy, name)

insert_bundle(self, bundle_to_copy)

is_valid(self)

remove_attribute(self, name)

remove_attributes(self, names)

Attributes

valid

__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: omni.graph.core._omni_graph_core.IConstBundle2, arg0: omni.core._core.IObject) -> None

  2. __init__(self: omni.graph.core._omni_graph_core.IConstBundle2) -> None

add_attribute(self: omni.graph.core._omni_graph_core.IConstBundle2, type: omni::graph::core::Py_Type, name: str) omni::graph::core::Py_AttributeData
add_attributes(self: omni.graph.core._omni_graph_core.IConstBundle2, types: List[omni::graph::core::Py_Type], names: List[str]) None
clear(self: omni.graph.core._omni_graph_core.IConstBundle2) None
get_attribute_by_name(*args, **kwargs)

Overloaded function.

  1. get_attribute_by_name(self: omni.graph.core._omni_graph_core.IConstBundle2, name: str, readOnly: bool) -> omni::graph::core::Py_AttributeData

  2. get_attribute_by_name(self: omni.graph.core._omni_graph_core.IConstBundle2, name: str) -> omni::graph::core::Py_AttributeData

Searches for attribute in this bundle by using attribute name.

Args:

name (str): Attribute name to search for.

Returns:

og.AttributeData: An attribute. If attribute is not found then invalid attribute is returned.

get_attribute_count(self: omni.graph.core._omni_graph_core.IConstBundle2) int
Returns

Number of attributes in this bundle.

Return type

int

get_attribute_data(self: omni.graph.core._omni_graph_core.IConstBundle2, write: bool = False) list
get_attribute_data_count(self: omni.graph.core._omni_graph_core.IConstBundle2) int
get_attribute_metadata_by_name(*args, **kwargs)

Overloaded function.

  1. get_attribute_metadata_by_name(self: omni.graph.core._omni_graph_core.IConstBundle2, attribute: str, field_names: List[str]) -> List[omni::graph::core::Py_AttributeData]

Search for metadata fields for the attribute by using field names.

Args:

attribute (str): Name of the attribute. field_names (List[str]): Attribute metadata fields to be searched for.

Returns:

List[og.AttributeData]: Array of metadata fields in the attribute.

  1. get_attribute_metadata_by_name(self: omni.graph.core._omni_graph_core.IConstBundle2, attribute: str, field_name: str) -> omni::graph::core::Py_AttributeData

Search for metadata field for the attribute by using field name.

Args:

attribute (str): Name of the attribute. field_name (str): Attribute metadata field to be searched for.

Returns:

og.AttributeData: Metadata fields in the attribute.

get_attribute_metadata_count(self: omni.graph.core._omni_graph_core.IConstBundle2, attribute: str) int
Parameters

attribute (str) – Name of the attribute to count metadata for.

Returns

Number of metadata fields in the attribute.

Return type

int

get_attribute_metadata_names(self: omni.graph.core._omni_graph_core.IConstBundle2, attribute: str) List[str]

Get names of all metadata fields in the attribute.

Args:

attribute (str): Name of the attribute.

Returns:

List[str]: Array of names in the attribute.

get_attribute_metadata_types(self: omni.graph.core._omni_graph_core.IConstBundle2, attribute: str) List[omni::graph::core::Py_Type]

Get types of all metadata fields in the attribute.

Args:

attribute (string): Name of the attribute.

Returns:

List[og.Type]: Array of types in the attribute.

get_attribute_names(self: omni.graph.core._omni_graph_core.IConstBundle2) List[str]

Get the names of all attributes in this bundle.

Returns:

List[str]: A list of the names.

get_attribute_names_and_types(self: omni.graph.core._omni_graph_core.IConstBundle2) tuple
get_attribute_types(self: omni.graph.core._omni_graph_core.IConstBundle2) List[omni::graph::core::Py_Type]

Get the types of all attributes in this bundle.

Returns:

List[og.Type]: A list of the types.

get_attributes(self: omni.graph.core._omni_graph_core.IConstBundle2) List[omni::graph::core::Py_AttributeData]

Get all attributes in this bundle.

Returns:

List[og.AttributeData]: A list of all attributes in this bundle.

get_attributes_by_name(self: omni.graph.core._omni_graph_core.IConstBundle2, names: List[str]) List[omni::graph::core::Py_AttributeData]

Searches for attributes in this bundle by using attribute names.

Args:

names (List[str]): Attribute names to search for.

Returns:

List[og.AttributeData]: A list of found attributes.

get_bundle_metadata_by_name(*args, **kwargs)

Overloaded function.

  1. get_bundle_metadata_by_name(self: omni.graph.core._omni_graph_core.IConstBundle2, field_names: List[str]) -> List[omni::graph::core::Py_AttributeData]

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

Args:

field_names (List[str]): Bundle metadata fields to be searched for.

Returns:

List[og.AttributeData]: Metadata fields in this bundle.

  1. get_bundle_metadata_by_name(self: omni.graph.core._omni_graph_core.IConstBundle2, field_name: str) -> omni::graph::core::Py_AttributeData

Search for field handle in this bundle by using field name.

Args:

field_name (str): Bundle metadata fields to be searched for.

Returns:

og.AttributeData: Metadata field in this bundle.

get_bundle_metadata_count(self: omni.graph.core._omni_graph_core.IConstBundle2) int
Returns

Number of metadata fields in this bundle.

Return type

int

get_bundle_metadata_names(self: omni.graph.core._omni_graph_core.IConstBundle2) List[str]

Get the names of all metadata fields in this bundle.

Returns:

List[str]: Array of names in this bundle.

get_bundle_metadata_types(self: omni.graph.core._omni_graph_core.IConstBundle2) List[omni::graph::core::Py_Type]

Get the types of all metadata fields in this bundle.

Returns:

List[og.Type]: Array of types in this bundle.

get_child_bundle(self: omni.graph.core._omni_graph_core.IConstBundle2, index: int) omni.graph.core._omni_graph_core.IConstBundle2

Get the child bundle by index.

Args:

index (int): Child bundle index in range [0, child_bundle_count).

Returns:

og.IConstBundle: Child bundle under the index. If bundle index is out of range, then invalid bundle is returned.

get_child_bundle_by_name(self: omni.graph.core._omni_graph_core.IConstBundle2, path: str) omni.graph.core._omni_graph_core.IConstBundle2

Lookup for child under specified path.

Args:

path (str): Path to child bundle in this bundle.

Returns:

og.IConstBundle: Child bundle in this bundle. If child does not exist under the path, then invalid bundle is returned.

get_child_bundle_count(self: omni.graph.core._omni_graph_core.IConstBundle2) int
Returns

Number of child bundles in this bundle.

Return type

int

get_child_bundles(self: omni.graph.core._omni_graph_core.IConstBundle2) List[omni.graph.core._omni_graph_core.IConstBundle2]

Get all child bundle handles in this bundle.

Returns:

List[og.IConstBundle]: A list of all child bundles in this bundle.

get_child_bundles_by_name(self: omni.graph.core._omni_graph_core.IConstBundle2, names: List[str]) List[omni.graph.core._omni_graph_core.IConstBundle2]

Lookup for children under specified names.

Args:

names (List[str]): Names to child bundles in this bundle.

Returns:

List[og.IConstBundle]: A list of found child bundles in this bundle.

get_context(self: omni.graph.core._omni_graph_core.IConstBundle2) omni::graph::core::Py_GraphContext
Returns

The context of this bundle.

Return type

og.GraphContext

get_metadata_storage(self: omni.graph.core._omni_graph_core.IConstBundle2) omni.graph.core._omni_graph_core.IConstBundle2

Get access to metadata storage that contains all metadata information

get_name(self: omni.graph.core._omni_graph_core.IConstBundle2) str
Returns

The name of this bundle.

Return type

str

get_parent_bundle(self: omni.graph.core._omni_graph_core.IConstBundle2) omni.graph.core._omni_graph_core.IConstBundle2
Returns

The parent of this bundle, or invalid bundle if there is no parent.

Return type

og.IConstBundle

get_path(self: omni.graph.core._omni_graph_core.IConstBundle2) str
Returns

The path to this bundle.

Return type

str

get_prim_path(self: omni.graph.core._omni_graph_core.IConstBundle2) str
insert_attribute(self: omni.graph.core._omni_graph_core.IConstBundle2, attribute_to_copy: omni::graph::core::Py_AttributeData, name: str) omni::graph::core::Py_AttributeData
insert_bundle(self: omni.graph.core._omni_graph_core.IConstBundle2, bundle_to_copy: omni.graph.core._omni_graph_core.IConstBundle2) None
is_valid(self: omni.graph.core._omni_graph_core.IConstBundle2) bool
remove_attribute(self: omni.graph.core._omni_graph_core.IConstBundle2, name: str) None
remove_attributes(self: omni.graph.core._omni_graph_core.IConstBundle2, names: List[str]) None