ENS_STATE#

class ansys.api.pyensight.ens_state.ENS_STATE(*args, **kwargs)#

This class acts as a proxy for the EnSight Python class ensight.objs.ENS_STATE

Args:
*args:

Superclass (ENSOBJ) arguments

**kwargs:

Superclass (ENSOBJ) keyword arguments

Methods

ENS_STATE.add_source(*args, **kwargs)

Add a new source to a state.

ENS_STATE.add_state(*args, **kwargs)

Add a new state.

ENS_STATE.apply(*args, **kwargs)

Appy attributes to current objects.

ENS_STATE.attrgroupinfo(*args, **kwargs)

Get information about GUI groups for object attributes

ENS_STATE.attrinfo([attrid])

For a given attribute id, return type information

ENS_STATE.attrissensitive(attrid)

Check to see if a given attribute is 'sensitive'

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

Get detailed GUI information for attributes of this object.

ENS_STATE.capture(*args, **kwargs)

Snapshot attributes from current objects.

ENS_STATE.create_state(*args, **kwargs)

Create a new state owned by Python proxy.

ENS_STATE.destroy()

Destroy the EnSight object associated with this proxy object

ENS_STATE.generate_report(*args, **kwargs)

Generate a Nexus report.

ENS_STATE.getattr(attrid)

Query the value of the specified attribute

ENS_STATE.getattrs([attrid, text])

Query the value of a collection of attributes

ENS_STATE.getmetatag(tag)

Get the value of a tag in the METADATA attribute

ENS_STATE.hasmetatag(tag)

Check to see if a tag exists in the METADATA attribute

ENS_STATE.move(*args, **kwargs)

Change the ordering of state/source children.

ENS_STATE.read(*args, **kwargs)

Read an attribute set from a file.

ENS_STATE.save(*args, **kwargs)

Save an attribute set to a file.

ENS_STATE.set_logo_file(*args, **kwargs)

Specify the file to use as a logo.

ENS_STATE.setattr(attrid, value)

Set the value of the specified attribute

ENS_STATE.setattr_begin()

Signal bulk attribute update begin

ENS_STATE.setattr_end()

Signal bulk attribute update end

ENS_STATE.setattr_status()

ENS_STATE.setattrs(values[, all_errors])

Set the values of a collection of attributes

ENS_STATE.setmetatag(tag, value)

Change a value in the METADATA attribute

ENS_STATE.undo(*args, **kwargs)

Revert to the state before the last apply.

ENS_STATE.update_tags(*args, **kwargs)

Update the TAGS property and optionally the session ID.

Attributes

ENS_STATE.CHILDREN

CHILDREN property

ENS_STATE.CMDLANG_REFERENCE

CMDLANG_REFERENCE property

ENS_STATE.CREATE_REPORT_TEMPLATE

CREATE_REPORT_TEMPLATE property

ENS_STATE.CURRENT

CURRENT property

ENS_STATE.DESCRIPTION

DESCRIPTION property

ENS_STATE.EDIT_TARGET

EDIT_TARGET property

ENS_STATE.GENERATION_PENDING

GENERATION_PENDING property

ENS_STATE.HANDLES_ENABLED

Control the display and use of EnSight click and go handles for an object

ENS_STATE.HTML

HTML property

ENS_STATE.LOGO_DATA

LOGO_DATA property

ENS_STATE.METADATA

METADATA property

ENS_STATE.PROJECT_MASK

PROJECT_MASK property

ENS_STATE.TAGS

TAGS property

ENS_STATE.TARGETS

TARGETS property

ENS_STATE.TEMPLATE_NAME

TEMPLATE_NAME property

ENS_STATE.TIMETRACK

TIMETRACK property

ENS_STATE.USE_LOGO

USE_LOGO property

ENS_STATE.UUID

UUID property

ENS_STATE.__OBJID__

ENS_STATE.objid

Return the EnSight object proxy ID (__OBJID__).