hw.hv Module#

Collection class#

class Collection(type: str | None = None, model: Model | None = None, populate: bool = True)#

Bases: object

A class representing Collection (Selection set) of entities.

Parameters:

type (Union[str, Entity]) – Entity type. Entity can be of Part, Node, or Element.
model (Union[Model, int, str]) – Model in which collection is present. Default is the active model.
populate (bool) – Populate all entity in collection. Default is True.

addByAdjacent(repeat=1, visible: bool = True)#

Method to add entities to a collection by its adjacent.

Parameters:: visible (bool) – All or displayed entities. Default is True (displayed).

addByAttached(visible: bool = True)#

Method to add entities to a collection by attached.

Parameters:: visible (bool) – All or displayed entities. Default is True (displayed).

addByComponentName(cname: list | str)#

Method to add entities to a collection by part name.

Parameters:: cname (Union[str, list]) – Part name or part name list

addByConfig(config, visible: bool = True)#

Method to add entities to a collection by configuration option.

Parameters:

config (Union[str,list of str]) – Configuration of the entity.
visible (bool) – All or displayed entities. Default is True (displayed).

addByDimension(dimension: list | int, visible: bool = True)#

Method to add entities to a collection by dimensions.

Parameters:

dimension (Union[int, list]) – Dimension of the entity. Dimension can be 0, 1, 2 or 3.
visible – All or displayed entities. Default is True (displayed).
type – bool

addByFace(visible: bool = True)#

Method to add entities to a collection by face. This is applicable for Node and Element.

Parameters:: visible (bool) – All or displayed entities. Default is True (displayed).

addByFilter(filter: list | Filter)#

Method to add entities to the collection by the filter. Filter can be an instance of FilterByScalar, FilterBySphere, or FilterByPlane.

Parameters:: filter (Union[Filter, List of Filters]) – Filter object or list of filter objects.

addByID(type: str, idstr: list | str, visible: bool = True, pool: str | None = None)#

Method to add entities to a collection by id option.

Parameters:

type (Union[str, Entity]) – Entity type. Entity can be of type Part, Node, or Element.
idstr (Union[int, str, list]) – ID, list of IDs or ID in string range format.
visible – All or displayed entities. Default is True (displayed).
type – bool
pool (str) – The specific pool, default is None.

addDisplayed()#: Method to add displayed entities to a collection.

clear()#

getEntities(pool: str | None = None)#

Method to get the entity list from a collection.

Parameters:: pool (list of entities) – The specific pool, default is None.

getIds(pool: str | None = None)#

Method to get the list of entity ids from collection.

Parameters:: pool (list of int) – The specific pool, default is None.

getPools() → list#: Method to get the pool list of the entity.

getSize()#

reverse(visible: bool = True)#

Method to reverse the entity selection of the collection. Default is True.

Parameters:

visible – All or displayed entities.
type – bool

subtractByComponentName(cname: list | str)#

Method to subtract entities from a collection by part name.

Parameters:: cname (Union[str, list]) – Part name or part name list

subtractByConfig(config, visible: bool = True)#

Method to subtract entities from a collection by configuration option.

Parameters:

config (Union[str,list of str]) – Configuration of the entity
visible (bool) – All or displayed entities. Default is True (displayed).

subtractByDimension(dimension: list | int, visible: bool = True)#

Method to subtract entities from a collection by dimensions.

Parameters:

dimension (Union[int, list]) – Dimension of the entity. Dimension can be 0, 1, 2 or 3.
visible – All or displayed entities. Default is True (displayed).
type – bool

subtractByFilter(filter: list | Filter)#

Method to subtract entities from a collection by filter. Filter can be instance of FilterByScalar, FilterBySphere, or FilterByPlane.

Parameters:: filter (Union[Filter, List of Filters]) – Filter object or list of filter objects.

subtractByID(type: str, idstr: list | str, visible: bool = True, pool: str | None = None)#

Method to subtract entities from a collection by id option.

Parameters:

type (Union[str, Entity]) – Entity type. Entity can be of type Part, Node, or Element.
idstr (Union[int, str, list]) – ID, list of IDs or ID in string range format.
visible – All or displayed entities. Default is True (displayed).
type – bool
pool (str) – The specific pool. Default is None.

subtractDisplayed()#: Method to subtract displayed entities from a collection.

property entityType#

Attribute to get the entity type of a collection.

Getter:: Gets entity type of a collection.
Type:: str

property model#

Attribute to get the model.

Getter:: Gets the model.
Type:: Model

Element class#

class Element(id, pool=None, model: Model | None = None)#

Bases: Entity

A class representing the element entity type. Get an Element for the given model. Raises an Exception parameter if it does not point to a valid Element.

Parameters:

id (int) – ID of the Element.
pool (str) – The specific pool, default is None.
model (Union[int, str, Model]) – The specific model, default is the active model.

property centroid#

Attribute to get the centroid of the Element.

Getter:: Gets centroid of the Element.
Type:: list

property config#

Attribute to get the config of the Element.

Getter:: Gets config of the Element.
Type:: int

property connectivity#

Attribute to get the connectivity of the Element.

Getter:: Gets connectivity of the Element.
Type:: list

property id#

Attribute to get the ID of the Element.

Getter:: Gets ID of the Element.
Type:: int

property normal#

Attribute to get the normal of the Element.

Getter:: Gets normal of the Element.
Type:: list

property part#

Attribute to get the Part of the Element.

Getter:: Gets Part of the Element.
Type:: Part

property partId#

Attribute to get the part id of the Element.

Getter:: Gets part id of the Element.
Type:: int

property pool#

Attribute to get the pool of the Element.

Getter:: Gets pool of the Element.
Type:: str

ExportModelH3D class#

class ExportModelH3D(page=None, window=None, file='', **kwargs)#

Bases: object

A class representing exporting the model in H3D format.

Parameters:

page (Union[Page, int, str]) – Page of the model, default is the active page.
window (Union[Window, int]) – Window of the model,default is the active window.
file (str) – H3D file name that you want to export. No default value.
kwargs (dict) – Param to set other attributes of ExportModelH3D class.

export()#: Method to export the model. If the file name is not specified, the name will be set to untitled followed by an incremental value (e.g. untitled1.jpg).

setAttributes(**kwargs)#: Method to set the ExportModelH3D attributes.

property allModels#

Attribute to set or get if all models from window is specified.

Getter:: Gets the all models attribute value.
Setter:: Sets the all models attribute value.
Type:: bool

property animation#

Attribute to set or get if animation is specified.

Getter:: Gets the animation attribute value.
Setter:: Sets the animation attribute value.
Type:: bool

property compressOutput#

Attribute to set or get compression output.

Getter:: Gets the compression output.
Setter:: Sets the compression output.
Type:: bool

property compressionLoss#

Attribute to set or get compression loss.

Getter:: Gets the compression loss.
Setter:: Sets the compression loss.
Type:: float

property entityAttributes#

Attribute to set or get if entity attributes from model is specified.

Getter:: Gets the entity attributes value.
Setter:: Sets the entity attributes value.
Type:: bool

property file#

Attribute to set or get H3D file name.

Getter:: Gets the H3D file name.
Setter:: Sets the H3D file name.
Type:: str

property html#

Attribute to set or get if html attribute is specified.

Getter:: Gets the html attributes value.
Setter:: Sets the html attributes value.
Type:: bool

property includeMaskedElements#

Attribute to set or get if include masked elements attribute from model is specified.

Getter:: Gets the include masked elements attribute value.
Setter:: Sets the include masked elements attribute value.
Type:: bool

property includeSets#

Attribute to set or get if include sets attribute from model is specified.

Getter:: Gets the include sets attribute value.
Setter:: Sets the include sets attribute value.
Type:: bool

property page#

Attribute to set or get page of the model

Getter:: Gets the page of the model
Setter:: Sets the page of the model
Type:: Page

property previewImage#

Attribute to set or get if preview image attribute is specified.

Getter:: Gets the preview image attributes value.
Setter:: Sets the preview image attributes value.
Type:: bool

property results#

Attribute to set or get if results is specified.

Getter:: Gets the results attribute value.
Setter:: Sets the results attribute value.
Type:: bool

property viewAttributes#

Attribute to set or get if view attributes is specified.

Getter:: Gets the view attributes value.
Setter:: Sets the view attributes value.
Type:: bool

property window#

Attribute to set or get window of the model

Getter:: Gets the window of the model
Setter:: Sets the window of the model
Type:: Window

FilterByPlane class#

class FilterByPlane(normal: str = 'y', base=0, width=0.1)#

Bases: Filter

A class representing the Filter by plane option for displayed entities, which can be used in the addByFilter method of a collection.

Parameters:

normal (str) – Normal of the plane. Default is y. Other available options are x, z, normaltoscreen.
base (int) – Base node id for creating the plane. Default is 0.
width (Union[int, float]) – width or tolerance for creating the plane. Default is 0.1.

property base#

Attribute to set or get the base node id.

Getter:: Gets the base node id.
Setter:: Sets the base node id.
Type:: str

property normal#

Attribute to set or get normal of the plane.

Getter:: Gets the normal of the plane.
Setter:: Sets the normal of the plane.
Type:: str

property width#

Attribute to set or get the width.

Getter:: Gets the width.
Setter:: Sets the width.
Type:: str

FilterByScalar class#

class FilterByScalar(operator: str = '==', value: int | float | None = None)#

Bases: Filter

A class representing the Filter by scalar option for displayed entities, which can be used in the addByFilter method of a collection.

Parameters:

operator (str) – Rule string, default is ==. Other available options are value, percent, topn, bottomn, noresult, >, <, <=, >=.
value (Union[int, float]) – Model in which collection is present. Default is active model.

property operator#

Attribute to set or get scalar operator.

Getter:: Gets the scalar operator.
Setter:: Sets the scalar operator. Available options are value, percent, topn, bottomn, noresult, >, <, <=, >=, ==.
Type:: str

property value#

Attribute to set or get the scalar value.

Getter:: Gets the scalar value.
Setter:: Sets the scalar value
Type:: Union[int, float]

FilterBySphere class#

class FilterBySphere(x: int | float = 0, y: int | float = 0, z: int | float = 0, radius: int | float = 1)#

Bases: Filter

A class representing the Filter by sphere option for displayed entities, which can be used in the addByFilter method of a collection.

Parameters:

x (Union[int, float]) – x value of the sphere center. Default is 0.
y (Union[int, float]) – y value of the sphere center. Default is 0.
z (Union[int, float]) – z value of the sphere center. Default is 0.
radius (Union[int, float]) – radius for creating the sphere. Default is 1.

property radius#

Attribute to set or get the radius of the sphere.

Getter:: Gets the radius of the sphere.
Setter:: Sets the radius of the sphere.
Type:: Union[int, float]

property x#

Attribute to set or get the x co-ordinate of the sphere.

Getter:: Gets the x value of the sphere center.
Setter:: Sets the x value of the sphere center.
Type:: Union[int, float]

property y#

Attribute to set or get the y co-ordinate of the sphere.

Getter:: Gets the y value of the sphere center.
Setter:: Sets the y value of the sphere center
Type:: Union[int, float]

property z#

Attribute to set or get the z co-ordinate of the sphere.

Getter:: Gets the z value of the sphere center.
Setter:: Sets the z value of the sphere center
Type:: Union[int, float]

LegendScalar class#

class LegendScalar(resType: ResultPlotType | None = None, model=None, window: Window | None = None, page: Page | None = None, **kwargs)#

Bases: Legend

A class representing Legend Scalar.

Parameters:

model (Union[Model, int, str]) – Model for the legend scalar. Default is active model.
window (Union[Window, int]) – Window for the legend scalar. Default is active window.
page (Union[Page, int, str]) – Page for the legend scalar. Default is active page.
kwargs (dict) – To set the other attributes of LegendScalar class.

getBoundingBox()#

Method to get the bounding box of the legend.

Returns:: Bounding box.
Return type:: dict

getCategoryLabel(level_index: int = 0)#

Method to get the category label of level in legend.

Parameters:: level_index (int) – level index.
Returns:: category label.
Return type:: str

getCategoryLabelList()#

Method to get the category label list of the legend.

Returns:: Bounding box.
Return type:: list

getLevelColor(level_index: int = 0)#

Method to get the level color of the legend.

Parameters:: level_index (int) – Level index.
Returns:: Level index color.
Return type:: Color

getLevelValue(level_index: int = 0)#

Method to get the level value of the legend.

Parameters:: level_index (int) – Level index.
Returns:: Level legend value.
Return type:: int

interpolate(lower_index: int = 0, upper_index: int = 0)#

Method to interpolate level colors of the legend.

Parameters:

lower_index (int) – Lower level index.
lower_index – Upper level index.

resetLevelValue(level_index: int = 0)#

Method to reset level value of the legend.

Parameters:: level_index (int) – Level index.

setAttributes(**kwargs)#

Method to set the Legend attributes.

Parameters:: kwargs (dict) – attributes

setLevelColor(level_index: Any = 0, level_color: Any | None = None)#

Method to set the level color of the legend.

Parameters:

level_index (Union[int, list]) – level index.
level_color (Union[Color, list, tuple]) – level color.

setLevelValue(level_index: Any = 0, level_value: Any | None = None)#

Method to set the level value of the legend.

Parameters:

level_index (Union[int, list]) – level index.
level_value (Union[int, float]) – level value.

property backgroundColor#

Attribute to set or get background color of the legend.

Getter:: Gets the background color of the legend.
Setter:: Sets the background color of the legend.
Type:: Color

property discreteColors#

Attribute to set or get the discrete colors option of the scalar legend.

Getter:: Gets the discrete colors option of the scalar legend.
Setter:: Sets the discrete colors option of the scalar legend.
Type:: bool

property footerFont#

Attribute to set or get the footer font of the legend.

Getter:: Gets the footer font of the legend.
Setter:: Sets the footer font of the legend.
Type:: Font

property footerText#

Attribute to set or get footer text of the legend.

Getter:: Gets the footer text of the legend.
Setter:: Sets the footer text of the legend.
Type:: str

property footerVisible#

Attribute to set or get footer visibility.

Getter:: Gets the footer visibility of legend.
Setter:: Sets the footer visibility of legend.
Type:: bool

property headerFont#

Attribute to set or get the header font of the legend.

Getter:: Gets the header font of the legend.
Setter:: Sets the header font of the legend.
Type:: Font

property headerText#

Attribute to set or get header text of the legend.

Getter:: Gets the header text of the legend.
Setter:: Sets the header text of the legend.
Type:: str

property headerVisible#

Attribute to set or get header visibility.

Getter:: Gets the header visibility of legend.
Setter:: Sets the header visibility of legend.
Type:: bool

property interpolateColors#

Attribute to set or get the interpolate colors option of the scalar legend.

Getter:: Gets the interpolate colors option of the scalar legend.
Setter:: Sets the interpolate colors option of the scalar legend.
Type:: bool

property interpolation#

Attribute to set or get the interpolation of the legend. Available options are log and linear.

Getter:: Gets the interpolation of the legend.
Setter:: Sets the interpolation of the legend.
Type:: str

property maxValue#

Attribute to set or get the max value of the legend.

Getter:: Gets the maximum value of the legend.
Setter:: Sets the maximum value of the legend.
Type:: float

property minValue#

Attribute to set or get the minimum value of the legend.

Getter:: Gets the minimum value of the legend.
Setter:: Sets the minimum value of the legend.
Type:: float

property model#

Attribute to get the model of the Legend.

Getter:: Gets model of the Legend.
Type:: Model

property multiplier#

Attribute to set or get the multiplier value of the legend.

Getter:: Gets the multiplier value of the legend.
Setter:: Sets the multiplier value of the legend.
Type:: float

property numberFont#

Attribute to set or get the number font of the legend.

Getter:: Gets the number font of the legend.
Setter:: Sets the number font of the legend.
Type:: Font

property numberOfLevels#

Attribute to set or get number of levels of the legend.

Getter:: Gets the number of levels of the legend.
Setter:: Sets the number of levels of the legend.
Type:: int

property numericFormat#

Attribute to set or get the numeric format of the legend. Available options are auto, fixed, engineering and scientific.

Getter:: Gets the numeric format of the legend.
Setter:: Sets the numeric format of the legend.
Type:: str

property numericPrecision#

Attribute to set or get the numeric precision for legend values.

Getter:: Gets the numeric precision for legend values.
Setter:: Sets the numeric precision for legend values.
Type:: int

property offset#

Attribute to set or get the offset value of the scalar legend.

Getter:: Gets the offset of the scalar legend.
Setter:: Sets the offset of the scalar legend.
Type:: Union[int, float]

property page#

Attribute to get the page of the Legend.

Getter:: Gets page of the Legend.
Type:: Page

property position#

Attribute to set or get position of the legend. Available options are upperleft, upperright, lowerright and lowerleft.

Getter:: Gets the position of the legend.
Setter:: Sets the position of the legend.
Type:: str

property reverse#

Attribute to set or get the reverse option of the legend.

Getter:: Gets the reverse option of the legend.
Setter:: Sets the reverse option of the legend.
Type:: bool

property showByModel#

Attribute to set or get the show by model option of the legend.

Getter:: Gets the show by model option of the legend.
Setter:: Sets the show by model option of the legend.
Type:: bool

property showCategoryID#

Attribute to set or get the show category ID option of the legend.

Getter:: Gets the show category ID option of the legend.
Setter:: Sets the show category ID option of the legend.
Type:: bool

property showEntityLabel#

Attribute to set or get the show entity label option of the legend.

Getter:: Gets the show entity label option of the legend.
Setter:: Sets the show entity label option of the legend.
Type:: bool

property showMax#

Attribute to set or get the show max option of the legend.

Getter:: Gets the show max option of the legend.
Setter:: Sets the show max option of the legend.
Type:: bool

property showMaxLocal#

Attribute to set or get the show max local option of the legend.

Getter:: Gets the show max local option of the legend.
Setter:: Sets the show max local option of the legend.
Type:: bool

property showMin#

Attribute to set or get the show min option of the legend.

Getter:: Gets the show min option of the legend.
Setter:: Sets the show min option of the legend.
Type:: bool

property showMinLocal#

Attribute to set or get the show min local option of the legend.

Getter:: Gets the show min local option of the legend.
Setter:: Sets the show min local option of the legend.
Type:: bool

property style#

Attribute to set or get style of the legend. Available options are category and numeric.

Getter:: Gets the style of the legend.
Setter:: Sets the style of the legend.
Type:: str

property thresholdMax#

Attribute to set or get the threshold max option of the legend.

Getter:: Gets the threshold max of the legend.
Setter:: Sets the threshold max of the legend.
Type:: bool

property thresholdMaxValue#

Attribute to set or get the threshold max value of the legend.

Getter:: Gets the threshold max value of the legend.
Setter:: Sets the threshold max value of the legend.
Type:: float

property thresholdMin#

Attribute to set or get the threshold min option of the legend.

Getter:: Gets the threshold min of the legend.
Setter:: Sets the threshold min of the legend.
Type:: bool

property thresholdMinValue#

Attribute to set or get the threshold min value of the legend.

Getter:: Gets the threshold min value of the legend.
Setter:: Sets the threshold min value of the legend.
Type:: float

property titleFont#

Attribute to set or get the title font of the legend.

Getter:: Gets the title font of the legend.
Setter:: Sets the title font of the legend.
Type:: Font

property titleText#

Attribute to get title text of the legend.

Getter:: Gets the title text of the legend.
Type:: str

property titleVisible#

Attribute to set or get title visibility.

Getter:: Gets the title visibility of legend.
Setter:: Sets the title visibility of legend.
Type:: bool

property transparency#

Attribute to set or get the transparency of the legend.

Getter:: Gets the transparency of the legend.
Setter:: Sets the transparency of the legend.
Type:: bool

property type#

Attribute to set or get type of the legend. Available options are dynamic and fixed.

Getter:: Gets the type of the legend.
Setter:: Sets the type of the legend.
Type:: str

property visibility#

Attribute to set or get the visibility of the legend.

Getter:: Gets the visibility of the legend.
Setter:: Sets the visibility of the legend.
Type:: bool

property window#

Attribute to get the window of the Legend.

Getter:: Gets window of the Legend.
Type:: Window

LegendTensor class#

class LegendTensor(resType: ResultPlotType | None = None, model=None, window: Window | None = None, page: Page | None = None, **kwargs)#

Bases: Legend

A class representing Legend Tensor.

Parameters:

model (Union[Model,int,str]) – Model for the legend tensor. Default is active model.
window (Union[Window,int]) – Window for the legend tensor. Default is active window.
page (Union[Page,int,str]) – Page for the legend tensor. Default is active page.
kwargs (dict) – To set the other attributes of LegendTensor class.

getBoundingBox()#

Method to get the bounding box of the legend.

Returns:: Bounding box.
Return type:: dict

getCategoryLabel(level_index: int = 0)#

Method to get the category label of level in legend.

Parameters:: level_index (int) – level index.
Returns:: category label.
Return type:: str

getCategoryLabelList()#

Method to get the category label list of the legend.

Returns:: Bounding box.
Return type:: list

getLevelColor(level_index: int = 0)#

Method to get the level color of the legend.

Parameters:: level_index (int) – Level index.
Returns:: Level index color.
Return type:: Color

getLevelValue(level_index: int = 0)#

Method to get the level value of the legend.

Parameters:: level_index (int) – Level index.
Returns:: Level legend value.
Return type:: int

interpolate(lower_index: int = 0, upper_index: int = 0)#

Method to interpolate level colors of the legend.

Parameters:

lower_index (int) – Lower level index.
lower_index – Upper level index.

resetLevelValue(level_index: int = 0)#

Method to reset level value of the legend.

Parameters:: level_index (int) – Level index.

setAttributes(**kwargs)#

Method to set the Legend attributes.

Parameters:: kwargs (dict) – attributes

setLevelColor(level_index: Any = 0, level_color: Any | None = None)#

Method to set the level color of the legend.

Parameters:

level_index (Union[int, list]) – level index.
level_color (Union[Color, list, tuple]) – level color.

setLevelValue(level_index: Any = 0, level_value: Any | None = None)#

Method to set the level value of the legend.

Parameters:

level_index (Union[int, list]) – level index.
level_value (Union[int, float]) – level value.

property backgroundColor#

Attribute to set or get background color of the legend.

Getter:: Gets the background color of the legend.
Setter:: Sets the background color of the legend.
Type:: Color

property footerFont#

Attribute to set or get the footer font of the legend.

Getter:: Gets the footer font of the legend.
Setter:: Sets the footer font of the legend.
Type:: Font

property footerText#

Attribute to set or get footer text of the legend.

Getter:: Gets the footer text of the legend.
Setter:: Sets the footer text of the legend.
Type:: str

property footerVisible#

Attribute to set or get footer visibility.

Getter:: Gets the footer visibility of legend.
Setter:: Sets the footer visibility of legend.
Type:: bool

property headerFont#

Attribute to set or get the header font of the legend.

Getter:: Gets the header font of the legend.
Setter:: Sets the header font of the legend.
Type:: Font

property headerText#

Attribute to set or get header text of the legend.

Getter:: Gets the header text of the legend.
Setter:: Sets the header text of the legend.
Type:: str

property headerVisible#

Attribute to set or get header visibility.

Getter:: Gets the header visibility of legend.
Setter:: Sets the header visibility of legend.
Type:: bool

property interpolation#

Attribute to set or get the interpolation of the legend. Available options are log and linear.

Getter:: Gets the interpolation of the legend.
Setter:: Sets the interpolation of the legend.
Type:: str

property maxValue#

Attribute to set or get the max value of the legend.

Getter:: Gets the maximum value of the legend.
Setter:: Sets the maximum value of the legend.
Type:: float

property minValue#

Attribute to set or get the minimum value of the legend.

Getter:: Gets the minimum value of the legend.
Setter:: Sets the minimum value of the legend.
Type:: float

property model#

Attribute to get the model of the Legend.

Getter:: Gets model of the Legend.
Type:: Model

property multiplier#

Attribute to set or get the multiplier value of the legend.

Getter:: Gets the multiplier value of the legend.
Setter:: Sets the multiplier value of the legend.
Type:: float

property numberFont#

Attribute to set or get the number font of the legend.

Getter:: Gets the number font of the legend.
Setter:: Sets the number font of the legend.
Type:: Font

property numberOfLevels#

Attribute to set or get number of levels of the legend.

Getter:: Gets the number of levels of the legend.
Setter:: Sets the number of levels of the legend.
Type:: int

property numericFormat#

Attribute to set or get the numeric format of the legend. Available options are auto, fixed, engineering and scientific.

Getter:: Gets the numeric format of the legend.
Setter:: Sets the numeric format of the legend.
Type:: str

property numericPrecision#

Attribute to set or get the numeric precision for legend values.

Getter:: Gets the numeric precision for legend values.
Setter:: Sets the numeric precision for legend values.
Type:: int

property page#

Attribute to get the page of the Legend.

Getter:: Gets page of the Legend.
Type:: Page

property position#

Attribute to set or get position of the legend. Available options are upperleft, upperright, lowerright and lowerleft.

Getter:: Gets the position of the legend.
Setter:: Sets the position of the legend.
Type:: str

property reverse#

Attribute to set or get the reverse option of the legend.

Getter:: Gets the reverse option of the legend.
Setter:: Sets the reverse option of the legend.
Type:: bool

property showByModel#

Attribute to set or get the show by model option of the legend.

Getter:: Gets the show by model option of the legend.
Setter:: Sets the show by model option of the legend.
Type:: bool

property showCategoryID#

Attribute to set or get the show category ID option of the legend.

Getter:: Gets the show category ID option of the legend.
Setter:: Sets the show category ID option of the legend.
Type:: bool

property showEntityLabel#

Attribute to set or get the show entity label option of the legend.

Getter:: Gets the show entity label option of the legend.
Setter:: Sets the show entity label option of the legend.
Type:: bool

property showMax#

Attribute to set or get the show max option of the legend.

Getter:: Gets the show max option of the legend.
Setter:: Sets the show max option of the legend.
Type:: bool

property showMaxLocal#

Attribute to set or get the show max local option of the legend.

Getter:: Gets the show max local option of the legend.
Setter:: Sets the show max local option of the legend.
Type:: bool

property showMin#

Attribute to set or get the show min option of the legend.

Getter:: Gets the show min option of the legend.
Setter:: Sets the show min option of the legend.
Type:: bool

property showMinLocal#

Attribute to set or get the show min local option of the legend.

Getter:: Gets the show min local option of the legend.
Setter:: Sets the show min local option of the legend.
Type:: bool

property style#

Attribute to set or get style of the legend. Available options are category and numeric.

Getter:: Gets the style of the legend.
Setter:: Sets the style of the legend.
Type:: str

property thresholdMax#

Attribute to set or get the threshold max option of the legend.

Getter:: Gets the threshold max of the legend.
Setter:: Sets the threshold max of the legend.
Type:: bool

property thresholdMaxValue#

Attribute to set or get the threshold max value of the legend.

Getter:: Gets the threshold max value of the legend.
Setter:: Sets the threshold max value of the legend.
Type:: float

property thresholdMin#

Attribute to set or get the threshold min option of the legend.

Getter:: Gets the threshold min of the legend.
Setter:: Sets the threshold min of the legend.
Type:: bool

property thresholdMinValue#

Attribute to set or get the threshold min value of the legend.

Getter:: Gets the threshold min value of the legend.
Setter:: Sets the threshold min value of the legend.
Type:: float

property titleFont#

Attribute to set or get the title font of the legend.

Getter:: Gets the title font of the legend.
Setter:: Sets the title font of the legend.
Type:: Font

property titleText#

Attribute to get title text of the legend.

Getter:: Gets the title text of the legend.
Type:: str

property titleVisible#

Attribute to set or get title visibility.

Getter:: Gets the title visibility of legend.
Setter:: Sets the title visibility of legend.
Type:: bool

property transparency#

Attribute to set or get the transparency of the legend.

Getter:: Gets the transparency of the legend.
Setter:: Sets the transparency of the legend.
Type:: bool

property type#

Attribute to set or get type of the legend. Available options are dynamic and fixed.

Getter:: Gets the type of the legend.
Setter:: Sets the type of the legend.
Type:: str

property visibility#

Attribute to set or get the visibility of the legend.

Getter:: Gets the visibility of the legend.
Setter:: Sets the visibility of the legend.
Type:: bool

property window#

Attribute to get the window of the Legend.

Getter:: Gets window of the Legend.
Type:: Window

LegendVector class#

class LegendVector(resType: ResultPlotType | None = None, model=None, window: Window | None = None, page: Page | None = None, **kwargs)#

Bases: Legend

A class representing Legend Vector.

Parameters:

model (Union[Model, int, str]) – Model for the legend vector. Default is active model.
window (Union[Window, int]) – Window for the legend vector. Default is active window.
page (Union[Page, int, str]) – Page for the legend vector. Default is active page.
kwargs (dict) – To set the other attributes of LegendVector class.

getBoundingBox()#

Method to get the bounding box of the legend.

Returns:: Bounding box.
Return type:: dict

getCategoryLabel(level_index: int = 0)#

Method to get the category label of level in legend.

Parameters:: level_index (int) – level index.
Returns:: category label.
Return type:: str

getCategoryLabelList()#

Method to get the category label list of the legend.

Returns:: Bounding box.
Return type:: list

getLevelColor(level_index: int = 0)#

Method to get the level color of the legend.

Parameters:: level_index (int) – Level index.
Returns:: Level index color.
Return type:: Color

getLevelValue(level_index: int = 0)#

Method to get the level value of the legend.

Parameters:: level_index (int) – Level index.
Returns:: Level legend value.
Return type:: int

interpolate(lower_index: int = 0, upper_index: int = 0)#

Method to interpolate level colors of the legend.

Parameters:

lower_index (int) – Lower level index.
lower_index – Upper level index.

resetLevelValue(level_index: int = 0)#

Method to reset level value of the legend.

Parameters:: level_index (int) – Level index.

setAttributes(**kwargs)#

Method to set the Legend attributes.

Parameters:: kwargs (dict) – attributes

setLevelColor(level_index: Any = 0, level_color: Any | None = None)#

Method to set the level color of the legend.

Parameters:

level_index (Union[int, list]) – level index.
level_color (Union[Color, list, tuple]) – level color.

setLevelValue(level_index: Any = 0, level_value: Any | None = None)#

Method to set the level value of the legend.

Parameters:

level_index (Union[int, list]) – level index.
level_value (Union[int, float]) – level value.

property backgroundColor#

Attribute to set or get background color of the legend.

Getter:: Gets the background color of the legend.
Setter:: Sets the background color of the legend.
Type:: Color

property footerFont#

Attribute to set or get the footer font of the legend.

Getter:: Gets the footer font of the legend.
Setter:: Sets the footer font of the legend.
Type:: Font

property footerText#

Attribute to set or get footer text of the legend.

Getter:: Gets the footer text of the legend.
Setter:: Sets the footer text of the legend.
Type:: str

property footerVisible#

Attribute to set or get footer visibility.

Getter:: Gets the footer visibility of legend.
Setter:: Sets the footer visibility of legend.
Type:: bool

property headerFont#

Attribute to set or get the header font of the legend.

Getter:: Gets the header font of the legend.
Setter:: Sets the header font of the legend.
Type:: Font

property headerText#

Attribute to set or get header text of the legend.

Getter:: Gets the header text of the legend.
Setter:: Sets the header text of the legend.
Type:: str

property headerVisible#

Attribute to set or get header visibility.

Getter:: Gets the header visibility of legend.
Setter:: Sets the header visibility of legend.
Type:: bool

property interpolation#

Attribute to set or get the interpolation of the legend. Available options are log and linear.

Getter:: Gets the interpolation of the legend.
Setter:: Sets the interpolation of the legend.
Type:: str

property maxValue#

Attribute to set or get the max value of the legend.

Getter:: Gets the maximum value of the legend.
Setter:: Sets the maximum value of the legend.
Type:: float

property minValue#

Attribute to set or get the minimum value of the legend.

Getter:: Gets the minimum value of the legend.
Setter:: Sets the minimum value of the legend.
Type:: float

property model#

Attribute to get the model of the Legend.

Getter:: Gets model of the Legend.
Type:: Model

property multiplier#

Attribute to set or get the multiplier value of the legend.

Getter:: Gets the multiplier value of the legend.
Setter:: Sets the multiplier value of the legend.
Type:: float

property numberFont#

Attribute to set or get the number font of the legend.

Getter:: Gets the number font of the legend.
Setter:: Sets the number font of the legend.
Type:: Font

property numberOfLevels#

Attribute to set or get number of levels of the legend.

Getter:: Gets the number of levels of the legend.
Setter:: Sets the number of levels of the legend.
Type:: int

property numericFormat#

Attribute to set or get the numeric format of the legend. Available options are auto, fixed, engineering and scientific.

Getter:: Gets the numeric format of the legend.
Setter:: Sets the numeric format of the legend.
Type:: str

property numericPrecision#

Attribute to set or get the numeric precision for legend values.

Getter:: Gets the numeric precision for legend values.
Setter:: Sets the numeric precision for legend values.
Type:: int

property page#

Attribute to get the page of the Legend.

Getter:: Gets page of the Legend.
Type:: Page

property position#

Attribute to set or get position of the legend. Available options are upperleft, upperright, lowerright and lowerleft.

Getter:: Gets the position of the legend.
Setter:: Sets the position of the legend.
Type:: str

property reverse#

Attribute to set or get the reverse option of the legend.

Getter:: Gets the reverse option of the legend.
Setter:: Sets the reverse option of the legend.
Type:: bool

property showByModel#

Attribute to set or get the show by model option of the legend.

Getter:: Gets the show by model option of the legend.
Setter:: Sets the show by model option of the legend.
Type:: bool

property showCategoryID#

Attribute to set or get the show category ID option of the legend.

Getter:: Gets the show category ID option of the legend.
Setter:: Sets the show category ID option of the legend.
Type:: bool

property showEntityLabel#

Attribute to set or get the show entity label option of the legend.

Getter:: Gets the show entity label option of the legend.
Setter:: Sets the show entity label option of the legend.
Type:: bool

property showMax#

Attribute to set or get the show max option of the legend.

Getter:: Gets the show max option of the legend.
Setter:: Sets the show max option of the legend.
Type:: bool

property showMaxLocal#

Attribute to set or get the show max local option of the legend.

Getter:: Gets the show max local option of the legend.
Setter:: Sets the show max local option of the legend.
Type:: bool

property showMin#

Attribute to set or get the show min option of the legend.

Getter:: Gets the show min option of the legend.
Setter:: Sets the show min option of the legend.
Type:: bool

property showMinLocal#

Attribute to set or get the show min local option of the legend.

Getter:: Gets the show min local option of the legend.
Setter:: Sets the show min local option of the legend.
Type:: bool

property style#

Attribute to set or get style of the legend. Available options are category and numeric.

Getter:: Gets the style of the legend.
Setter:: Sets the style of the legend.
Type:: str

property thresholdMax#

Attribute to set or get the threshold max option of the legend.

Getter:: Gets the threshold max of the legend.
Setter:: Sets the threshold max of the legend.
Type:: bool

property thresholdMaxValue#

Attribute to set or get the threshold max value of the legend.

Getter:: Gets the threshold max value of the legend.
Setter:: Sets the threshold max value of the legend.
Type:: float

property thresholdMin#

Attribute to set or get the threshold min option of the legend.

Getter:: Gets the threshold min of the legend.
Setter:: Sets the threshold min of the legend.
Type:: bool

property thresholdMinValue#

Attribute to set or get the threshold min value of the legend.

Getter:: Gets the threshold min value of the legend.
Setter:: Sets the threshold min value of the legend.
Type:: float

property titleFont#

Attribute to set or get the title font of the legend.

Getter:: Gets the title font of the legend.
Setter:: Sets the title font of the legend.
Type:: Font

property titleText#

Attribute to get title text of the legend.

Getter:: Gets the title text of the legend.
Type:: str

property titleVisible#

Attribute to set or get title visibility.

Getter:: Gets the title visibility of legend.
Setter:: Sets the title visibility of legend.
Type:: bool

property transparency#

Attribute to set or get the transparency of the legend.

Getter:: Gets the transparency of the legend.
Setter:: Sets the transparency of the legend.
Type:: bool

property type#

Attribute to set or get type of the legend. Available options are dynamic and fixed.

Getter:: Gets the type of the legend.
Setter:: Sets the type of the legend.
Type:: str

property visibility#

Attribute to set or get the visibility of the legend.

Getter:: Gets the visibility of the legend.
Setter:: Sets the visibility of the legend.
Type:: bool

property window#

Attribute to get the window of the Legend.

Getter:: Gets window of the Legend.
Type:: Window

Model class#

Bases: object

A class representing the Model.

Parameters:

model (Union[Model, int]) – Model. Default is active model
page (Union[Page, int, str]) – Page in which the model is present. Default is the active page.
window (Union[Window, int]) – Window in which the model is present. Default is the active window.
id (int) – Model ID.

delete(entity, objOrId: list | str)#

Method to delete an entity collection

Parameters:

entity (Collection) – Entity like Collection
objOrId (Union[Collection, list, str]) – Collection object, list of objects or all.

get(tag, id_or_lab, pool=None)#

Method to get the entity like Element, Node, Part, PartSet, PartAssembly.

Parameters:

tag (Union[Element, Node, Part, PartSet, PartAssembly]) – Entity class, like Element, Node, Part, PartSet, PartAssembly.
id_or_lab (int) – level index.
pool (str) – Pool of the Entity. Default is None.

Returns:

Requested entity object.

Return type:

Union[Element, Node, Part, PartSet, PartAssembly]

hide(colobj)#

Method to hide the collection

Parameters:: colobj (Union[Element, Node, Part, PartSet, PartAssembly]) – Collection object.

isolate(colobj)#

Method to isolate the collection

Parameters:: colobj (Union[Element, Node, Part, PartSet, PartAssembly]) – Collection object.

show(colobj)#

Method to show the collection

Parameters:: colobj (Union[Element, Node, Part, PartSet, PartAssembly]) – Collection object.

property id#

Attribute to get the model ID.

Getter:: Gets the model ID.
Type:: int

property label#

Attribute to get the model label.

Getter:: Gets the model label.
Type:: str

property page#

Attribute to get the page.

Getter:: Gets the page.
Type:: Page

property window#

Attribute to get the window.

Getter:: Gets the window.
Type:: Window

Node class#

class Node(id, pool=None, model: Model | None = None)#

Bases: Entity

A class representing a Node. Get a Node for the given model. Raises an Exception parameter if it does not point to a valid Node.

Parameters:

id (int) – ID of Node.
pool (str) – The specific pool, default is None.
model (Union[int, str, Model]) – The specific model, default is active model.

property coords#

Attribute to get the coordinates of the Node.

Getter:: Gets coordinates of the Node.
Type:: list

property id#

Attribute to get the ID of the Node.

Getter:: Gets ID of the Node.
Type:: int

property part#

Attribute to get the Part of the Node.

Getter:: Gets Part of the Node.
Type:: Union[Part, list of Part]

property partId#

Attribute to get the part ID of the Node.

Getter:: Gets part id of the Node.
Type:: Union[int, list of int]

property pool#

Attribute to get the pool of the Node.

Getter:: Gets pool of the Node.
Type:: str

Note class#

class Note(window: Window | None = None, page: Page | None = None, id: int = 0, **kwargs)#

Bases: NoteHelper

A class representing Note.

Parameters:

window (Union[Window, int]) – Window for the Note. Default is the active window.
page (Union[Page, int, str]) – Page for the Note. Default is active page.
id (int) – id of the Note. Default is 1.
kwargs (dict) – To set the other attributes of Note class.

getBoundingBox()#

Method to get the bounding box of the Note.

Returns:: Bounding box.
Return type:: dict

getFieldDictionary()#

Method to get the field dictionary of the Note.

Returns:: field dictionary.
Return type:: dict

property alignment#

Attribute to set or get the alignment of the Note. Valid values are ‘left’, ‘right’ or ‘center’.

Getter:: Gets the alignment of the Note.
Setter:: Sets the alignment of the Note.
Type:: str

property attachment#

Attribute to set or get the attachment of the Note.

Getter:: Gets the attachment of the Note.
Setter:: Sets the attachment of the Note.
Type:: str

property attachmentType#

Attribute to set or get the attachment type of the Note. Valid values are ‘window’, ‘node’, ‘element’, ‘coordinate’, ‘part’, ‘system’ or ‘measure’

Getter:: Gets the attachment type of the Note.
Setter:: Sets the attachment type of the Note.
Type:: str

property autoHide#

Attribute to set or get the auto hide attribute of the Note.

Getter:: Gets the auto hide attribute of the Note.
Setter:: Sets the auto hide attribute of the Note.
Type:: bool

property borderColor#

Attribute to set or get border color of the Note.

Getter:: Gets the border color of the Note.
Setter:: Sets the border color of the Note.
Type:: Union[Color, list, tuple]

property borderColorMode#

Attribute to set or get the border color mode of the Note. Valid values ‘user’, ‘component’ or ‘contour’

Getter:: Gets the border color mode of the Note.
Setter:: Sets the border color mode of the Note.
Type:: str

property borderThickness#

Attribute to set or get border thickness of the Note.Valid values are 0,1,2,3 or 4.

Getter:: Gets the border thickness of the Note.
Setter:: Sets the border thickness of the Note.
Type:: int

property fillColor#

Attribute to set or get fill color of the Note.

Getter:: Gets the fill color of the Note.
Setter:: Sets the fill color of the Note.
Type:: Union[Color, list, tuple]

property fillColorMode#

Attribute to set or get the fill color mode of the Note. Valid values ‘user’, ‘component’ or ‘contour’

Getter:: Gets the fill color mode of the Note.
Setter:: Sets the fill color mode of the Note.
Type:: str

property font#

Attribute to set or get the font of the Note.

Getter:: Gets the font of the Note.
Setter:: Sets the font of the Note.
Type:: Font

property fontSize#

Attribute to set or get the font size of the Note.

Getter:: Gets the font size of the Note.
Setter:: Sets the font size of the Note.
Type:: int

property height#

Attribute to get the height of the Note.

Getter:: Gets height of the Note.
Type:: float

property id#

Attribute to get the ID of the Note.

Getter:: Gets ID.
Type:: int

property label#

Attribute to set or get the label of the Note.

Getter:: Gets the label of the Note.
Setter:: Sets the label of the Note.
Type:: str

property moveToEntity#

Attribute to set or get the move to entity attribute of the Note.

Getter:: Gets the move to entity attribute of the Note.
Setter:: Sets the move to entity attribute of the Note.
Type:: bool

property name#

Attribute to set or get the name of the Note.

Getter:: Gets the name of the Note.
Setter:: Sets the name of the Note.
Type:: str

property page#

Attribute to get the page of the Note.

Getter:: Gets page of the Note.
Type:: Page

property position#

Attribute to set or get the position of the Note.

Getter:: Gets the position of the Note.
Setter:: Sets the position of the Note.
Type:: list

property positionType#

Attribute to set or get the position type of the Note. Valid values ‘coordinates’ or ‘screen’

Getter:: Gets the position type of the Note.
Setter:: Sets the position type of the Note.
Type:: str

property rotationAngle#

Attribute to get the rotation angle of the Note.

Getter:: Gets the rotation angle of the Note.
Setter:: Sets the rotation angle of the Note.
Type:: float

property screenAnchor#

Attribute to set or get the screen anchor of the Note.

Getter:: Gets the screen anchor of the Note.
Setter:: Sets the screen anchor of the Note.
Type:: bool

property shape#

Attribute to set or get the shape of the Note. Valid values ‘circle’, ‘ellipse’ or ‘rectangle’

Getter:: Gets the shape of the Note.
Setter:: Sets the shape of the Note.
Type:: str

property text#

Attribute to set or get the text of the Note.

Getter:: Gets the text of the Note.
Setter:: Sets the text of the Note.
Type:: str

property textAsDisplayed#

Attribute to get the expanded text of the Note.

Getter:: Gets expanded text of the Note.
Type:: str

property textColor#

Attribute to set or get text color of the Note.

Getter:: Gets the text color of the Note.
Setter:: Sets the text color of the Note.
Type:: Union[Color, list, tuple]

property textColorMode#

Attribute to set or get the text color mode of the Note. Valid values are ‘user’, ‘maintainContrast’, ‘component’ or ‘contour’.

Getter:: Gets the text color mode of the Note.
Setter:: Sets the text color mode of the Note.
Type:: str

property transparency#

Attribute to set or get the transparency of the Note.

Getter:: Gets the transparency of the Note.
Setter:: Sets the transparency of the Note.
Type:: bool

property visibility#

Attribute to set or get the visibility of the Note.

Getter:: Gets the visibility of the Note.
Setter:: Sets the visibility of the Note.
Type:: bool

property width#

Attribute to get the width of the Note.

Getter:: Gets width of the Note.
Type:: float

property window#

Attribute to get the window of the Note.

Getter:: Gets window of the Note.
Type:: Window

Part class#

class Part(id_or_lab, pool=None, model: Model | None = None)#

Bases: Entity

A class representing a Part (Component). Get a Part of the given model. Raises an Exception parameter if it does not points to a valid Part.

Parameters:

id_or_lab (Union[int, str]) – id or label of the Part.
pool (str) – The specific pool, default is None.
model (Union[int, str, Model]) – The specific model, default is the active model.

setAttributes(**kwargs)#: Method to set the Part attributes.

property color#

Attribute to set or get the color of the Part.

Getter:: Gets the color of the Part.
Setter:: Sets the color of the Part.
Type:: Union[Color, list, tuple]

property id#

Attribute to get the ID of the Part.

Getter:: Gets ID of the Part.
Type:: int

property idVisibility#

Attribute to set or get the ID visibility of the Part.

Getter:: Gets the ID visibility of the Part.
Setter:: Sets the ID visibility of the Part.
Type:: bool

property meshMode#

Attribute to set or get the mesh mode of the Part. Valid options for mesh mode are wireframe, transparent, shadedMeshLines, shadedFeatureLines, shaded.

Getter:: Gets the mesh mode of the Part.
Setter:: Sets the mesh mode of the Part.
Type:: str

property name#

Attribute to get the name of the Part.

Getter:: Gets the name of the Part.
Type:: str

property pool#

Attribute to get the pool of the Part.

Getter:: Gets pool of the Part.
Type:: str

property useInFit#

Attribute to set or get the use In Fit option of the Part.

Getter:: Gets the use In Fit option of the Part.
Setter:: Sets the use In Fit option of the Part.
Type:: bool

property visibility#

Attribute to set or get the visibility of Part.

Getter:: Gets visibility of the Part.
Setter:: Sets visibility of the Part.
Type:: bool

PartAssembly class#

class PartAssembly(id_or_lab, model: Model | None = None)#

Bases: Entity

A class representing a PartAssembly. Get a PartAssembly of the given model. Raises an Exception parameter if it does not point to a valid PartAssembly.

Parameters:

id_or_lab (Union[int, str]) – id or label of PartAssembly.
model (Union[int, str, Model]) – The specific model, default is active model.

setAttributes(**kwargs)#: Method to set the PartAssembly attributes.

property color#

Attribute to get the color of the PartAssembly.

Getter:: Gets the color of the PartAssembly.
Type:: Color object

property componentId#

Attribute to get the componentId of the PartAssembly.

Getter:: Gets component ID of the PartAssembly.
Type:: int

property id#

Attribute to get the id of the PartAssembly.

Getter:: Gets ID of the PartAssembly.
Type:: int

property materialId#

Attribute to get the material ID of the PartAssembly.

Getter:: Gets material ID of the PartAssembly.
Type:: int

property materialName#

Attribute to get the material name of the PartAssembly.

Getter:: Gets material name of the PartAssembly.
Type:: str

property name#

Attribute to get the name of the PartAssembly.

Getter:: Gets the name of the PartAssembly.
Type:: str

property pdmId#

Attribute to get the PDM ID of the PartAssembly.

Getter:: Gets PDM ID of the PartAssembly.
Type:: int

property pdmMaterial#

Attribute to get the PDM material of the PartAssembly.

Getter:: Gets PDM material of the PartAssembly.

property pdmMaterialId#

Attribute to get the PDM material ID of the PartAssembly.

Getter:: Gets PDM material ID of the PartAssembly.
Type:: int

property pdmPropertyId#

Attribute to get the PDM property ID of the PartAssembly.

Getter:: Gets PDM property ID of the PartAssembly.
Type:: int

property pdmRevision#

Attribute to get the PDM revision of the PartAssembly.

Getter:: Gets PDM revision of the PartAssembly.

property pdmThickness#

Attribute to get the PDM thickness of the PartAssembly.

Getter:: Gets PDM thickness of the PartAssembly.

property positionX0Y0Z0#

Attribute to get the positionX0Y0Z0 of the PartAssembly.

Getter:: Gets positionX0Y0Z0 of the PartAssembly.

property positiondX1dY1dZ1#

Attribute to get the positiondX1dY1dZ1 of the PartAssembly.

Getter:: Gets positiondX1dY1dZ1 of the PartAssembly.

property positiondX2dY2dZ2#

Attribute to get the positiondX2dY2dZ2 of the PartAssembly.

Getter:: Gets positiondX2dY2dZ2 of the PartAssembly.

property positiondX3dY3dZ3#

Attribute to get the positiondX3dY3dZ3 of the PartAssembly.

Getter:: Gets positiondX3dY3dZ3 of the PartAssembly.

property propertyId#

Attribute to get the property ID of the PartAssembly.

Getter:: Gets property ID of the PartAssembly.
Type:: int

property representation#

Attribute to get the representation of the PartAssembly.

Getter:: Gets representation of the PartAssembly.

property representationFile#

Attribute to get the representation file of the PartAssembly.

Getter:: Gets representation file of the PartAssembly.

property uId#

Attribute to get the UID of the PartAssembly.

Getter:: Gets UID of the PartAssembly.

property visibility#

Attribute to set or get the visibility of the PartAssembly.

Getter:: Gets the visibility of PartAssembly.
Setter:: Sets the visibility of PartAssembly.
Type:: bool

PartSet class#

class PartSet(id_or_lab, model: Model | None = None)#

Bases: Entity

property id#

Attribute to get the ID of the PartSet.

Getter:: Gets ID of the PartSet.
Type:: int

property name#

Attribute to get the name of the PartSet.

Getter:: Gets name of the PartSet.
Type:: str

Result class#

class Result(model: Model | None = None, page: int | None = None, window: int | None = None, **kwargs)#

Bases: object

A class representing the Result information.

Parameters:

model (Union[Model, int]) – Model. Default is the active model
page (Union[Page, int, str]) – Page in which the model is present. Default is the active page.
window (Union[Window, int]) – Window in which the model is present. Default is the active window.
kwargs (dict) – To set the other attributes of the Result class.

cache(res_def: ResultDefinition | str)#

Method to cache the ResultDefinition

Parameters:: res_def (Union[ResultDefinitionScalar, ResultDefinitionIso]) – ResultDefinition object, list or string value all.

clearIso(res_def=None)#

Method to clear the iso plotted result

Parameters:: res_def (Union[ResultDefinitionScalar, ResultDefinitionIso]) – ResultDefinitionScalar or ResultDefinitionIso object

clearPlot(res_def: ResultDefinition)#

Method to clear the plotted result

Parameters:: res_def (Union[ResultDefinitionScalar, ResultDefinitionVector, ResultDefinitionTensor]) – ResultDefinitionScalar, ResultDefinitionVector, ResultDefinitionTensor object.

getDataComponents(datatype: str, subcase: int | str | None = None)#

Method to get the data components of the subcase.

Parameters:

datatype (str) – Datatype.
subcase (Union[int,str]) – Subcase.

Returns:

Data components.

Return type:

list

getDataTypeBinding(datatype: str, subcase: int | str | None = None)#

Method to get the data type binding of the subcase.

Parameters:

datatype (str) – Datatype.
subcase (Union[int,str])) – Subcase.

Returns:

Data type binding.

Return type:

str

getDataTypeFormat(datatype: str, subcase: int | str | None = None)#

Method to get the data type format of the subcase.

Parameters:

datatype (str) – Datatype.
subcase (Union[int,str]) – Subcase.

Returns:

Data type format.

Return type:

str

getDataTypes(subcase: int | str | None = None, context: str = 0)#

Method to get the data types of the subcase.

Parameters:

subcase (Union[int,str]) – Subcase.
context (str) – Default is scalar context.

Returns:

Data type list.

Return type:

list

getSimulationIds(subid: int | None = None)#

Method to get the simulation ID list.

Parameters:: subid (int) – Subcase ID
Returns:: Simulation ID list.
Return type:: list.

getSimulationLabel(subid: int, simid: int)#

Method to get the simulation label

Parameters:

subid (int) – Subcase ID.
simid (int) – Simulation ID.

Returns:

Simulation label.

Return type:

str

getSimulationLabels(subid: int | None = None)#

Method to get the simulation label list.

Parameters:: subid (int) – Subcase ID
Returns:: Simulation label list.
Return type:: list.

getSubcaseIds()#

Method to get the subcase ID list.

Returns:: Subcase id list.
Return type:: list.

getSubcaseLabels()#

Method to get the subcase label list.

Returns:: Subcase label list.
Return type:: list.

getTag()#: Method to get page,window,model string format

Method to load the simulation.

Parameters:

subcase (Union[int, list, range, str]) – Subcase ID, list, range or one of string options first, last, and all.
frame (Union[int, list, range, str]) – Simulation ID,list, range or one of string options first, last, and all.

plot(res_def: ResultDefinition, waitTillLoaded: bool = False)#

Method to plot the result

Parameters:

res_def (Union[ResultDefinitionScalar, ResultDefinitionVector, ResultDefinitionTensor]) – Scalar,Vector,Tensor ResultDefinition object
waitTillLoaded (bool) – Flag to wait till load result. Valid in Multi-Core profile.

plotIso(res_def: ResultDefinition)#

Method to plot the iso result

Parameters:: res_def (ResultDefinitionIso object.) – Iso ResultDefinition object

setAttributes(**kwargs)#

Method to set the Result attributes.

Parameters:: kwargs (dict) – attributes

uncache(res_def: ResultDefinition)#

Method to uncache the ResultDefinition

Parameters:: res_def (Union[ResultDefinitionScalar, ResultDefinitionIso]) – ResultDefinition object, list or string value all.

Method to unload the simulation.

Parameters:

subcase (Union[int, list, range, str]) – Subcase ID, list, range or one of string options first*, last, and all.
frame (Union[int, list, range, str]) – Simulation ID, list, range or one of string options first*, last, and all.

update(res_def: ResultDefinition)#

Method to update the ResultDefinition

Parameters:: res_def (Union[ResultDefinitionScalar, ResultDefinitionIso]) – ResultDefinition object, list or string value all.

property model#

Attribute to get the model of the Result.

Getter:: Gets model of the Result.
Type:: Model

property page#

Attribute to get the page of the Result.

Getter:: Gets page of the Result.
Type:: Page

property simulation#

Attribute to set or get the current simulation. Supports referencing by ID, label or using last for the last simulation step.

Getter:: Gets the current simulation.
Setter:: Sets the current simulation.
Type:: Union[int, str]

property subcase#

Attribute to set or get the current subcase.

Getter:: Gets the current subcase.
Setter:: Sets the current subcase.
Type:: int

property window#

Attribute to get the window of the Result.

Getter:: Gets window of the Result.
Type:: Window

ResultDefinitionIso class#

class ResultDefinitionIso(type: ResultPlotType | None = None, model=None, window: Window | None = None, page: Page | None = None, id: int = 1, label: str | None = None, **kwargs)#

Bases: ResultDefinitionScalar

A class representing the ResultDefinitionIso.

Parameters:

model (Union[Model, int, str]) – Model for the ResultDefinitionIso. Default is the active model.
window (Union[Window, int]) – Window for the ResultDefinitionIso. Default is the active window.
page (Union[Page, int, str]) – Page for the ResultDefinitionIso. Default is the active page.
id (int) – ResultDefinitionIso ID. Default is 1.
label (str) – ResultDefinitionIso label.
kwargs (dict) – To set the other attributes of the ResultDefinitionIso class.

display()#: Method to plot the result definition like ResultDefinitionScalar, ResultDefinitionVector and ResultDefinitionTensor

setAttributes(**kwargs)#

Method to set the ResultDefinition attributes.

Parameters:: kwargs (dict) – attributes

property averageAcrossBoundaries#

Attribute to set or get the averageAcrossBoundaries of the ResultDefinitionScalar.

Getter:: Gets the averageAcrossBoundaries of the ResultDefinitionScalar.
Setter:: Sets the averageAcrossBoundaries of the ResultDefinitionScalar.
Type:: bool

property averageFactor#

Attribute to set or get the averageFactor of the ResultDefinitionScalar.

Getter:: Gets the averageFactor of the ResultDefinitionScalar.
Setter:: Sets the averageFactor of the ResultDefinitionScalar.
Type:: bool

property averageFeatureangle#

Attribute to set or get the averageFeatureangle of the ResultDefinitionScalar.

Getter:: Gets the averageFeatureangle of the ResultDefinitionScalar.
Setter:: Sets the averageFeatureangle of the ResultDefinitionScalar.
Type:: bool

property averageMode#

Attribute to set or get the averageMode of the ResultDefinitionScalar. Available options are none, simple, maximum, minimum, advanced and difference.

Getter:: Gets the averageMode of the ResultDefinitionScalar.
Setter:: Sets the averageMode of the ResultDefinitionScalar.
Type:: str

property cached#

Attribute to get the status of the ResultDefinition, cached or uncached.

Getter:: Gets if ResultDefinition is cached or uncached.
Type:: bool

property collection#

Attribute to set or get the collection for the ResultDefinition.

Getter:: Gets the collection for the ResultDefinition.
Setter:: Sets the collection for the ResultDefinition.
Type:: Collection object

property complexFilter#

Attribute to set or get the complexFilter of the ResultDefinitionScalar. Available options are mag * cos(wt-phase), mag * cos(wt+phase), mag, phase, real and imaginary.

Getter:: Gets the complexFilter of the ResultDefinitionScalar.
Setter:: Sets the complexFilter of the ResultDefinitionScalar.
Type:: str

property cornerData#

Attribute to set or get the cornerData of the ResultDefinition.

Getter:: Gets the cornerData of the ResultDefinition.
Setter:: Sets the cornerData of the ResultDefinition.
Type:: bool

property dataComponent#

Attribute to set or get the dataComponent of the ResultDefinitionScalar.

Getter:: Gets the dataComponent of the ResultDefinitionScalar.
Setter:: Sets the dataComponent of the ResultDefinitionScalar.
Type:: str

property dataType#

Attribute to set or get the dataType of the ResultDefinition.

Getter:: Gets the dataType of the ResultDefinition.
Setter:: Sets the dataType of the ResultDefinition.
Type:: str

property envelopeTraceplot#

Attribute to set or get the envelopeTraceplot of the ResultDefinitionScalar. Available options are none, subcase and simulation. Default is none.

Getter:: Gets the envelopeTraceplot of the ResultDefinitionScalar.
Setter:: Sets the envelopeTraceplot of the ResultDefinitionScalar.
Type:: str

property featureAngle#

Attribute to set or get the featureAngle of the ResultDefinitionScalar.

Getter:: Gets the featureAngle of the ResultDefinitionScalar.
Setter:: Sets the featureAngle of the ResultDefinitionScalar.
Type:: float

property filterMode#

Attribute to set or get the filterMode of the ResultDefinitionScalar. Available options are none, below, above, range. Default is none.

Getter:: Gets the filterMode of the ResultDefinitionScalar.
Setter:: Sets the filterMode of the ResultDefinitionScalar.
Type:: str

property filterValue#

Attribute to set or get the filterValue of the ResultDefinitionScalar.

Getter:: Gets the filterValue of the ResultDefinitionScalar.
Setter:: Sets the filterValue of the ResultDefinitionScalar.
Type:: str

property id#

Attribute to get the ID of the ResultDefinition.

Getter:: Gets ID.
Type:: int

property ignoreFlippedNormals#

Attribute to set or get the ignoreFlippedNormals of the ResultDefinitionScalar.

Getter:: Gets the ignoreFlippedNormals of the ResultDefinitionScalar.
Setter:: Sets the ignoreFlippedNormals of the ResultDefinitionScalar.
Type:: bool

property label#

Attribute to set or get the label of the ResultDefinition.

Getter:: Gets the label of the ResultDefinition.
Setter:: Sets the label of the ResultDefinition.
Type:: str

property layer#

Attribute to set or get the layer of the ResultDefinition.

Getter:: Gets the layer of the ResultDefinition.
Setter:: Sets the layer of the ResultDefinition.
Type:: str

property layerFilter#

Attribute to set or get the layer filter of the ResultDefinition.

Getter:: Gets the layerFilter of the ResultDefinition.
Setter:: Sets the layerFilter of the ResultDefinition.
Type:: int

property model#

Attribute to get the model of the ResultDefinition.

Getter:: Gets model of the ResultDefinition.
Type:: Model

property page#

Attribute to get the page of the ResultDefinition.

Getter:: Gets page of the ResultDefinition.
Type:: Page

property projectionRule#

Attribute to set or get the projectionRule of the ResultDefinitionScalar. Available options are none, xy, xz, yx, yz, zx and zy.

Getter:: Gets the projectionRule of the ResultDefinitionScalar.
Setter:: Sets the projectionRule of the ResultDefinitionScalar.
Type:: str

property resultType#

Attribute to get the ID of the ResultDefinition type.

Getter:: Gets ResultDefinition type like scalar, vector, tensor and iso.
Type:: str

property showMidnodeResults#

Attribute to set or get the showMidnodeResults of the ResultDefinition.

Getter:: Gets the showMidnodeResults of the ResultDefinition.
Setter:: Sets the showMidnodeResults of the ResultDefinition.
Type:: bool

property system#

Attribute to set or get the system of the ResultDefinition. Available options are analysis, global, elemental, material, ply system, <user_system>.

Getter:: Gets the system of the ResultDefinition.
Setter:: Sets the system of the ResultDefinition.
Type:: str

property topBottom#

Attribute to set or get the topBottom of the ResultDefinitionScalar.

Getter:: Gets the topBottom of the ResultDefinitionScalar.
Setter:: Sets the topBottom of the ResultDefinitionScalar.
Type:: list of string.

property useTracking#

Attribute to set or get the useTracking of the ResultDefinitionScalar.

Getter:: Gets the useTracking of the ResultDefinitionScalar.
Setter:: Sets the useTracking of the ResultDefinitionScalar.
Type:: bool

property variation#

Attribute to set or get the variation of the ResultDefinitionScalar.

Getter:: Gets the variation of the ResultDefinitionScalar.
Setter:: Sets the variation of the ResultDefinitionScalar.
Type:: bool

property window#

Attribute to get the window of the ResultDefinition.

Getter:: Gets window of the ResultDefinition.
Type:: Window

ResultDefinitionScalar class#

class ResultDefinitionScalar(type: ResultPlotType | None = None, model=None, window: Window | None = None, page: Page | None = None, id: int = 1, label: str | None = None, **kwargs)#

Bases: ResultDefinition

A class representing ResultDefinitionScalar.

Parameters:

model (Union[Model, int, str]) – Model for the ResultDefinitionScalar. Default is the active model.
window (Union[Window, int]) – Window for the ResultDefinitionScalar. Default is the active window.
page (Union[Page, int, str]) – Page for the ResultDefinitionScalar. Default is the active page.
id (int) – ResultDefinitionScalar ID. Default is 1.
label (str) – ResultDefinitionScalar label.
kwargs (dict) – To set the other attributes of ResultDefinitionScalar class.

display()#: Method to plot the result definition like ResultDefinitionScalar, ResultDefinitionVector and ResultDefinitionTensor

setAttributes(**kwargs)#

Method to set the ResultDefinition attributes.

Parameters:: kwargs (dict) – attributes

property averageAcrossBoundaries#

Attribute to set or get the averageAcrossBoundaries of the ResultDefinitionScalar.

Getter:: Gets the averageAcrossBoundaries of the ResultDefinitionScalar.
Setter:: Sets the averageAcrossBoundaries of the ResultDefinitionScalar.
Type:: bool

property averageFactor#

Attribute to set or get the averageFactor of the ResultDefinitionScalar.

Getter:: Gets the averageFactor of the ResultDefinitionScalar.
Setter:: Sets the averageFactor of the ResultDefinitionScalar.
Type:: bool

property averageFeatureangle#

Attribute to set or get the averageFeatureangle of the ResultDefinitionScalar.

Getter:: Gets the averageFeatureangle of the ResultDefinitionScalar.
Setter:: Sets the averageFeatureangle of the ResultDefinitionScalar.
Type:: bool

property averageMode#

Attribute to set or get the averageMode of the ResultDefinitionScalar. Available options are none, simple, maximum, minimum, advanced and difference.

Getter:: Gets the averageMode of the ResultDefinitionScalar.
Setter:: Sets the averageMode of the ResultDefinitionScalar.
Type:: str

property cached#

Attribute to get the status of the ResultDefinition, cached or uncached.

Getter:: Gets if ResultDefinition is cached or uncached.
Type:: bool

property collection#

Attribute to set or get the collection for the ResultDefinition.

Getter:: Gets the collection for the ResultDefinition.
Setter:: Sets the collection for the ResultDefinition.
Type:: Collection object

property complexFilter#

Attribute to set or get the complexFilter of the ResultDefinitionScalar. Available options are mag * cos(wt-phase), mag * cos(wt+phase), mag, phase, real and imaginary.

Getter:: Gets the complexFilter of the ResultDefinitionScalar.
Setter:: Sets the complexFilter of the ResultDefinitionScalar.
Type:: str

property cornerData#

Attribute to set or get the cornerData of the ResultDefinition.

Getter:: Gets the cornerData of the ResultDefinition.
Setter:: Sets the cornerData of the ResultDefinition.
Type:: bool

property dataComponent#

Attribute to set or get the dataComponent of the ResultDefinitionScalar.

Getter:: Gets the dataComponent of the ResultDefinitionScalar.
Setter:: Sets the dataComponent of the ResultDefinitionScalar.
Type:: str

property dataType#

Attribute to set or get the dataType of the ResultDefinition.

Getter:: Gets the dataType of the ResultDefinition.
Setter:: Sets the dataType of the ResultDefinition.
Type:: str

property envelopeTraceplot#

Attribute to set or get the envelopeTraceplot of the ResultDefinitionScalar. Available options are none, subcase and simulation. Default is none.

Getter:: Gets the envelopeTraceplot of the ResultDefinitionScalar.
Setter:: Sets the envelopeTraceplot of the ResultDefinitionScalar.
Type:: str

property featureAngle#

Attribute to set or get the featureAngle of the ResultDefinitionScalar.

Getter:: Gets the featureAngle of the ResultDefinitionScalar.
Setter:: Sets the featureAngle of the ResultDefinitionScalar.
Type:: float

property filterMode#

Attribute to set or get the filterMode of the ResultDefinitionScalar. Available options are none, below, above, range. Default is none.

Getter:: Gets the filterMode of the ResultDefinitionScalar.
Setter:: Sets the filterMode of the ResultDefinitionScalar.
Type:: str

property filterValue#

Attribute to set or get the filterValue of the ResultDefinitionScalar.

Getter:: Gets the filterValue of the ResultDefinitionScalar.
Setter:: Sets the filterValue of the ResultDefinitionScalar.
Type:: str

property id#

Attribute to get the ID of the ResultDefinition.

Getter:: Gets ID.
Type:: int

property ignoreFlippedNormals#

Attribute to set or get the ignoreFlippedNormals of the ResultDefinitionScalar.

Getter:: Gets the ignoreFlippedNormals of the ResultDefinitionScalar.
Setter:: Sets the ignoreFlippedNormals of the ResultDefinitionScalar.
Type:: bool

property label#

Attribute to set or get the label of the ResultDefinition.

Getter:: Gets the label of the ResultDefinition.
Setter:: Sets the label of the ResultDefinition.
Type:: str

property layer#

Attribute to set or get the layer of the ResultDefinition.

Getter:: Gets the layer of the ResultDefinition.
Setter:: Sets the layer of the ResultDefinition.
Type:: str

property layerFilter#

Attribute to set or get the layer filter of the ResultDefinition.

Getter:: Gets the layerFilter of the ResultDefinition.
Setter:: Sets the layerFilter of the ResultDefinition.
Type:: int

property model#

Attribute to get the model of the ResultDefinition.

Getter:: Gets model of the ResultDefinition.
Type:: Model

property page#

Attribute to get the page of the ResultDefinition.

Getter:: Gets page of the ResultDefinition.
Type:: Page

property projectionRule#

Attribute to set or get the projectionRule of the ResultDefinitionScalar. Available options are none, xy, xz, yx, yz, zx and zy.

Getter:: Gets the projectionRule of the ResultDefinitionScalar.
Setter:: Sets the projectionRule of the ResultDefinitionScalar.
Type:: str

property resultType#

Attribute to get the ID of the ResultDefinition type.

Getter:: Gets ResultDefinition type like scalar, vector, tensor and iso.
Type:: str

property showMidnodeResults#

Attribute to set or get the showMidnodeResults of the ResultDefinition.

Getter:: Gets the showMidnodeResults of the ResultDefinition.
Setter:: Sets the showMidnodeResults of the ResultDefinition.
Type:: bool

property system#

Attribute to set or get the system of the ResultDefinition. Available options are analysis, global, elemental, material, ply system, <user_system>.

Getter:: Gets the system of the ResultDefinition.
Setter:: Sets the system of the ResultDefinition.
Type:: str

property topBottom#

Attribute to set or get the topBottom of the ResultDefinitionScalar.

Getter:: Gets the topBottom of the ResultDefinitionScalar.
Setter:: Sets the topBottom of the ResultDefinitionScalar.
Type:: list of string.

property useTracking#

Attribute to set or get the useTracking of the ResultDefinitionScalar.

Getter:: Gets the useTracking of the ResultDefinitionScalar.
Setter:: Sets the useTracking of the ResultDefinitionScalar.
Type:: bool

property variation#

Attribute to set or get the variation of the ResultDefinitionScalar.

Getter:: Gets the variation of the ResultDefinitionScalar.
Setter:: Sets the variation of the ResultDefinitionScalar.
Type:: bool

property window#

Attribute to get the window of the ResultDefinition.

Getter:: Gets window of the ResultDefinition.
Type:: Window

ResultDefinitionTensor class#

class ResultDefinitionTensor(type: ResultPlotType | None = None, model=None, window: Window | None = None, page: Page | None = None, id: int = 1, label: str | None = None, **kwargs)#

Bases: ResultDefinition

A class representing the ResultDefinitionTensor.

Parameters:

model (Union[Model, int, str]) – Model for the ResultDefinitionTensor. Default is the active model.
window (Union[Window, int]) – Window for the ResultDefinitionTensor. Default is the active window.
page (Union[Page, int, str]) – Page for the ResultDefinitionTensor. Default is the active page.
id (int) – ResultDefinitionTensor ID. Default is 1.
label (str) – ResultDefinitionTensor label.
kwargs (dict) – To set the other attributes of the ResultDefinitionTensor class.

display()#: Method to plot the result definition like ResultDefinitionScalar, ResultDefinitionVector and ResultDefinitionTensor

getComponentColor(name: str)#

Method to get the data component color of the ResultDefinitionTensor.

Parameters:: name (str) – Name of the Component. Options are xx, yy, zz, xy, yz and zx.

getComponentStatus(cm: Any)#

Method to get the data component display mode of the ResultDefinitionTensor.

Parameters:: name (str) – Name of the data Component.Options are xx, yy, zz, xy, yz and zx.

getPrincipalColor(name: str)#

Method to get the principal data component color of the ResultDefinitionTensor.

Parameters:: name (str) – Name of the principal data component.Options are p1, p2 and p3.

getPrincipalStatus(cm: str)#

Method to get the principal data component display mode of the ResultDefinitionTensor.

Parameters:: name (str) – Name of the principal data Component.Options are p1, p2 and p3.

setAttributes(**kwargs)#

Method to set the ResultDefinition attributes.

Parameters:: kwargs (dict) – attributes

setComponentColor(**kwargs)#

Method to set the data component color of the ResultDefinitionTensor.

Parameters:: kwargs (dict) – Dict of the Name of the Component and color.

setComponentStatus(**kwargs)#

Method to set the data component display mode of the ResultDefinitionTensor.

Parameters:: kwargs (dict) – Dict of the Name of the data component and boolean.

setPrincipalColor(**kwargs)#

Method to set the principal data component color of the ResultDefinitionTensor.

Parameters:: kwargs (dict) – Dict of the Name of the principal data component and color.

setPrincipalStatus(**kwargs)#

Method to set the principal data component display mode of the ResultDefinitionTensor.

Parameters:: kwargs (dict) – Dictionary of the name of the principal data component and boolean value.

property averageAtNode#

Attribute to set or get the averageAtNode of the ResultDefinitionTensor.

Getter:: Gets the averageAtNode of the ResultDefinitionTensor.
Setter:: Sets the averageAtNode of the ResultDefinitionTensor.
Type:: bool

property cached#

Attribute to get the status of the ResultDefinition, cached or uncached.

Getter:: Gets if ResultDefinition is cached or uncached.
Type:: bool

property collection#

Attribute to set or get the collection for the ResultDefinition.

Getter:: Gets the collection for the ResultDefinition.
Setter:: Sets the collection for the ResultDefinition.
Type:: Collection object

property colorMode#

Attribute to set or get the colorMode of the ResultDefinitionTensor. Available options are value and direction.

Getter:: Gets the colorMode of the ResultDefinitionTensor.
Setter:: Sets the colorMode of the ResultDefinitionTensor.
Type:: str

property cornerData#

Attribute to set or get the cornerData of the ResultDefinition.

Getter:: Gets the cornerData of the ResultDefinition.
Setter:: Sets the cornerData of the ResultDefinition.
Type:: bool

property dataType#

Attribute to set or get the dataType of the ResultDefinition.

Getter:: Gets the dataType of the ResultDefinition.
Setter:: Sets the dataType of the ResultDefinition.
Type:: str

property displayMode#

Attribute to set or get the displayMode of the ResultDefinitionTensor. Available options are regular, moment and crowsfoot.

Getter:: Gets the displayMode of the ResultDefinitionTensor.
Setter:: Sets the displayMode of the ResultDefinitionTensor.
Type:: str

property font#

Attribute to set or get the font of the ResultDefinitionTensor.

Getter:: Gets the font of the ResultDefinitionTensor.
Setter:: Sets the font of the ResultDefinitionTensor.
Type:: Font object

property fontSize#

Attribute to set or get the font size of the ResultDefinitionTensor.

Getter:: Gets the font size of the ResultDefinitionTensor.
Setter:: Sets the font size of the ResultDefinitionTensor.
Type:: int

property format#

Attribute to set or get the format of the ResultDefinitionTensor. Available options are component and principal.

Getter:: Gets the format of the ResultDefinitionTensor.
Setter:: Sets the format of the ResultDefinitionTensor.
Type:: str

property headType#

Attribute to set or get the headType of the ResultDefinitionTensor. Available options are arrow or none.

Getter:: Gets the headType of the ResultDefinitionTensor.
Setter:: Sets the headType of the ResultDefinitionTensor.
Type:: str

property id#

Attribute to get the ID of the ResultDefinition.

Getter:: Gets ID.
Type:: int

property label#

Attribute to set or get the label of the ResultDefinition.

Getter:: Gets the label of the ResultDefinition.
Setter:: Sets the label of the ResultDefinition.
Type:: str

property layer#

Attribute to set or get the layer of the ResultDefinition.

Getter:: Gets the layer of the ResultDefinition.
Setter:: Sets the layer of the ResultDefinition.
Type:: str

property layerFilter#

Attribute to set or get the layer filter of the ResultDefinition.

Getter:: Gets the layerFilter of the ResultDefinition.
Setter:: Sets the layerFilter of the ResultDefinition.
Type:: int

property model#

Attribute to get the model of the ResultDefinition.

Getter:: Gets model of the ResultDefinition.
Type:: Model

property page#

Attribute to get the page of the ResultDefinition.

Getter:: Gets page of the ResultDefinition.
Type:: Page

property projectionRule#

Attribute to set or get the projectionRule of the ResultDefinitionTensor. Available options are none, xy, xz, yx, yz, zx and zy.

Getter:: Gets the projectionRule of the ResultDefinitionTensor.
Setter:: Sets the projectionRule of the ResultDefinitionTensor.
Type:: str

property resultType#

Attribute to get the ID of the ResultDefinition type.

Getter:: Gets ResultDefinition type like scalar, vector, tensor and iso.
Type:: str

property scale#

Attribute to set or get the scale of the ResultDefinitionTensor.

Getter:: Gets the scale of the ResultDefinitionTensor.
Setter:: Sets the scale of the ResultDefinitionTensor.
Type:: float

property scaleMode#

Attribute to set or get the scaleMode of the ResultDefinitionTensor. Available options are normalize or magnitude.

Getter:: Gets the scaleMode of the ResultDefinitionTensor.
Setter:: Sets the scaleMode of the ResultDefinitionTensor.
Type:: str

property scaleShearComponent#

Attribute to set or get the scaleShearComponent of the ResultDefinitionTensor.

Getter:: Gets the scaleShearComponent of the ResultDefinitionTensor.
Setter:: Sets the scaleShearComponent of the ResultDefinitionTensor.
Type:: float

property showMidnodeResults#

Attribute to set or get the showMidnodeResults of the ResultDefinition.

Getter:: Gets the showMidnodeResults of the ResultDefinition.
Setter:: Sets the showMidnodeResults of the ResultDefinition.
Type:: bool

property showPrefixNormal#

Attribute to set or get the showPrefixNormal of the ResultDefinitionTensor.

Getter:: Gets the showPrefixNormal of the ResultDefinitionTensor.
Setter:: Sets the showPrefixNormal of the ResultDefinitionTensor.
Type:: bool

property showPrefixShear#

Attribute to set or get the showPrefixShear of the ResultDefinitionTensor.

Getter:: Gets the showPrefixShear of the ResultDefinitionTensor.
Setter:: Sets the showPrefixShear of the ResultDefinitionTensor.
Type:: bool

property showValueNormal#

Attribute to set or get the showValueNormal of the ResultDefinitionTensor.

Getter:: Gets the showValueNormal of the ResultDefinitionTensor.
Setter:: Sets the showValueNormal of the ResultDefinitionTensor.
Type:: bool

property showValueShear#

Attribute to set or get the showValueShear of the ResultDefinitionTensor.

Getter:: Gets the showValueShear of the ResultDefinitionTensor.
Setter:: Sets the showValueShear of the ResultDefinitionTensor.
Type:: bool

property system#

Attribute to set or get the system of the ResultDefinition. Available options are analysis, global, elemental, material, ply system, <user_system>.

Getter:: Gets the system of the ResultDefinition.
Setter:: Sets the system of the ResultDefinition.
Type:: str

property window#

Attribute to get the window of the ResultDefinition.

Getter:: Gets window of the ResultDefinition.
Type:: Window

ResultDefinitionVector class#

class ResultDefinitionVector(type: ResultPlotType | None = None, model=None, window: Window | None = None, page: Page | None = None, id: int = 1, label: str | None = None, **kwargs)#

Bases: ResultDefinition

A class representing the ResultDefinitionVector.

Parameters:

model (Union[Model, int, str]) – Model for the ResultDefinitionVector. Default is the active model.
window (Union[Window, int]) – Window for the ResultDefinitionVector. Default is the active window.
page (Union[Page, int, str]) – Page for the ResultDefinitionVector. Default is the active page.
id (int) – ResultDefinitionVector ID. Default is 1.

:param label:ResultDefinitionVector label. :type label: str

Parameters:: kwargs (dict) – To set the other attributes of the ResultDefinitionVector class.

display()#: Method to plot the result definition like ResultDefinitionScalar, ResultDefinitionVector and ResultDefinitionTensor

getComponentColor(name: str)#

Method to get the component color of the ResultDefinitionVector.

Parameters:: name (str) – Name of the Component or Resultant. Options are x, y, z, xy, yz, zx, and xyz.

getDisplayMode(name: str)#

Method to get the display mode of the ResultDefinitionVector.

Parameters:: name (str) – Name of the Component or Resultant. Options are x, y, z, xy, yz, zx, xyz, prefix or value.

setAttributes(**kwargs)#

Method to set the ResultDefinition attributes.

Parameters:: kwargs (dict) – attributes

setComponentColor(**kwargs)#

Method to set the Component color of the ResultDefinitionVector.

Parameters:: kwargs (dict) – Dictionary of the Name of the Component or Resultant and color.

setDisplayMode(**kwargs)#

Method to set the display mode of the ResultDefinitionVector.

Parameters:: kwargs (dict) – Dictionary of the Name of the Component or Resultant and Boolean.

property cached#

Attribute to get the status of the ResultDefinition, cached or uncached.

Getter:: Gets if ResultDefinition is cached or uncached.
Type:: bool

property collection#

Attribute to set or get the collection for the ResultDefinition.

Getter:: Gets the collection for the ResultDefinition.
Setter:: Sets the collection for the ResultDefinition.
Type:: Collection object

property colorMode#

Attribute to set or get the colorMode of the ResultDefinitionVector. Available options are value or direction.

Getter:: Gets the colorMode of the ResultDefinitionVector.
Setter:: Sets the colorMode of the ResultDefinitionVector.
Type:: str

property cornerData#

Attribute to set or get the cornerData of the ResultDefinition.

Getter:: Gets the cornerData of the ResultDefinition.
Setter:: Sets the cornerData of the ResultDefinition.
Type:: bool

property dataType#

Attribute to set or get the dataType of the ResultDefinition.

Getter:: Gets the dataType of the ResultDefinition.
Setter:: Sets the dataType of the ResultDefinition.
Type:: str

property drawPosition#

Attribute to set or get the drawPosition of the ResultDefinitionVector. Available options are tail, tip and center.

Getter:: Gets the drawPosition of the ResultDefinitionVector.
Setter:: Sets the drawPosition of the ResultDefinitionVector.
Type:: str

property evenlyDistributed#

Attribute to set or get the evenlyDistributed option of the ResultDefinitionVector.

Getter:: Gets the evenlyDistributed option of the ResultDefinitionVector.
Setter:: Sets the evenlyDistributed option of the ResultDefinitionVector.
Type:: bool

property font#

Attribute to set or get the font of the ResultDefinitionVector.

Getter:: Gets the font of the ResultDefinitionVector.
Setter:: Sets the font of the ResultDefinitionVector.
Type:: Font object

property fontSize#

Attribute to set or get the font size of the ResultDefinitionVector.

Getter:: Gets the font size of the ResultDefinitionVector.
Setter:: Sets the font size of the ResultDefinitionVector.
Type:: int

property headType#

Attribute to set or get the headType of the ResultDefinitionVector. Available options are arrow or none.

Getter:: Gets the headType of the ResultDefinitionVector.
Setter:: Sets the headType of the ResultDefinitionVector.
Type:: str

property id#

Attribute to get the ID of the ResultDefinition.

Getter:: Gets ID.
Type:: int

property label#

Attribute to set or get the label of the ResultDefinition.

Getter:: Gets the label of the ResultDefinition.
Setter:: Sets the label of the ResultDefinition.
Type:: str

property layer#

Attribute to set or get the layer of the ResultDefinition.

Getter:: Gets the layer of the ResultDefinition.
Setter:: Sets the layer of the ResultDefinition.
Type:: str

property layerFilter#

Attribute to set or get the layer filter of the ResultDefinition.

Getter:: Gets the layerFilter of the ResultDefinition.
Setter:: Sets the layerFilter of the ResultDefinition.
Type:: int

property model#

Attribute to get the model of the ResultDefinition.

Getter:: Gets model of the ResultDefinition.
Type:: Model

property page#

Attribute to get the page of the ResultDefinition.

Getter:: Gets page of the ResultDefinition.
Type:: Page

property projected#

Attribute to set or get the projected option of the ResultDefinitionVector.

Getter:: Gets the projected option of the ResultDefinitionVector.
Setter:: Sets the projected option of the ResultDefinitionVector.
Type:: bool

property resultType#

Attribute to get the ID of the ResultDefinition type.

Getter:: Gets ResultDefinition type like scalar, vector, tensor and iso.
Type:: str

property scale#

Attribute to set or get the scale of the ResultDefinitionVector.

Getter:: Gets the scale of the ResultDefinitionVector.
Setter:: Sets the scale of the ResultDefinitionVector.
Type:: float

property scaleMode#

Attribute to set or get the scaleMode of the ResultDefinitionVector. Available options are uniform, magnitude and auto.

Getter:: Gets the scaleMode of the ResultDefinitionVector.
Setter:: Sets the scaleMode of the ResultDefinitionVector.
Type:: str

property showMidnodeResults#

Attribute to set or get the showMidnodeResults of the ResultDefinition.

Getter:: Gets the showMidnodeResults of the ResultDefinition.
Setter:: Sets the showMidnodeResults of the ResultDefinition.
Type:: bool

property system#

Attribute to set or get the system of the ResultDefinition. Available options are analysis, global, elemental, material, ply system, <user_system>.

Getter:: Gets the system of the ResultDefinition.
Setter:: Sets the system of the ResultDefinition.
Type:: str

property window#

Attribute to get the window of the ResultDefinition.

Getter:: Gets window of the ResultDefinition.
Type:: Window

ResultDisplayIso class#

class ResultDisplayIso(type: ResultPlotType | None = None, model=None, window: Window | None = None, page: Page | None = None, id: int = 1, label: str | None = None, _add: bool = True, **kwargs)#

Bases: object

A class representing the ResultDisplayIso.

Parameters:

model (Union[Model, int, str]) – Model for the ResultDisplayIso. Default is the active model.
window (Union[Window, int]) – Window for the ResultDisplayIso. Default is the active window.
page (Union[Page, int, str]) – Page for the ResultDisplayIso. Default is the active page.
id (int) – ResultDisplayIso ID. Default is 1.
label (str) – ResultDisplayIso label.
kwargs (dict) – To set the other attributes of the ResultDisplayIso class.

setAttributes(**kwargs)#

Method to set the ResultDisplayIso attributes.

Parameters:: kwargs (dict) – Attribute dictionary.

property color#

Attribute to set or get the color of the ResultDisplayIso.

Getter:: Gets the ignoreFlippedNormals of the ResultDisplayIso.
Setter:: Sets the ignoreFlippedNormals of the ResultDisplayIso.
Type:: bool

property displayMode#

Attribute to set or get the displayMode of the ResultDisplayIso. Available options are above, below, and equal.

Getter:: Gets the displayMode of the ResultDisplayIso.
Setter:: Sets the displayMode of the ResultDisplayIso.
Type:: str

property increment#

Attribute to set or get the increment of the ResultDisplayIso.

Getter:: Gets the increment of the ResultDisplayIso.
Setter:: Sets the increment of the ResultDisplayIso.
Type:: float

property showColor#

Attribute to set or get the showColor of the ResultDisplayIso.

Getter:: Gets the showColor of the ResultDisplayIso.
Setter:: Sets the showColor of the ResultDisplayIso.
Type:: bool

property value#

Attribute to set or get the value of the ResultDisplayIso.

Getter:: Gets the value of the ResultDisplayIso.
Setter:: Sets the value of the ResultDisplayIso.
Type:: float

property valueRange#

Attribute to get the valueRange of the ResultDisplayIso.

Getter:: Gets the valueRange of the ResultDisplayIso.
Type:: list of floats

SectionCutPlanar class#

class SectionCutPlanar(window: Window | None = None, page: Page | None = None, id: int | None = None, **kwargs)#

Bases: SectionCut

A class representing the SectionCut Planar.

Parameters:

window (Union[Window, int]) – Window for the SectionCut Planar. Default is the active window.
page (Union[Page, int, str]) – Page for the SectionCut Planar. Default is the active page.
id (int) – id of the SectionCut Planar. Default is 1.
kwargs (dict) – To set the other attributes of the SectionCutPlanar class.

reverse()#: Method to reverse the direction of SectionCut.

setAttributes(**kwargs)#

Method to set the SectionCut attributes.

Parameters:: kwargs (dict) – attributes

setBaseNode(node: int | Node, model: int | Model | None = None)#

Method to set the base node of the SectionCutPlanar.

Parameters:

node (Union[int, Node]) – Node id or obect.
model (Union[int,Model]) – Model id or object.

setOrientationByAligneView()#: Method to set the orientation node of the SectionCutPlanar by the align view method.

setOrientationByAxis(orientationAxis: str = 'y', node: int | Node | None = None)#

Method to set the orientation axis of the SectionCutPlanar.

Parameters:: orientationAxis – Orientation axis. ‘x’,’y’ or ‘z’.

:type orientationAxis:str

Parameters:: node (Union[int, Node]) – Node id or obect.

Method to set the orientation node of the SectionCutPlanar.

Parameters:

n1 (Union[int, Node]) – First node id or obect.
n2 (Union[int, Node]) – Second node id or obect.
n3 (Union[int, Node]) – Third node id or obect.
base (Union[int, Node]) – Base node id or obect.

setOrientationByNormalToScreen(node: int | Node | list | tuple | None = None)#

Method to set the normal to screen orientation of the SectionCutPlanar.

Parameters:: node (Union[int, Node,list,tuple]) – Node id,Node obect or Node coodinates.

property baseCoordinates#

Attribute to set or get the base coordinates of the SectionCutPlanar.

Getter:: Gets the base coordinates of the SectionCutPlanar.
Setter:: Sets the base coordinates of the SectionCutPlanar.
Type:: Union[list,tuple]

property baseFrame#

Attribute to set or get the base frame of the SectionCut.

Getter:: Gets the base frame of the SectionCut.
Setter:: Sets the base frame of the SectionCut.
Type:: int

property baseTime#

Attribute to set or get the base time of the SectionCut.

Getter:: Gets the base time of the SectionCut.
Setter:: Sets the base time of the SectionCut.
Type:: float

property clipAbove#

Attribute to set or get the clipAbove attribute.

Getter:: Gets the clipAbove of SectionCutPlanar.
Setter:: Sets the clipAbove of SectionCutPlanar.
Type:: bool

property clipElements#

Attribute to set or get the clipElements attribute.

Getter:: Gets the clipElements attribute of SectionCut.
Setter:: Sets the clipElements attribute of SectionCut.
Type:: bool

property color#

Attribute to set or get the color of the SectionCut.

Getter:: Gets the color of the SectionCut.
Setter:: Sets the color of the SectionCut.
Type:: Color

property crossSectionOnly#

Attribute to set or get the crossSectionOnly attribute.

Getter:: Gets the crossSectionOnly attribute of SectionCut.
Setter:: Sets the crossSectionOnly attribute of SectionCut.
Type:: bool

property deformable#

Attribute to set or get the deformable attribute.

Getter:: Gets the deformable attribute of SectionCut.
Setter:: Sets the deformable attribute of SectionCut.
Type:: bool

property featureLines#

Attribute to set or get featureLines attribute.

Getter:: Gets the featureLines attribute of SectionCut.
Setter:: Sets the featureLines attribute of SectionCut.
Type:: bool

property gridLines#

Attribute to set or get the grid lines attribute.

Getter:: Gets the grid lines of SectionCutPlanar.
Setter:: Sets the grid lines of SectionCutPlanar.
Type:: bool

property gridSpaceX#

Attribute to set or get grid Space X of the SectionCutPlanar.

Getter:: Gets the grid Space X of the SectionCutPlanar.
Setter:: Sets the grid Space X of the SectionCutPlanar.
Type:: float

property gridSpaceY#

Attribute to set or get grid Space Y of the SectionCutPlanar.

Getter:: Gets the grid Space Y of the SectionCutPlanar.
Setter:: Sets the grid Space Y of the SectionCutPlanar.
Type:: float

property gridText#

Attribute to set or get the grid text attribute.

Getter:: Gets the grid text of SectionCutPlanar.
Setter:: Sets the grid text of SectionCutPlanar.
Type:: bool

property gridTextPrecision#

Attribute to set or get grid text precision of the SectionCutPlanar.

Getter:: Gets the grid text precision of the SectionCutPlanar.
Setter:: Sets the grid text precision of the SectionCutPlanar.
Type:: int

property id#

Attribute to get the ID of the SectionCut.

Getter:: Gets ID.
Type:: int

property label#

Attribute to set or get the label of the SectionCut.

Getter:: Gets the label of the SectionCut.
Setter:: Sets the label of the SectionCut.
Type:: str

property orientationVector#

Attribute to set or get the orientation vector of the SectionCutPlanar.

Getter:: Gets the orientation vector of the SectionCutPlanar.
Setter:: Sets the orientation vector of the SectionCutPlanar.
Type:: Union[list,tuple]

property page#

Attribute to get the page of the SectionCut.

Getter:: Gets page of the SectionCut.
Type:: Page

property showColor#

Attribute to set or get the showColor attribute.

Getter:: Gets the showColor attribute of SectionCut.
Setter:: Sets the showColor attribute of SectionCut.
Type:: bool

property thickness#

Attribute to set or get the thickness.

Getter:: Gets the thickness of SectionCut.
Setter:: Sets the thickness of SectionCut.
Type:: Union[int,str]

property transparency#

Attribute to set or get the transparency attribute.

Getter:: Gets the transparency attribute of SectionCut.
Setter:: Sets the transparency attribute of SectionCut.
Type:: bool

property visibility#

Attribute to set or get the title visibility.

Getter:: Gets the title visibility of SectionCut.
Setter:: Sets the title visibility of SectionCut.
Type:: bool

property width#

Attribute to set or get width of the SectionCutPlanar.

Getter:: Gets the width of the SectionCutPlanar.
Setter:: Sets the width of the SectionCutPlanar.
Type:: float

property window#

Attribute to get the window of the SectionCut.

Getter:: Gets window of the SectionCut.
Type:: Window

SectionCutSpherical class#

class SectionCutSpherical(window: Window | None = None, page: Page | None = None, id: int | None = None, **kwargs)#

Bases: SectionCut

A class representing SectionCut Spherical.

Parameters:

window (Union[Window, int]) – Window for the SectionCut Spherical. Default is the active window.
page (Union[Page, int, str]) – Page for the SectionCut Spherical. Default is the active page.
id (int) – id of the SectionCut Spherical. Default is 1.
kwargs (dict) – To set the other attributes of the SectionCutSpherical class.

reverse()#: Method to reverse the direction of SectionCut.

setAttributes(**kwargs)#

Method to set the SectionCut attributes.

Parameters:: kwargs (dict) – attributes

property baseFrame#

Attribute to set or get the base frame of the SectionCut.

Getter:: Gets the base frame of the SectionCut.
Setter:: Sets the base frame of the SectionCut.
Type:: int

property baseTime#

Attribute to set or get the base time of the SectionCut.

Getter:: Gets the base time of the SectionCut.
Setter:: Sets the base time of the SectionCut.
Type:: float

property center#

Attribute to set or get center of the SectionCutSpherical.

Getter:: Gets the center of the SectionCutSpherical.
Setter:: Sets the center of the SectionCutSpherical.
Type:: Union[Node,list,tuple]

property clipElements#

Attribute to set or get the clipElements attribute.

Getter:: Gets the clipElements attribute of SectionCut.
Setter:: Sets the clipElements attribute of SectionCut.
Type:: bool

property clipInside#

Attribute to set or get clip inside attribute.

Getter:: Gets the clip inside of the SectionCutSpherical.
Setter:: Sets the clip inside of the SectionCutSpherical.
Type:: bool

property color#

Attribute to set or get the color of the SectionCut.

Getter:: Gets the color of the SectionCut.
Setter:: Sets the color of the SectionCut.
Type:: Color

property crossSectionOnly#

Attribute to set or get the crossSectionOnly attribute.

Getter:: Gets the crossSectionOnly attribute of SectionCut.
Setter:: Sets the crossSectionOnly attribute of SectionCut.
Type:: bool

property deformable#

Attribute to set or get the deformable attribute.

Getter:: Gets the deformable attribute of SectionCut.
Setter:: Sets the deformable attribute of SectionCut.
Type:: bool

property featureLines#

Attribute to set or get featureLines attribute.

Getter:: Gets the featureLines attribute of SectionCut.
Setter:: Sets the featureLines attribute of SectionCut.
Type:: bool

property id#

Attribute to get the ID of the SectionCut.

Getter:: Gets ID.
Type:: int

property label#

Attribute to set or get the label of the SectionCut.

Getter:: Gets the label of the SectionCut.
Setter:: Sets the label of the SectionCut.
Type:: str

property page#

Attribute to get the page of the SectionCut.

Getter:: Gets page of the SectionCut.
Type:: Page

property radius#

Attribute to set or get radius of the SectionCutSpherical.

Getter:: Gets the radius of the SectionCutSpherical.
Setter:: Sets the radius of the SectionCutSpherical.
Type:: float

property showColor#

Attribute to set or get the showColor attribute.

Getter:: Gets the showColor attribute of SectionCut.
Setter:: Sets the showColor attribute of SectionCut.
Type:: bool

property sphere#

Attribute to set or get sphere attribute.

Getter:: Gets the sphere of the SectionCutSpherical.
Setter:: Sets the sphere of the SectionCutSpherical.
Type:: bool

property thickness#

Attribute to set or get the thickness.

Getter:: Gets the thickness of SectionCut.
Setter:: Sets the thickness of SectionCut.
Type:: Union[int,str]

property transparency#

Attribute to set or get the transparency attribute.

Getter:: Gets the transparency attribute of SectionCut.
Setter:: Sets the transparency attribute of SectionCut.
Type:: bool

property visibility#

Attribute to set or get the title visibility.

Getter:: Gets the title visibility of SectionCut.
Setter:: Sets the title visibility of SectionCut.
Type:: bool

property window#

Attribute to get the window of the SectionCut.

Getter:: Gets window of the SectionCut.
Type:: Window