IBundle2

class omni.graph.core.IBundle2

Bases: _IBundle2

Provide read write 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
clear_contents(self[, bundle_metadata, ...])	Removes all attributes and child bundles from this bundle, but keeps the bundle itself.
copy_attribute(*args, **kwargs)	Overloaded function.
copy_attributes(*args, **kwargs)	Overloaded function.
copy_bundle(self, source_bundle[, overwrite])	Copy bundle data and metadata from the source bundle to this bundle.
copy_child_bundle(*args, **kwargs)	Overloaded function.
copy_child_bundles(*args, **kwargs)	Overloaded function.
create_attribute(self, name, type, element_count)	Creates attribute based on provided name and type.
create_attribute_like(self, pattern_attribute)	Use input attribute as pattern to create attribute in this bundle.
create_attribute_metadata(*args, **kwargs)	Overloaded function.
create_attributes(self, names, types)	Creates attributes based on provided names and types.
create_attributes_like(self, pattern_attributes)	Use input attributes as pattern to create attributes in this bundle.
create_bundle_metadata(*args, **kwargs)	Overloaded function.
create_child_bundle(self, path)	Creates immediate child bundle under specified path in this bundle.
create_child_bundles(self, paths)	Creates immediate child bundles under specified paths in this bundle.
get_attribute_by_name(*args, **kwargs)	Overloaded function.
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_names_and_types(self)	DEPRECATED - use get_attribute_names() or get_attribute_types() instead
get_attributes(self)	Searches for attributes in this bundle by using attribute names.
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_child_bundle(self, index)	Get the child bundle by index.
get_child_bundle_by_name(self, name)	Lookup for child under specified name.
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_metadata_storage(self)	DEPRECATED - DO NOT USE
get_parent_bundle(self)	Get the parent of 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_read_only(self)	Returns if this interface is read-only.
is_valid(self)	DEPRECATED - use bool cast instead
link_attribute(*args, **kwargs)	Overloaded function.
link_attributes(*args, **kwargs)	Overloaded function.
link_child_bundle(*args, **kwargs)	Overloaded function.
link_child_bundles(*args, **kwargs)	Overloaded function.
remove_all_attributes(self)	Remove all attributes from this bundle.
remove_all_child_bundles(self)	Remove all child bundles from this bundle.
remove_attribute(*args, **kwargs)	Overloaded function.
remove_attribute_metadata(*args, **kwargs)	Overloaded function.
remove_attributes(*args, **kwargs)	Overloaded function.
remove_attributes_by_name(self, names)	Looks up the attributes by names and remove their data and metadata.
remove_bundle_metadata(*args, **kwargs)	Overloaded function.
remove_child_bundle(self, bundle)	Looks up the bundle and if it is child of the bundle then remove it.
remove_child_bundles(self, bundles)	Looks up the bundles and if they are children of the bundle then remove them.
remove_child_bundles_by_name(self, names)	Looks up child bundles by name and remove their data and metadata.

Attributes

__init__(*args, **kwargs)

Overloaded function.

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

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

add_attribute(self: omni.graph.core._omni_graph_core.IBundle2, 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.IBundle2, types: List[omni::graph::core::Py_Type], names: List[str]) → None

DEPRECATED - use create_attributes() instead.

clear(self: omni.graph.core._omni_graph_core.IBundle2) → None

DEPRECATED - use clear_contents() instead

clear_contents(self: omni.graph.core._omni_graph_core.IBundle2, bundle_metadata: bool = True, attributes: bool = True, child_bundles: bool = True) → int

Removes all attributes and child bundles from this bundle, but keeps the bundle itself.

Parameters

• bundle_metadata (bool) – Clears bundle metadata in this bundle.

• attributes (bool) – Clears attributes in this bundle.

• child_bundles (bool) – Clears child bundles in this bundle.

Returns

Success if successfully cleared.

Return type

omni.core.Result

copy_attribute(*args, **kwargs)

Overloaded function.

1. copy_attribute(self: omni.graph.core._omni_graph_core.IBundle2, attribute: omni::graph::core::Py_AttributeData, overwrite: bool = True) -> omni::graph::core::Py_AttributeData

   Create new attribute by copying existing one, including its data.

   Created attribute is owned by this bundle.

   Args:

   attribute (omni.graph.core.AttributeData): Attribute whose data type is to be copied. overwrite (bool): Overwrite existing attribute in this bundle.

   Returns:

   omni.graph.core.AttributeData: Copied attribute.

2. copy_attribute(self: omni.graph.core._omni_graph_core.IBundle2, name: str, attribute: omni::graph::core::Py_AttributeData, overwrite: bool = True) -> omni::graph::core::Py_AttributeData

   Create new attribute by copying existing one, including its data.

   Created attribute is owned by this bundle.

   Args:

   name (str): The new name for copied attribute. attribute (omni.graph.core.AttributeData): Attribute whose data type is to be copied. overwrite (bool): Overwrite existing attribute in this bundle.

   Returns:

   omni.graph.core.AttributeData: Copied attribute.

copy_attributes(*args, **kwargs)

Overloaded function.

1. copy_attributes(self: omni.graph.core._omni_graph_core.IBundle2, attributes: List[omni::graph::core::Py_AttributeData], overwrite: bool = True) -> List[omni::graph::core::Py_AttributeData]

   Create new attributes by copying existing ones, including their data.

   Names of new attributes are taken from source attributes. Created attributes are owned by this bundle.

   Args:

   attributes (list[omni.graph.core.AttributeData]): Attributes whose data type is to be copied. overwrite (bool): Overwrite existing attributes in this bundle.

   Returns:

   list[omni.graph.core.AttributeData]: A list of copied attributes.

2. copy_attributes(self: omni.graph.core._omni_graph_core.IBundle2, names: List[str], attributes: List[omni::graph::core::Py_AttributeData], overwrite: bool = True) -> List[omni::graph::core::Py_AttributeData]

   Create new attributes by copying existing ones, including their data, with possibility of giving them new names.

   Created attributes are owned by this bundle.

   Args:

   names (list[str]): Names for the new attributes. attributes (list[omni.graph.core.AttributeData]): Attributes whose data type is to be copied. overwrite (bool): Overwrite existing attributes in this bundle.

   Returns:

   list[omni.graph.core.AttributeData]: A list of copied attributes.

copy_bundle(self: omni.graph.core._omni_graph_core.IBundle2, source_bundle: omni.graph.core._omni_graph_core.IConstBundle2, overwrite: bool = True) → None

Copy bundle data and metadata from the source bundle to this bundle.

Parameters

• source_bundle (omni.graph.core.IConstBundle2) – Bundle whose data is to be copied.

• overwrite (bool) – Overwrite existing content of the bundle.

copy_child_bundle(*args, **kwargs)

Overloaded function.

1. copy_child_bundle(self: omni.graph.core._omni_graph_core.IBundle2, bundle: omni.graph.core._omni_graph_core.IConstBundle2, name: Optional[str] = None) -> omni.graph.core._omni_graph_core.IBundle2

   Create new child bundle by copying existing one, with possibility of giving child a new name.

   Created bundle is owned by this bundle.

   Args:

   bundle (omni.graph.core.IConstBundle2): Bundle whose data is to be copied. name (str): Name of new child.

   Returns:

   omni.graph.core.IBundle2: Newly copied bundle.

2. copy_child_bundle(self: omni.graph.core._omni_graph_core.IBundle2, name: str, bundle: omni.graph.core._omni_graph_core.IConstBundle2) -> omni.graph.core._omni_graph_core.IBundle2

   Create new child bundle by copying existing one, with possibility of giving child a new name.

   Created bundle is owned by this bundle.

   Args:

   name (str): Name of new child. bundle (omni.graph.core.IConstBundle2): Bundle whose data is to be copied.

   Returns:

   omni.graph.core.IBundle2: Newly copied bundle.

copy_child_bundles(*args, **kwargs)

Overloaded function.

1. copy_child_bundles(self: omni.graph.core._omni_graph_core.IBundle2, bundles: List[omni.graph.core._omni_graph_core.IConstBundle2], names: Optional[List[str]] = None) -> List[omni.graph.core._omni_graph_core.IBundle2]

   Create new child bundles by copying existing ones, with possibility of giving children new names.

   Created bundles are owned by this bundle.

   Args:

   bundles (list[omni.graph.core.IConstBundle2]): Bundles whose data is to be copied. names (list[str]): Names of new children.

   Returns:

   list[omni.graph.core.IBundle2]: Newly copied bundles.

2. copy_child_bundles(self: omni.graph.core._omni_graph_core.IBundle2, names: List[str], bundles: List[omni.graph.core._omni_graph_core.IConstBundle2]) -> List[omni.graph.core._omni_graph_core.IBundle2]

   Create new child bundles by copying existing ones, with possibility of giving children new names.

   Created bundles are owned by this bundle.

   Args:

   names (list[str]): Names of new children. bundles (list[omni.graph.core.IConstBundle2]): Bundles whose data is to be copied.

   Returns:

   list[omni.graph.core.IBundle2]: Newly copied bundles.

create_attribute(self: omni.graph.core._omni_graph_core.IBundle2, name: str, type: omni::graph::core::Py_Type, element_count: int = 0) → omni::graph::core::Py_AttributeData

Creates attribute based on provided name and type.

Created attribute is owned by this bundle.

Parameters

• name (str) – Name of the attribute.

• type (omni.graph.core.Type) – Type of the attribute.

• element_count (int) – Number of elements in the array.

Returns

Newly created attribute.

Return type

omni.graph.core.AttributeData

create_attribute_like(self: omni.graph.core._omni_graph_core.IBundle2, pattern_attribute: omni::graph::core::Py_AttributeData) → omni::graph::core::Py_AttributeData

Use input attribute as pattern to create attribute in this bundle.

The name and type are taken from pattern attribute, data is not copied. Created attribute is owned by this bundle.

Parameters

pattern_attribute (omni.graph.core.AttributeData) – Attribute whose name and type is to be used to create new attribute.

Returns

Newly created attribute.

Return type

omni.graph.core.AttributeData

create_attribute_metadata(*args, **kwargs)

Overloaded function.

1. create_attribute_metadata(self: omni.graph.core._omni_graph_core.IBundle2, attribute: str, field_names: List[str], field_types: List[omni::graph::core::Py_Type]) -> List[omni::graph::core::Py_AttributeData]

   Create attribute metadata fields.

   Args:

   attribute (str): Name of the attribute. field_names (list[str]): Names of new metadata field. field_types (list[omni.graph.core.Type]): Types of new metadata field. element_count (int): Number of elements in the arrray.

   Returns:

   list[omni.graph.core.AttributeData]: Newly created metadata fields.

2. create_attribute_metadata(self: omni.graph.core._omni_graph_core.IBundle2, attribute: str, field_name: str, field_type: omni::graph::core::Py_Type, element_count: int = 0) -> omni::graph::core::Py_AttributeData

   Create attribute metadata field.

   Args:

   attribute (str): Name of the attribute. field_name (str): Name of new metadata field. field_type (omni.graph.core.Type): Type of new metadata field.

   Returns:

   omni.graph.core.AttributeData: Newly created metadata field.

create_attributes(self: omni.graph.core._omni_graph_core.IBundle2, names: List[str], types: List[omni::graph::core::Py_Type]) → List[omni::graph::core::Py_AttributeData]

Creates attributes based on provided names and types.

Created attributes are owned by this bundle.

Parameters

• names (list[str]) – Names of the attributes.

• types (list[omni.graph.core.Type]) – Types of the attributes.

Returns

A list of created attributes.

Return type

list[omni.graph.core.AttributeData]

create_attributes_like(self: omni.graph.core._omni_graph_core.IBundle2, pattern_attributes: List[omni::graph::core::Py_AttributeData]) → List[omni::graph::core::Py_AttributeData]

Use input attributes as pattern to create attributes in this bundle.

Names and types for new attributes are taken from pattern attributes, data is not copied. Created attributes are owned by this bundle.

Parameters

pattern_attributes (list[omni.graph.core.AttributeData]) – Attributes whose name and type is to be used to create new attributes.

Returns

A list of newly created attributes.

Return type

list[omni.graph.core.AttributeData]

create_bundle_metadata(*args, **kwargs)

Overloaded function.

1. create_bundle_metadata(self: omni.graph.core._omni_graph_core.IBundle2, field_names: List[str], field_types: List[omni::graph::core::Py_Type]) -> List[omni::graph::core::Py_AttributeData]

   Creates bundle metadata fields based on provided names and types.

   Created fields are owned by this bundle.

   Args:

   field_names (list[str]): Names of the fields. field_types (list[omni.graph.core.Type]): Types of the fields. element_count (int): Number of elements in the arrray.

   Returns:

   list[omni.graph.core.AttributeData]: A list of created fields.

2. create_bundle_metadata(self: omni.graph.core._omni_graph_core.IBundle2, field_name: str, field_type: omni::graph::core::Py_Type, element_count: int = 0) -> omni::graph::core::Py_AttributeData

   Creates bundle metadata field based on provided name and type.

   Created field are owned by this bundle.

   Args:

   field_name (str): Name of the field. field_type (omni.graph.core.Type): Type of the field.

   Returns:

   omni.graph.core.AttributeData: Created field.

create_child_bundle(self: omni.graph.core._omni_graph_core.IBundle2, path: str) → omni.graph.core._omni_graph_core.IBundle2

Creates immediate child bundle under specified path in this bundle.

Created bundle is owned by this bundle. This method does not work recursively. Only immediate child can be created.

Parameters

path (str) – New child path in this bundle.

Returns

Created child bundle.

Return type

omni.graph.core.IBundle2

create_child_bundles(self: omni.graph.core._omni_graph_core.IBundle2, paths: List[str]) → List[omni.graph.core._omni_graph_core.IBundle2]

Creates immediate child bundles under specified paths in this bundle.

Created bundles are owned by this bundle. This method does not work recursively. Only immediate children can be created.

Parameters

paths (list[str]) – New children paths in this bundle.

Returns

A list of created child bundles.

Return type

list[omni.graph.core.IBundle2]

get_attribute_by_name(*args, **kwargs)

Overloaded function.

1. get_attribute_by_name(self: omni.graph.core._omni_graph_core.IBundle2, 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.IBundle2, 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_data(self: omni.graph.core._omni_graph_core.IBundle2, write: bool = False) → list

DEPRECATED - use get_attributes() instead

get_attribute_data_count(self: omni.graph.core._omni_graph_core.IBundle2) → 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.IBundle2, 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.IBundle2, 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_names_and_types(self: omni.graph.core._omni_graph_core.IBundle2) → tuple

DEPRECATED - use get_attribute_names() or get_attribute_types() instead

get_attributes(self: omni.graph.core._omni_graph_core.IBundle2) → 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_attributes_by_name(self: omni.graph.core._omni_graph_core.IBundle2, 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.IBundle2, 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.IBundle2, 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_child_bundle(self: omni.graph.core._omni_graph_core.IBundle2, index: int) → omni.graph.core._omni_graph_core.IBundle2

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.IBundle2

get_child_bundle_by_name(self: omni.graph.core._omni_graph_core.IBundle2, name: str) → omni.graph.core._omni_graph_core.IBundle2

Lookup for child under specified name.

Parameters

path (str) – Name 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.IBundle2

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

Get all child bundle handles in this bundle.

Returns

A list of all child bundles in this bundle.

Return type

list[omni.graph.core.IBundle2]

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

Lookup for children under specified names.

Parameters

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

Returns

A list of found child bundles in this bundle.

Return type

list[omni.graph.core.IBundle2]

get_metadata_storage(self: omni.graph.core._omni_graph_core.IBundle2) → omni.graph.core._omni_graph_core.IBundle2

DEPRECATED - DO NOT USE

get_parent_bundle(self: omni.graph.core._omni_graph_core.IBundle2) → omni.graph.core._omni_graph_core.IBundle2

Get the parent of this bundle

Returns

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

Return type

omni.graph.core.IBundle2

get_prim_path(self: omni.graph.core._omni_graph_core.IBundle2) → str

DEPRECATED - use get_path() instead

insert_attribute(self: omni.graph.core._omni_graph_core.IBundle2, 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.IBundle2, bundle_to_copy: omni.graph.core._omni_graph_core.IConstBundle2) → None

DEPRECATED - use copy_bundle() instead.

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.IBundle2) → bool

DEPRECATED - use bool cast instead

link_attribute(*args, **kwargs)

Overloaded function.

1. link_attribute(self: omni.graph.core._omni_graph_core.IBundle2, target_attribute: omni::graph::core::Py_AttributeData) -> omni::graph::core::Py_AttributeData

   Adds an attribute to this bundle as link with names taken from target attribute.

   Added attribute is a link to other attribute that is part of another bundle. The link is owned by this bundle, but target of the link is not. Removing link from this bundle does not destroy the data link points to.

   Args:

   target_attribute (omni.graph.core.AttributeData): Attribute whose data is to be added.

   Returns:

   omni.graph.core.AttributeData: Attribute that is a link.

2. link_attribute(self: omni.graph.core._omni_graph_core.IBundle2, link_name: str, target_attribute: omni::graph::core::Py_AttributeData) -> omni::graph::core::Py_AttributeData

   Adds an attribute to this bundle as link with custom name.

   Added attribute is a link to other attribute that is part of another bundle. The link is owned by this bundle, but target of the link is not. Removing link from this bundle does not destroy the data link points to.

   Args:

   link_name (str): Name for new link. target_attribute (omni.graph.core.AttributeData): Attribute whose data is to be added.

   Returns:

   omni.graph.core.AttributeData: Attribute that is a link.

link_attributes(*args, **kwargs)

Overloaded function.

1. link_attributes(self: omni.graph.core._omni_graph_core.IBundle2, target_attributes: List[omni::graph::core::Py_AttributeData]) -> List[omni::graph::core::Py_AttributeData]

   Adds a set of attributes to this bundle as links with names taken from target attributes.

   Added attributes are links to other attributes that are part of another bundle. The links are owned by this bundle, but targets of the links are not. Removing links from this bundle does not destroy the data links point to.

   Args:

   target_attributes (list[omni.graph.core.AttributeData]): Attributes whose data is to be added.

   Returns:

   list[omni.graph.core.AttributeData]: A list of attributes that are links.

2. link_attributes(self: omni.graph.core._omni_graph_core.IBundle2, link_names: List[str], target_attributes: List[omni::graph::core::Py_AttributeData]) -> List[omni::graph::core::Py_AttributeData]

   Adds a set of attributes to this bundle as links with custom names.

   Added attributes are links to other attributes that are part of another bundle. The links are owned by this bundle, but targets of the links are not. Removing links from this bundle does not destroy the data links point to.

   Args:

   link_names (list[str]): target_attributes (list[omni.graph.core.AttributeData]): Attributes whose data is to be added.

   Returns:

   list[omni.graph.core.AttributeData]: A list of attributes that are links.

link_child_bundle(*args, **kwargs)

Overloaded function.

1. link_child_bundle(self: omni.graph.core._omni_graph_core.IBundle2, name: str, bundle: omni.graph.core._omni_graph_core.IConstBundle2) -> omni.graph.core._omni_graph_core.IBundle2

   Link a bundle as child in current bundle, under given name.

   Args:

   name (str): The name under which the child bundle should be linked bundle (omni.graph.core.IConstBundle2): The bundle to link

   Returns:

   omni.graph.core.IBundle2: The linked bundle.

2. link_child_bundle(self: omni.graph.core._omni_graph_core.IBundle2, bundle: omni.graph.core._omni_graph_core.IConstBundle2) -> omni.graph.core._omni_graph_core.IBundle2

   Link a bundle as child in current bundle.

   Args:

   bundle (omni.graph.core.IConstBundle2): The bundle to link

   Returns:

   omni.graph.core.IBundle2: The linked bundle.

link_child_bundles(*args, **kwargs)

Overloaded function.

1. link_child_bundles(self: omni.graph.core._omni_graph_core.IBundle2, names: List[str], bundles: List[omni.graph.core._omni_graph_core.IConstBundle2]) -> List[omni.graph.core._omni_graph_core.IBundle2]

   Link a set of bundles as child in current bundle, under given names.

   Args:

   names (list[str]): The names under which the child bundles should be linked bundles (list[omni.graph.core.IConstBundle2]): The bundles to link

   Returns:

   list[omni.graph.core.IBundle2]: The list of created bundles.

2. link_child_bundles(self: omni.graph.core._omni_graph_core.IBundle2, bundles: List[omni.graph.core._omni_graph_core.IConstBundle2]) -> List[omni.graph.core._omni_graph_core.IBundle2]

   Link a set of bundles as child in current bundle.

   Args:

   bundles (list[omni.graph.core.IConstBundle2]): The bundles to link

   Returns:

   list[omni.graph.core.IBundle2]: The list of created bundles.

remove_all_attributes(self: omni.graph.core._omni_graph_core.IBundle2) → int

Remove all attributes from this bundle.

Returns

Number of attributes successfully removed.

Return type

int

remove_all_child_bundles(self: omni.graph.core._omni_graph_core.IBundle2) → int

Remove all child bundles from this bundle.

Only empty bundles can be removed.

Returns

Number of child bundles successfully removed.

Return type

int

remove_attribute(*args, **kwargs)

Overloaded function.

1. remove_attribute(self: omni.graph.core._omni_graph_core.IBundle2, name: str) -> None

DEPRECATED - use remove_attribute_by_name() instead.

2. remove_attribute(self: omni.graph.core._omni_graph_core.IBundle2, attribute: omni::graph::core::Py_AttributeData) -> int

   Looks up the attribute and if it is part of this bundle then remove it.

   Attribute handle that is not part of this bundle is ignored.

   Args:

   attribute (omni.graph.core.AttributeData): Attribute whose data is to be removed.

   Returns:

   omni.core.Result: Success if successfully removed.

remove_attribute_metadata(*args, **kwargs)

Overloaded function.

1. remove_attribute_metadata(self: omni.graph.core._omni_graph_core.IBundle2, attribute: str, field_names: List[str]) -> int

   Remove attribute metadata fields.

   Args:

   attribute (str): Name of the attribute. field_names (list[str]): Names of the fields to be removed.

   Returns:

   int: Number of fields successfully removed.

2. remove_attribute_metadata(self: omni.graph.core._omni_graph_core.IBundle2, attribute: str, field_name: str) -> int

   Remove attribute metadata field.

   Args:

   attribute (str): Name of the attribute. field_name (str): Name of the field to be removed.

   Returns:

   omni.core.Result: Success if successfully removed.

remove_attributes(*args, **kwargs)

Overloaded function.

1. remove_attributes(self: omni.graph.core._omni_graph_core.IBundle2, names: List[str]) -> None

DEPRECATED - use remove_attributes_by_name() instead.

2. remove_attributes(self: omni.graph.core._omni_graph_core.IBundle2, attributes: List[omni::graph::core::Py_AttributeData]) -> int

   Looks up the attributes and if they are part of this bundle then remove them.

   Attribute handles that are not part of this bundle are ignored.

   Args:

   attributes (list[omni.graph.core.AttributeData]): Attributes whose data is to be removed.

   Returns:

   int: number of removed attributes

remove_attributes_by_name(self: omni.graph.core._omni_graph_core.IBundle2, names: List[str]) → int

Looks up the attributes by names and remove their data and metadata.

Parameters

names (list[str]) – Names of the attributes whose data is to be removed.

Returns

Success if successfully removed.

Return type

omni.core.Result

remove_bundle_metadata(*args, **kwargs)

Overloaded function.

1. remove_bundle_metadata(self: omni.graph.core._omni_graph_core.IBundle2, field_names: List[str]) -> int

   Looks up bundle metadata fields and if they are part of this bundle metadata then remove them.

   Fields that are not part of this bundle are ignored.

   Args:

   field_names (list[str]): Names of the fields whose data is to be removed.

   Returns:

   int: Number of fields successfully removed.

2. remove_bundle_metadata(self: omni.graph.core._omni_graph_core.IBundle2, field_name: str) -> int

   Looks up bundle metadata field and if it is part of this bundle metadata then remove it.

   Field that is not part of this bundle is ignored.

   Args:

   field_name (str): Name of the field whose data is to be removed.

   Returns:

   omni.core.Result: Success if successfully removed.

remove_child_bundle(self: omni.graph.core._omni_graph_core.IBundle2, bundle: omni.graph.core._omni_graph_core.IConstBundle2) → int

Looks up the bundle and if it is child of the bundle then remove it.

Bundle handle that is not child of this bundle is ignored. Only empty bundle can be removed.

Parameters

bundle (omni.graph.core.IConstBundle2) – bundle to be removed.

Returns

Success if successfully removed.

Return type

omni.core.Result

remove_child_bundles(self: omni.graph.core._omni_graph_core.IBundle2, bundles: List[omni.graph.core._omni_graph_core.IConstBundle2]) → int

Looks up the bundles and if they are children of the bundle then remove them.

Bundle handles that are not children of this bundle are ignored. Only empty bundles can be removed.

Parameters

bundles (list[omni.graph.core.IConstBundle2]) – Bundles to be removed.

Returns

Number of child bundles successfully removed.

Return type

int

remove_child_bundles_by_name(self: omni.graph.core._omni_graph_core.IBundle2, names: List[str]) → int

Looks up child bundles by name and remove their data and metadata.

Parameters

names (list[str]) – Names of the child bundles to be removed.

Returns

Success if successfully removed.

Return type

omni.core.Result