IConstBundle2

class omni.graph.core.IConstBundle2

Bases: _IConstBundle2

Provide read only access to recursive bundles.

Methods

__init__(*args, **kwargs)	Overloaded function.
add_attribute(self, type, name)	DEPRECATED - use create_attribute() instead.
add_attributes(self, types, names)	DEPRECATED - use create_attributes() instead.
clear(self)	DEPRECATED - use clear_contents() instead
get_attribute_by_name(*args, **kwargs)	Overloaded function.
get_attribute_count(self)	Get the number of attributes in this bundle
get_attribute_data(self[, write])	DEPRECATED - use get_attributes() instead
get_attribute_data_count(self)	DEPRECATED - use get_attribute_count() instead
get_attribute_metadata_by_name(*args, **kwargs)	Overloaded function.
get_attribute_metadata_count(self, attribute)	Gets the number of metadata fields in an attribute within the bundle
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)	DEPRECATED - use get_attribute_names() or get_attribute_types() instead
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)	Get the number of metadata entries
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)	Get the number of child bundles
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)	Get the context used by this bundle
get_metadata_storage(self)	Get access to metadata storage that contains all metadata information
get_name(self)	Get the name of the bundle
get_parent_bundle(self)	Get the parent bundle
get_path(self)	Get the path to this bundle
get_prim_path(self)	DEPRECATED - use get_path() instead
insert_attribute(self, attribute_to_copy, name)	DEPRECATED - use copy_attribute() instead
insert_bundle(self, bundle_to_copy)	DEPRECATED - use copy_bundle() instead.
is_legal_for_compute(self)
is_read_only(self)	Returns if this interface is read-only.
is_valid(self)	DEPRECATED - use bool cast instead
remove_attribute(self, name)	DEPRECATED - use remove_attribute_by_name() instead.
remove_attributes(self, names)	DEPRECATED - use remove_attributes_by_name() instead.

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

DEPRECATED - use create_attribute() instead.

add_attributes(self: omni.graph.core._omni_graph_core.IConstBundle2, types: List[omni::graph::core::Py_Type], names: List[str]) → None

DEPRECATED - use create_attributes() instead.

clear(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → None

DEPRECATED - use clear_contents() instead

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

DEPRECATED - use get_attribute_by_name(name) instead

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:

   omni.graph.core.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

Get the number of attributes in this bundle

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

DEPRECATED - use get_attributes() instead

get_attribute_data_count(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → int

DEPRECATED - use get_attribute_count() instead

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[omni.graph.core.AttributeData]: Array of metadata fields in the attribute.

2. 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:

   omni.graph.core.AttributeData: Metadata fields in the attribute.

get_attribute_metadata_count(

self: omni.graph.core._omni_graph_core.IConstBundle2,

attribute: str,

) → int

Gets the number of metadata fields in an attribute within the bundle

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.

Parameters:

attribute (str) – Name of the attribute.

Returns:

Array of names in the attribute.

Return type:

list[str]

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.

Parameters:

attribute (string) – Name of the attribute.

Returns:

Array of types in the attribute.

Return type:

list[omni.graph.core.Type]

get_attribute_names(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → List[str]

Get the names of all attributes in this bundle.

Returns:

A list of the names.

Return type:

list[str]

get_attribute_names_and_types(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → tuple

DEPRECATED - use get_attribute_names() or get_attribute_types() instead

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:

A list of the types.

Return type:

list[omni.graph.core.Type]

get_attributes(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → List[omni::graph::core::Py_AttributeData]

Get all attributes in this bundle.

Returns:

A list of all attributes in this bundle.

Return type:

list[omni.graph.core.AttributeData]

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.

Parameters:

names (list[str]) – Attribute names to search for.

Returns:

A list of found attributes.

Return type:

list[omni.graph.core.AttributeData]

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[omni.graph.core.AttributeData]: Metadata fields in this bundle.

2. 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:

   omni.graph.core.AttributeData: Metadata field in this bundle.

get_bundle_metadata_count(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → int

Get the number of metadata entries

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:

Array of names in this bundle.

Return type:

list[str]

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:

Array of types in this bundle.

Return type:

list[omni.graph.core.Type]

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.

Parameters:

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

Returns:

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

Return type:

omni.graph.core.IConstBundle2

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.

Parameters:

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

Returns:

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

Return type:

omni.graph.core.IConstBundle2

get_child_bundle_count(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → int

Get the number of child bundles

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:

A list of all child bundles in this bundle.

Return type:

list[omni.graph.core.IConstBundle2]

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.

Parameters:

names (list[str]) – Names to child bundles in this bundle.

Returns:

A list of found child bundles in this bundle.

Return type:

list[omni.graph.core.IConstBundle2]

get_context(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → omni::graph::core::Py_GraphContext

Get the context used by this bundle

Returns:

The context of this bundle.

Return type:

omni.graph.core.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

Returns:

List of bundles with the metadata information

Return type:

list[omni.graph.core.IBundle2]

get_name(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → str

Get the name of the bundle

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

Get the parent bundle

Returns:

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

Return type:

omni.graph.core.IConstBundle2

get_path(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → str

Get the path to this bundle

Returns:

The path to this bundle.

Return type:

str

get_prim_path(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → str

DEPRECATED - use get_path() instead

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

DEPRECATED - use copy_attribute() instead

insert_bundle(

self: omni.graph.core._omni_graph_core.IConstBundle2,

bundle_to_copy: omni.graph.core._omni_graph_core.IConstBundle2,

) → None

DEPRECATED - use copy_bundle() instead.

is_legal_for_compute(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → bool

Returns:

True if this bundle is valid and ready for use in a compute function, False otherwise.

Return type:

bool

is_read_only(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → bool

Returns if this interface is read-only.

is_valid(

self: omni.graph.core._omni_graph_core.IConstBundle2,

) → bool

DEPRECATED - use bool cast instead

remove_attribute(

self: omni.graph.core._omni_graph_core.IConstBundle2,

name: str,

) → None

DEPRECATED - use remove_attribute_by_name() instead.

remove_attributes(

self: omni.graph.core._omni_graph_core.IConstBundle2,

names: List[str],

) → None

DEPRECATED - use remove_attributes_by_name() instead.