pycatia.cat_sch_platform_interfaces.sch_app_object_factory2

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_app_object_factory2.SchAppObjectFactory2(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
SchAppObjectFactory2

Application factory to create application objects.
app_create_comp_ref(i_app_comp_class_type: str, i_doc: Document, o_app_comp: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppCreateCompRef(CATBSTR iAppCompClassType,
Document iDoc,
AnyObject oAppComp)

Create an Application Component reference.

Parameters:

iAppCompClassType
Class type of the Application Component reference.

iDoc
Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.

oAppComp
The new Application Component object created (CATISchAppComponent
interface pointer).

Example:



Dim objThisIntf As SchAppObjectFactory2
Dim strVar1 As String
Dim objArg2 As Document
Dim objArg3 As AnyObject
…
objThisIntf.AppCreateCompRefstrVar1,objArg2,objArg3
Parameters:
Return type:

None

app_create_connection(i_app_cntn_class_type: str, i_doc: Document, o_app_connection: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppCreateConnection(CATBSTR iAppCntnClassType,
Document iDoc,
AnyObject oAppConnection)

Create an Application Connection object.

Parameters:

iAppCntnClassType
Class type of the Application Connection object.
iDoc
Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.

oAppConnection
The new Application Connection object created (CATISchAppConnection
interface pointer).

Example:



Dim objThisIntf As SchAppObjectFactory2
Dim strVar1 As String
Dim objArg2 As Document
Dim objArg3 As AnyObject
…

objThisIntf.AppCreateConnectionstrVar1,objArg2,objArg3
Parameters:

  • i_app_cntn_class_type (str) –

  • i_doc (Document) –

  • o_app_connection (AnyObject) –

Return type:

None

app_create_group(i_app_group_class_type: str, i_doc: Document, o_app_group: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppCreateGroup(CATBSTR iAppGroupClassType,
Document iDoc,
AnyObject oAppGroup)

Create an Application Group object.

Parameters:

iAppGroupClassType
Class type of the Application Group object.
iDoc
Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.

oAppGroup
The new Application Group object created (CATISchAppGroup interface
pointer).

Example:



Dim objThisIntf As SchAppObjectFactory2
Dim strVar1 As String
Dim objArg2 As Document
Dim objArg3 As AnyObject
…
objThisIntf.AppCreateGroupstrVar1,objArg2,objArg3
Parameters:
Return type:

None

app_create_route(i_app_route_class_type: str, i_doc: Document, i_log_line_id: str, o_app_route: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppCreateRoute(CATBSTR iAppRouteClassType,
Document iDoc,
CATBSTR iLogLineID,
AnyObject oAppRoute)

Create an Application Route object.

Parameters:

iAppRouteClassType
Class type of the Application Route object.
iDoc
Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.

iLogLineID
The logical line ID that will contain the new route. This is an
optional input. If could be NULL.
oAppRoute
The new Application Route object created (CATISchAppRoute interface
pointer).

Example:



Dim objThisIntf As SchAppObjectFactory2
Dim strVar1 As String
Dim objArg2 As Document
Dim strVar3 As String
Dim objArg4 As AnyObject
…
objThisIntf.AppCreateRoutestrVar1,objArg2,strVar3,objArg4
Parameters:

  • i_app_route_class_type (str) –

  • i_doc (Document) –

  • i_log_line_id (str) –

  • o_app_route (AnyObject) –

Return type:

None

app_create_route_from_ref(i_route_reference: SchAppRoute, i_doc: Document, i_log_line_id: str, o_app_route: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppCreateRouteFromRef(SchAppRoute iRouteReference,
Document iDoc,
CATBSTR iLogLineID,
AnyObject oAppRoute)

Create an Application Route object with a specific
reference.

Parameters:

iAppRouteRef
Route reference to creaet the output route from
iDoc
Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.

iLogLineID
The logical line ID that will contain the new route. This is an
optional input. If could be NULL.
oAppRoute
The new Application Route object created (CATISchAppRoute interface
pointer).

Example:

Dim objThisIntf As SchAppObjectFactory2
Dim objArg1 As SchAppRoute
Dim objArg2 As Document
Dim strVar3 As String
Dim objArg4 As AnyObject
…
objThisIntf.AppCreateRouteFromRefobjArg1,objArg2,strVar3,objArg4
Parameters:
Return type:

None

app_create_route_with_info(i_app_route_class_type: str, i_app_info: AnyObject, o_app_route: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppCreateRouteWithInfo(CATBSTR iAppRouteClassType,
AnyObject iAppInfo,
AnyObject oAppRoute)

Create an Application Route object with application
information.

Parameters:

iAppRouteClassType
Class type of the Application Route object.
iAppInfo
Application data pointer
oAppRoute
The new Application Route object created (CATISchAppRoute interface
pointer).

Example:



Dim objThisIntf As SchAppObjectFactory2
Dim strVar1 As String
Dim objArg2 As AnyObject
Dim objArg3 As AnyObject
…
objThisIntf.AppCreateRouteWithInfostrVar1,objArg2,objArg3
Parameters:
Return type:

None

app_create_zone(i_app_zone_class_type: str, i_doc: Document, o_app_zone: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppCreateZone(CATBSTR iAppZoneClassType,
Document iDoc,
AnyObject oAppZone)

Create an Application Zone object.

Parameters:

iAppZoneClassType
Class type of the Application Zone object.
iDoc
Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.

oAppZone
The new Application Zone object created (CATISchAppZone interface
pointer).

Example:

Dim objThisIntf As SchAppObjectFactory2
Dim strVar1 As String
Dim objArg2 As Document
Dim objArg3 As AnyObject
…
objThisIntf.AppCreateZonestrVar1,objArg2,objArg3
Parameters:
Return type:

None