Skip to main content

Mechanical scripting interface

ObjectTag

Last update: 14.01.2025

class Ansys.Mechanical.Application.ObjectTag

Bases: object

An instance of an ObjectTag.

Overview

Methods

Name Description
AddObject Add an object to this tag.
ClearObjects Clear all objects from this tag.
RemoveObject Remove an object from this tag.

Properties

Name Description
Name The name of the tag. If the tag exists in ObjectTags, attempting to set the name to a value of another tag in that collection will lead to an exception.
Objects The list of objects which use this tag.

Property detail

property ObjectTag.Name : str | None

The name of the tag. If the tag exists in ObjectTags, attempting to set the name to a value of another tag in that collection will lead to an exception.

property ObjectTag.Objects : Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

The list of objects which use this tag.

Method detail

ObjectTag.AddObject(obj: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)

Add an object to this tag.

ObjectTag.ClearObjects()

Clear all objects from this tag.

ObjectTag.RemoveObject(obj: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)

Remove an object from this tag.