pycatia.cat_plant_ship_interfaces.psp_functional

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_functional.PSPFunctional(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
PspFunctional

Represents Plant Ship functional object.
Role: To access Plant Ship Functional object information.
property catalog_part_name: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property CatalogPartName() As CATBSTR (Read Only)

Returns catalog part name of physical object that realizes this
function.

Example:

Dim objThisIntf As PspFunctional
Dim strVar1 As CATBSTR
…
Set strVar1 = objThisIntf.CatalogPartName
Return type:

str

property function_status: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property FunctionStatus() As CatPspIDLFunctionStatus (Read
Only)

Returns function object status.

Example:

Dim objThisIntf As PspPhysical
Dim objArg1 As CatPspIDLFunctionStatus
…
objArg1 = objThisIntf.FunctionStatus
Returns:

enum cat_psp_idl_function_status

Return type:

int

get_compatible_part_types(iu_standard: str) → PSPListOfBSTRs

Note

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

Retrieves a list of all physical part types that are compatible with this
function.

Parameters:

iuStandard
Standard name

Returns:
List of Compatible Part Types.

Example:

Dim objThisIntf As PspFunctional
Dim strVar1 As CATBSTR
Dim objArg2 As PspListOfBSTRs

…
Set objArg1 = objThisIntf.GetCompatiblePartTypes (strVar1)
Parameters:

iu_standard (str) –

Return type:

PSPListOfBSTRs

is_ok_to_integrate() → bool

Note

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

Check it is OK to integrate (realize) this function with a physical
part.

Returns:
TRUE if ok to be integrated

Example:

Dim objThisIntf As PspFunctional
Dim objArg1 As boolean
…
objArg1 = objThisIntf.IsOKToIntegrate
Return type:

bool

is_realized() → bool

Note

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

Checks if the Function object is realized or not.

Returns:
TRUE if the object is Realized

Example:

Dim objThisIntf As PspFunctional
Dim objArg1 As boolean
…
objArg1 = objThisIntf.IsRealized
Return type:

bool

is_spec_driven() → bool

Note

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

Checks if the functional object is specification driven or
not.

Returns:
TRUE if this object is specification driven.

Example:

Dim objThisIntf As PspFunctional
Dim objArg1 As boolean
…
objArg1 = objThisIntf.IsSpecDriven
Return type:

bool

list_compatible_part_numbers(iu_part_type: str, iu_standard: str, iu_catalog_name: str, o_l_part_types: PSPListOfBSTRs, o_l_catalog_part_names: PSPListOfBSTRs) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ListCompatiblePartNumbers(CATBSTR iuPartType,
CATBSTR iuStandard,
CATBSTR iuCatalogName,
PspListOfBSTRs oLPartTypes,
PspListOfBSTRs oLCatalogPartNames)

Retrieves a list of compatible Part numbers and part
types.

Parameters:

iuPartType
part type
iuStandard
Standard name
iuCatalogName
catalog name
oLPartTypes
a list of part types
oLCatalogPartNames
List of catalog part names

Example:

Dim objThisIntf As PspFunctional
Dim strVar1 As CATBSTR
Dim strVar2 As CATBSTR
Dim strVar3 As CATBSTR
Dim objArg4 As PspListOfBSTRs
Dim objArg5 As PspListOfBSTRs

..
..
objThisIntf.ListCompatiblePartNumbers
strVar1,strVar2,strVar3,objArg4,objArg5
Parameters:

  • iu_part_type (str) –

  • iu_standard (str) –

  • iu_catalog_name (str) –

  • o_l_part_types (PSPListOfBSTRs) –

  • o_l_catalog_part_names (PSPListOfBSTRs) –

Return type:

None

property part_catalog_name: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PartCatalogName() As CATBSTR (Read Only)

Returns Part catalog name of physical object that realizes this
function.

Example:

Dim objThisIntf As PspFunctional
Dim strVar1 As CATBSTR
…
strVar1 = objThisIntf.PartCatalogName
Return type:

str

property part_number: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PartNumber() As CATBSTR (Read Only)

Returns part number of physical object that realizes this
function.

Example:

Dim objThisIntf As PspFunctional
Dim strVar1 As CATBSTR
…
strVar1 = objThisIntf.PartNumber
Return type:

str

property part_type: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PartType() As CATBSTR (Read Only)

Returns the part type of physical object that realizes this
function.

Example:

Dim objThisIntf As PspFunctional
Dim strVar1 As CATBSTR
…
strVar1 = objThisIntf.PartType
Return type:

str

property physicals: PSPListOfObjects

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Physicals() As PspListOfObjects (Read Only)

Returns a list of all associated physical objects.

Example:

Dim objThisIntf As PspFunctional
Dim objArg1 As PspListOfObjects
…
Set objArg1 = objThisIntf.Physicals
Return type:

PSPListOfObjects

property standard: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Standard() As CATBSTR (Read Only)

Return Standard.

Example:

Dim objThisIntf As PspFunctional
Dim strVar1 As CATBSTR
…
strVar1 = objThisIntf.Standard
Return type:

str