pycatia.cat_plant_ship_interfaces.psp_id

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_id.PSPId(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
PspID

Represents the interface to generate and set IDs for the Distributive System
Objects.
Role: This is the interface for Plant Ship object ID
generation.
gen_and_put_id() → str

Note

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

Returns the Generated ID with the sequence number and is stored on the
object.

Returns:
ID generated

Example:

Dim objThisIntf As PspID
Dim iStrVar1 As String
…
iStrVar1 =objThisIntf.GenAndPutID
Return type:

str

gen_and_put_id_no_gen_seq_num() → str

Note

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

Generates ID without the sequence number and is stored on the
object.

Returns:
ID generated

Example:

Dim objThisIntf As PspID
Dim iStrVar1 As String
…
iStrVar1 =objThisIntf.GenAndPutIDNoGenSeqNum
Return type:

str

gen_id_no_gen_seq_num() → str

Note

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

Generates ID without the sequence number( if not set previously) and is not
stored on the object.

Parameters:

oGeneratedID
ID generated

Example:

Dim objThisIntf As PspID
Dim iStrVar1 As String
…
iStrVar1 =objThisIntf.GenIDNoGenSeqNum
Return type:

str

get_id() → str

Note

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

Gets ID for the object.

Returns:
ID of the object.
Example:

Dim objThisIntf As PspID
Dim iStrVar1 As String
…
iStrVar1 =objThisIntf.GetID
Return type:

str

get_local_id() → str

Note

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

Retrieves local ID of the object.

Returns:
Local ID generated

Example:

Dim objThisIntf As PspID
Dim iStrVar1 As String
…
iStrVar1 =objThisIntf.GetLocalID
Return type:

str

is_id_generated() → bool

Note

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

Checks if the ID on the object is generated( based on the ID
Schema).

Parameters:

oBIsGenerated
TRUE if ID is generated from the ID schema

Example:

Dim objThisIntf As PspID
Dim bVar1 As boolean
…
bVar1 =objThisIntf.IsIDGenerated
Return type:

bool

set_id(i_id: str) → None

Note

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

Sets ID for the object.

Parameters:

oID
ID to be set.

Example:

Dim objThisIntf As PspID
Dim iStrVar1 As String
…
objThisIntf.SetID iStrVar1
Parameters:

i_id (str) –

Return type:

None