ENSOBJ#

class ansys.pyensight.core.ensobj.ENSOBJ(session: Session, objid: int, attr_id: int | None = None, attr_value: int | None = None, owned: bool | None = None)#

Bass class for all EnSight proxy objects

The ENSOBJ class is the base class for the EnSight object proxy interface. Note: this interface is internal and applications should not attempt to create ENSOBJ instances directly.

Parameters:
session

The session object associated with this object instance.

objid

The EnSight CvfObjID of the object instance that this instance will serve as the proxy for.

attr_id

For subclasses that differentiate classes by an attribute value, this is the attribute ID to use as the differentiator. Example classes are ENS_TOOL, ENS_PART and ENS_ANNOT.

attr_value

The attribute value associated with any specified attr_id.

ownedbool

If True, the object is assumed to be “owned” by this interpreter. This means that the lifecycle of the ENSOBJ instance in EnSight is dictated by the lifecycle of this proxy object.

Methods

ENSOBJ.attrinfo([attrid])

For a given attribute id, return type information

ENSOBJ.attrissensitive(attrid)

Check to see if a given attribute is 'sensitive'

ENSOBJ.attrtree([all, filter, exclude, ...])

Get detailed GUI information for attributes of this object.

ENSOBJ.destroy()

Destroy the EnSight object associated with this proxy object

ENSOBJ.getattr(attrid)

Query the value of the specified attribute

ENSOBJ.getattrs([attrid, text])

Query the value of a collection of attributes

ENSOBJ.getmetatag(tag)

Get the value of a tag in the METADATA attribute

ENSOBJ.hasmetatag(tag)

Check to see if a tag exists in the METADATA attribute

ENSOBJ.setattr(attrid, value)

Set the value of the specified attribute

ENSOBJ.setattr_begin()

Signal bulk attribute update begin

ENSOBJ.setattr_end()

Signal bulk attribute update end

ENSOBJ.setattr_status()

ENSOBJ.setattrs(values[, all_errors])

Set the values of a collection of attributes

ENSOBJ.setmetatag(tag, value)

Change a value in the METADATA attribute

Attributes