pycatia.cat_sch_platform_interfaces.sch_app_object_factory

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_factory.SchAppObjectFactory(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
SchAppObjectFactory

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

Note

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

Create an Application Component reference.

Parameters:

iAppCompClassType
Class type of the Application Component reference.

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

Example:



Dim objThisIntf As SchAppObjectFactory
Dim strVar1 As String
Dim objArg2 As AnyObject
…
objThisIntf.AppCreateCompRefstrVar1,objArg2
Parameters:

  • i_app_comp_class_type (str) –

  • o_app_comp (AnyObject) –

Return type:

None

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

Note

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

Create an Application Connection object.

Parameters:

iAppCntnClassType
Class type of the Application Connection object.
oAppConnection
The new Application Connection object created (CATISchAppConnection
interface pointer).

Example:



Dim objThisIntf As SchAppObjectFactory
Dim strVar1 As String
Dim objArg2 As AnyObject
…
objThisIntf.AppCreateConnectionstrVar1,objArg2
Parameters:

  • i_app_cntn_class_type (str) –

  • o_app_connection (AnyObject) –

Return type:

None

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

Note

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

Create an Application Group object.

Parameters:

iAppGroupClassType
Class type of the Application Group object.
oAppGroup
The new Application Group object created (CATISchAppGroup interface
pointer).

Example:



Dim objThisIntf As SchAppObjectFactory
Dim strVar1 As String
Dim objArg2 As AnyObject
…
objThisIntf.AppCreateGroupstrVar1,objArg2
Parameters:

  • i_app_group_class_type (str) –

  • o_app_group (AnyObject) –

Return type:

None

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

Note

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

Create an Application Route object.

Parameters:

iAppRouteClassType
Class type of the Application Route object.
oAppRoute
The new Application Route object created (CATISchAppRoute interface
pointer).
iLogLineID
The logical line ID that will contain the new route. This is an
optional input.

Example:



Dim objThisIntf As SchAppObjectFactory
Dim strVar1 As String
Dim objArg2 As AnyObject
Dim strVar3 As String
…
objThisIntf.AppCreateRoutestrVar1,objArg2,strVar3
Parameters:

  • i_app_route_class_type (str) –

  • o_app_route (AnyObject) –

  • i_log_line_id (str) –

Return type:

None

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

Note

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

Create an Application Route object with a specific
reference.

Parameters:

iAppRouteRef
Route reference to creaet the output route from
oAppRoute
The new Application Route object created (CATISchAppRoute interface
pointer).
iLogLineID
The logical line ID that will contain the new route. This is an
optional input.

Example:



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

None

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

Note

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

Create an Application Zone object.

Parameters:

iAppZoneClassType
Class type of the Application Zone object.
oAppZone
The new Application Zone object created (CATISchAppZone interface
pointer).

Example:



Dim objThisIntf As SchAppObjectFactory
Dim strVar1 As String
Dim objArg2 As AnyObject
…
objThisIntf.AppCreateZonestrVar1,objArg2
Parameters:

  • i_app_zone_class_type (str) –

  • o_app_zone (AnyObject) –

Return type:

None