pycatia.cat_ipd_adapter_interfaces.e5_property

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.cat_ipd_adapter_interfaces.e5_property.E5Property(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

E5Property

Interface to access object properties.

Role: This interface allow user to access and edit properties for those V5

objects who were loaded from E5. Note

While getting or setting the value for any attribute the implementation

attempts to access attribute value from V5 object first & then from

Manufacturing Hub. If attribute happens to be one of the mapped attribute or if

attribute with same name (user attribute, CATIA attribute …) exists on V5

object, then value will be returned from V5 object. If V5 object doesn’t have

that attribute, then value will be directly returned from Manufacturing Hub

database. When we try to get attribute from V5 object, if required object will

be loaded in memory and this may result in populating of cache (CGR, Selective

loading…)

This interface expect caller to use attribute name define in PPPR server for

example caller should use “note” to access Description .

Set calls will succeed only if user has editing privileges for that

object.

get_boolean_attribute(i_attr_name: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetBooleanAttribute(CATBSTR iAttrName) As boolean

This gets an CATBoolean Attribute value of an input Object

Parameters:

iAttrName

The name of the Attribute whose value we need

oAttrValue

CATBoolean value of the Attribute

Parameters:

i_attr_name (str) –

Return type:

bool

get_double_attribute(i_attr_name: str) → float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetDoubleAttribute(CATBSTR iAttrName) As double

This gets a Double Attribute value of an input Object

Parameters:

iAttrName

The name of the Attribute whose value we need

oAttrValue

Double value of the Attribute

Parameters:

i_attr_name (str) –

Return type:

float

get_long_attribute(i_attr_name: str) → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetLongAttribute(CATBSTR iAttrName) As long

This gets a Long Attribute value of an input Object

Parameters:

iAttrName

The name of the Attribute whose value we need

oAttrValue

Long value of the Attribute

Parameters:

i_attr_name (str) –

Return type:

int

get_string_attribute(i_attr_name: str) → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetStringAttribute(CATBSTR iAttrName) As CATBSTR

This gets a String Attribute value of an input Object

Parameters:

iAttrName

The name of the Attribute whose value we need

Returns:

CATUnicodeString value of the Attribute

Parameters:

i_attr_name (str) –

Return type:

str

set_boolean_attribute(i_attr_name: str, i_attr_value: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetBooleanAttribute(CATBSTR iAttrName,

boolean iAttrValue)

This sets an CATBoolean Attribute value to an input Object

Parameters:

iAttrName

The Attribute Name whose value we need to set

iAttrValue

CATBoolean value of the Attribute

Returns:

Value of iAttrName

Parameters:

• i_attr_name (str) –

• i_attr_value (bool) –

Return type:

None

set_double_attribute(i_attr_name: str, i_attr_value: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetDoubleAttribute(CATBSTR iAttrName,

double iAttrValue)

This sets a Double Attribute value to an input Object

Parameters:

iAttrName

The Attribute Name whose value we need to set

iAttrValue

Double value of the Attribute

Returns:

Value of iAttrName

Parameters:

• i_attr_name (str) –

• i_attr_value (float) –

Return type:

None

set_long_attribute(i_attr_name: str, i_attr_value: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetLongAttribute(CATBSTR iAttrName,

long iAttrValue)

This sets a Long Attribute value to an input Object

Parameters:

iAttrName

The Attribute Name whose value we need to set

Returns:

Value of iAttrName

Parameters:

• i_attr_name (str) –

• i_attr_value (int) –

Return type:

None

set_string_attribute(i_attr_name: str, i_attr_value: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetStringAttribute(CATBSTR iAttrName,

CATBSTR iAttrValue)

This sets a String Attribute value to an input Object

Parameters:

iAttrName

The Attribute Name whose value we need to set

iAttrValue

CATUnicodeString value of the Attribute

Parameters:

• i_attr_name (str) –

• i_attr_value (str) –

Return type:

None