pycatia.cat_sch_platform_interfaces.sch_session

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_sch_platform_interfaces.sch_session.SchSession(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

SchSession

Represents a schematic session.

create_document(i_doc_type: str, i_b_interactive: bool, o_new_doc: Document) → None

Note

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

o Sub CreateDocument(CATBSTR iDocType,

boolean iBInteractive,

Document oNewDoc)

Create a document with Schematic context.

Parameters:

iDocType

Document type, if NULL “Product” is assumed. These are the types

shown in the File+New list

iBInteractive

If TRUE, document is created in interactive session with editor

oNewDoc

Document created.

Example:

Dim objThisIntf As SchSession

Dim strVar1 As String

Dim bVar2 As boolean

Dim objArg3 As Document

…

objThisIntf.CreateDocumentstrVar1,bVar2,objArg3

Parameters:

• i_doc_type (str) –

• i_b_interactive (bool) –

• o_new_doc (Document) –

Return type:

None

get_current_application_id(o_application_id: str) → None

Note

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

o Sub GetCurrentApplicationID(CATBSTR oApplicationID)

Get the current application ID.

Parameters:

oApplicationID

Application ID

Example:

Dim objThisIntf As SchSession

Dim strVar1 As String

…

objThisIntf.GetCurrentApplicationIDstrVar1

Parameters:

o_application_id (str) –

Return type:

None

get_current_document() → Document

Note

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

o Func GetCurrentDocument() As Document

Get the current document.

Parameters:

oCurDoc

Pointer to current document. DO NOT NEED TO RELEASE OUTPUT POINTER.

Example:

Dim objThisIntf As SchSession

Dim objArg1 As Document

…

Set objArg1 = objThisIntf.GetCurrentDocument

Return type:

Document

get_sch_ext_container(i_doc: Document) → AnyObject

Note

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

o Func GetSchExtContainer(Document iDoc) As AnyObject

Get the schematic container (e.g. for CATISchBaseFactory

implementation).

Parameters:

iDoc

Document in the session to retreive the container from

oContainer

Schematic container shown in the File+New list

Example:

Dim objThisIntf As SchSession

Dim objArg1 As Document

Dim objArg2 As AnyObject

…

Set objArg2 = objThisIntf.GetSchExtContainer(objArg1)

Parameters:

i_doc (Document) –

Return type:

AnyObject

set_current_application_id(i_application_id: str) → None

Note

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

o Sub SetCurrentApplicationID(CATBSTR iApplicationID)

Set the current application ID.

Parameters:

iApplicationID

Application ID

Example:

Dim objThisIntf As SchSession

Dim strVar1 As String

…

objThisIntf.SetCurrentApplicationIDstrVar1

Parameters:

i_application_id (str) –

Return type:

None

set_current_document(i_cur_doc: Document) → None

Note

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

o Sub SetCurrentDocument(Document iCurDoc)

Set the current document.

Parameters:

iCurDoc

Pointer to current document.

Example:

Dim objThisIntf As SchSession

Dim objArg1 As Document

…

objThisIntf.SetCurrentDocumentobjArg1

Parameters:

i_cur_doc (Document) –

Return type:

None