All Frameworks  Object Hierarchy  This Framework  Indexes

SchAppConnectable (Object)

Represents an application object that can be connected to others.

Method Index

AppAddConnector
Add a connector.
AppGetReferenceName
Get the reference name of a connectable.
AppListConnectables
Find all the application objects connected to this object through their connectors.
AppListConnectors
Find all the connectors of this application object.
AppListValidCntrTypes
List the valid application connector types allowed to be created.
AppRemoveConnector
Remove a connector.
AppSetReferenceName
Set the reference name of a connectable.

Methods


o Sub AppAddConnector( iClassType,
oNewAppCntr)
Add a connector.
Parameters:
iClassType
Class type of the connector to be added.
oNewAppCntr
The new Application Connector object created.
Example: 
 Dim objThisIntf As SchAppConnectable
 Dim strVar1 As String
 Dim objArg2 As SchAppConnector
  ...
 objThisIntf.AppAddConnectorstrVar1,objArg2
o Sub AppGetReferenceName( oReferenceName)
Get the reference name of a connectable. It will be displayed in catalogs.
Parameters:
oReferenceName
The name of the reference
Example: 
 Dim objThisIntf As SchAppConnectable
 Dim strVar1 As String
  ...
 objThisIntf.AppGetReferenceNamestrVar1
o Sub AppListConnectables( iLCntbleClassFilter,
oLCntbles,
oLCntrsOnThisObj,
oLCntrsOnConnected)
Find all the application objects connected to this object through their connectors.
Parameters:
oLCntrClassFilter
A list of all the class types for filtering the output application objects list.
oLCntbles
A list of application objects connected to this object. (members are CATISchAppConnectable interface pointers).
oLCntrsOnThisObj
A list of connectors on this object through which the connection is made. (members are CATISchAppConnector interface pointers).
oLCntrsOnConnected
A list of connectors on the connected objects through which the connection is made. (members are CATISchAppConnector interface pointers). Members in this list corresponds to those in oLCntrsOnThisObj in making the corresponding connections.
Example: 
 Dim objThisIntf As SchAppConnectable
 Dim objArg1 As SchListOfBSTRs
 Dim objArg2 As SchListOfObjects
 Dim objArg3 As SchListOfObjects
 Dim objArg4 As SchListOfObjects
  ...
 objThisIntf.AppListConnectablesobjArg1,objArg2,objArg3,objArg4
o Func AppListConnectors( iLCntrClassFilter) As
Find all the connectors of this application object.
Parameters:
oLCntrClassFilter
A list of all the class types for filtering the output connector list.
oLCntrs
A list of connectors included in this connection. (members are CATISchAppConnector interface pointers).
Example: 
 Dim objThisIntf As SchAppConnectable
 Dim objArg1 As SchListOfBSTRs
 Dim objArg2 As SchListOfObjects
  ...
 Set objArg2 = objThisIntf.AppListConnectors(objArg1)
o Func AppListValidCntrTypes() As
List the valid application connector types allowed to be created.
Parameters:
oLValidCntrTypes
A list of connector class types allowed.
Example: 
 Dim objThisIntf As SchAppConnectable
 Dim objArg1 As SchListOfBSTRs
  ...
 Set objArg1 = objThisIntf.AppListValidCntrTypes
o Sub AppRemoveConnector( iCntrToRemove)
Remove a connector.
Parameters:
iCntrToRemove
The application connector object to be removed
Example: 
 Dim objThisIntf As SchAppConnectable
 Dim objArg1 As SchAppConnector
  ...
 objThisIntf.AppRemoveConnectorobjArg1
o Sub AppSetReferenceName( iReferenceName)
Set the reference name of a connectable. It will be displayed in catalogs.
Parameters:
iReferenceName
The name of the reference
Example: 
 Dim objThisIntf As SchAppConnectable
 Dim strVar1 As String
  ...
 objThisIntf.AppSetReferenceNamestrVar1

Copyright © 2003, Dassault Systèmes. All rights reserved.