Property#

Usage:

Property Class API Wrapper

class Property[source]#

Bases: object

Wrapper for Property class of Moldflow Synergy.

delete_field(field_id)[source]#

Delete field from the property.

Parameters:

field_id (int) – The id of the field to delete.

Returns:

True if the field is deleted, False otherwise

Return type:

bool

field_units(field_id)[source]#

Get the units of the field.

Parameters:

field_id (int) – The id of the field.

Returns:

The units of the field values.

Return type:

StringArray

get_field_description(field_id)[source]#

Get the description of the field.

Parameters:

field_id (int) – The id of the field.

Returns:

The description of the field.

Return type:

str

get_field_values(field_id)[source]#

Get the values of the field.

Parameters:

field_id (int) – The id of the field.

Returns:

The values of the field.

Return type:

DoubleArray

get_first_field()[source]#

Get the first field of the property.

Returns:

The id of the first field of the property.

Return type:

int

get_next_field(field_id)[source]#

Get the first field of the property.

Parameters:

field_id (int) – The id of the current field.

Returns:

The id of the next field.

Return type:

int

hide_field(field_id)[source]#

Make field confidential.

Parameters:

field_id (int) – The id of the field to make confidential.

Returns:

True if the field is made confidential, False otherwise.

Return type:

bool

property id: int#

Get the id of the property.

Returns:

The id of the property.

Return type:

int

is_field_hidden(field_id)[source]#

Check if the field is confidential.

Parameters:

field_id (int) – The id of the field to check.

Returns:

True if the field is confidential, False otherwise.

Return type:

bool

is_field_writable(field_id)[source]#

Check if the field is writable.

Parameters:

field_id (int) – The id of the field to check.

Returns:

True if the field is writable, False otherwise.

Return type:

bool

property name: str#

Get the name of the property.

Returns:

The name of the property.

Return type:

str

set_field_description(field_id, description)[source]#

Set the description of the field.

Parameters:

  • field_id (int) – The id of the field.

  • description (str) – The description of the field.

Return type:

None

set_field_values(field_id, values)[source]#

Set the values of the field.

Parameters:

  • field_id (int) – The id of the field.

  • values (DoubleArray | None) – The values of the field.

Return type:

None

property type: int#

Get the type of the property.

Returns:

The type of the property.

Return type:

int