pycatia.cat_plant_ship_interfaces.psp_attribute

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_plant_ship_interfaces.psp_attribute.PSPAttribute(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
PspAttribute

Represents Attribute Interface to query Plant Ship objects’
attributes.
Role: To query and reset attributes.
get_multi_string_attribute_values(i_attribute_name: str) → PSPListOfBSTRs

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetMultiStringAttributeValues(CATBSTR iAttributeName) As
PspListOfBSTRs

Retrieves String values for the input attribute the type
catPspIDLMultiString.

Parameters:

iAttributeName
Attribute Name

Returns:
List of string values
Example:

Dim objThisIntf As PspAttribute
Dim strVar1 As CATBSTR
Dim objArg2 As PspListOfBSTRs
…
Set objArg2 = objThisIntf.GetMultiStringAttributeValues (strVar1)
Parameters:

i_attribute_name (str) –

Return type:

PSPListOfBSTRs

get_parameter(i_attribute_name: str) → Parameter

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetParameter(CATBSTR iAttributeName) As Parameter

Retrieve parameter for the input attribute name.

Parameters:

iAttributeName
Attribute Name

Returns:
Parameter of the attribute
Example:

Dim objThisIntf As PspAttribute
Dim strVar1 As CATBSTR
Dim ObjVar2 As Parameter
…
Set objArg2 = objThisIntf.GetParameter (strVar1 )
Parameters:

i_attribute_name (str) –

Return type:

Parameter

get_type(i_attribute_name: str) → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetType(CATBSTR iAttributeName) As
CatPspIDLAttrDataType

Retrieves type of the input attribute. If the type of the attribute is
catPspIDLMultiString use GetMultiStringAttributeValues. for others, use
GetParameter().

Parameters:

iAttributeName
Attribute Name

Returns:
Type of the attribute.
Example:

Dim objThisIntf As PspAttribute
Dim strVar1 As CATBSTR
Dim eType As CatPspIDLAttrDataType

…
eType = objThisIntf.GetType (strVar1)
param str i_attribute_name:

rtype:

enum cat_psp_idl_attr_data_type

return:

int

is_derived(i_attribute_name: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func IsDerived(CATBSTR iAttributeName) As boolean

Retrieve Derived status for the input attribute.

Parameters:

iAttributeName
Attribute Name

Returns:
TRUE if the attribute is derived

Example:

Dim objThisIntf As PspAttribute
Dim strVar1 As CATBSTR
Dim bIsDerived As boolean
…
bIsDerived = objThisIntf.IsDerived (strVar1)
Parameters:

i_attribute_name (str) –

Return type:

bool

is_discrete(i_attribute_name: str, ob_status: bool) → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func IsDiscrete(CATBSTR iAttributeName,
boolean obStatus) As short

Query whether the input attribute is discrete or not.

Parameters:

iAttributeName
Attribute Name
obStatus
TRUE if attribute is discrete else FALSE

Returns:
Discrete Type value 1-Standard 2-Encoded discrete

Example:

Dim objThisIntf As PspAttribute
Dim strVar1 As CATBSTR
Dim boolVar2 As Boolean
Dim shortVar3 As Short
…
shortVar3 = objThisIntf.IsDiscrete (strVar1,boolVar2)
Parameters:

  • i_attribute_name (str) –

  • ob_status (bool) –

Return type:

int

list_attributes(i_domain_id: int) → PSPListOfBSTRs

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ListAttributes(CatPspIDLDomainID iDomainID) As
PspListOfBSTRs

Retrieves a list of Attributes of an object in the the input domain
ID.

Parameters:

iDomainID
Domain ID. If set to catPspIDLNone, then it will return attributes
in all the domains.

Returns:
List of attributes ( A list of CATIAPspGroupables)

Example:

Dim objThisIntf As PspAttribute
Dim objArg1 As CatPspIDLDomainID
Dim objArg2 As PspListOfBSTRs
…
Set objArg2 = objThisIntf.ListAttributes (objArg1)
Parameters:

i_domain_id (int) – enum cat_psp_idl_domain_id

Return type:

PSPListOfBSTRs

list_double_discrete_values(i_attribute_name: str) → PSPListOfDoubles

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ListDoubleDiscreteValues(CATBSTR iAttributeName) As
PspListOfDoubles

Retrieves double discrete values for the input attribute.

Parameters:

iAttributeName
Attribute Name

Returns:
Discrete list of double values

Example:

Dim objThisIntf As PspAttribute
Dim strVar1 As CATBSTR
Dim objArg2 As PspListOfDoubles
…
Set objArg2 = objThisIntf.ListDoubleDiscreteValues (strVar1 )
Parameters:

i_attribute_name (str) –

Return type:

PSPListOfDoubles

list_encoded_decoded_discrete_values(i_attribute_name: str, o_l_discrete_encoded_values: PSPListOfBSTRs, o_l_discrete_decoded_value: PSPListOfBSTRs) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ListEncodedDecodedDiscreteValues(CATBSTR
iAttributeName,
PspListOfBSTRs oLDiscreteEncodedValues,
PspListOfBSTRs oLDiscreteDecodedValue)

Retrieves Encoded-decoded discrete values for the input
attribute.

Parameters:

iAttributeName
Attribute Name
oLDiscreteEncodedValues
Discrete list of encoded string values
oLDiscreteDecodedValue
Discrete list of decoded string values

Example:

Dim objThisIntf As PspAttribute
Dim strVar1 As CATBSTR
Dim objArg2 As PspListOfBSTRs
Dim objArg3 As PspListOfBSTRs
…
objThisIntf.ListEncodedDecodedDiscreteValues strVar1, objArg2,
objArg3
Parameters:
Return type:

None

list_integer_discrete_values(i_attribute_name: str) → PSPListOfLongs

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ListIntegerDiscreteValues(CATBSTR iAttributeName) As
PspListOfLongs

Retrieve integer (long) discrete values for the input
attribute.

Parameters:

iAttributeName
Attribute Name

Returns:
Discrete list of integer values

Example:

Dim objThisIntf As PspAttribute
Dim strVar1 As CATBSTR
Dim objArg2 As PspListOfLongs
…
Set objArg2 = objThisIntf.ListIntegerDiscreteValues (strVar1)
Parameters:

i_attribute_name (str) –

Return type:

PSPListOfLongs

list_string_discrete_values(i_attribute_name: str) → PSPListOfBSTRs

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ListStringDiscreteValues(CATBSTR iAttributeName) As
PspListOfBSTRs

RetrievesString discrete values for the input attribute.

Parameters:

iAttributeName
Attribute Name

Returns:
Discrete list of string values

Example:

Dim objThisIntf As PspAttribute
Dim strVar1 As CATBSTR
Dim objArg2 As PspListOfBSTRs
…
Set objArg2 = objThisIntf.ListStringDiscreteValues (strVar1)
Parameters:

i_attribute_name (str) –

Return type:

PSPListOfBSTRs

reset_derived_attr(i_attribute_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ResetDerivedAttr(CATBSTR iAttributeName)

Reset derived status of the attribute to not-derived.

Parameters:

iAttributeName
Attribute Name

Example:

Dim objThisIntf As PspAttribute
Dim strVar1 As CATBSTR
…
objThisIntf.ResetDerivedAttr strVar1
Parameters:

i_attribute_name (str) –

Return type:

None