All Frameworks  Object Hierarchy  This Framework  Indexes

PspConnectable (Object)

Represents an Interface to manage object behaviors in making connections.
Role: To specify object behaviors such as adding a connector and removing a connector.

Property Index

Connectors
Returns a list of connectors of the object.
ValidConnectorTypes
Returns a list of Valid connector types on this object.

Method Index

GetConnectorByName
Retrieves a connector with the given name.
ListConnectables
Retrieve a list of connectors of the object.

Properties


o Property Connectors() As (Read Only)
Returns a list of connectors of the object.
Example: 
 Dim objThisIntf As PspConnectable
 Dim objArg1 As CatPspIDLDomainID
 Dim objArg2 As PspListOfBSTRs
  ...
 Set objArg2 = objThisIntf.Connectors
o Property ValidConnectorTypes() As (Read Only)
Returns a list of Valid connector types on this object.
Example: 
 Dim objThisIntf As PspConnectable
 Dim objArg1 As PspListOfBSTRs  
  ...
 Set objArg1 = objThisIntf.ValidConnectorTypes

Methods


o Func GetConnectorByName( iuConnectorName) As
Retrieves a connector with the given name.
Parameters:
iConnectorName
Connector name to look for.
Returns:
Connector with given name.
Example: 
 Dim objThisIntf As PspConnectable
 Dim strVar1 As PspListOfBSTRs
 Dim objArg2 As PspConnector
  ...
 Set objArg2 = objThisIntf.GetConnectorByName (strVar1)
o Sub ListConnectables( iuClassFilter,
oLCntbles,
oLCntrsOnThisObj,
oLCntrsOnConnected)
Retrieve a list of connectors of the object.
Parameters:
iuClassFilter
Class filter list. If iuClassFilter is an empty list then it will get connectors for all the application connector types.
oLCntbles
a list of CATIAPspConnectable objects that connect this object
oLCntrsOnThisObj
a list of connectors on "this" object in the connections ( A list of CATIAPspConnector)
oLCntrsOnConnected
a list of connectors on the other objects that the member of the former list is connected to (positions in oLCntrsOnThisObj and oLCntrsOnConnected corresponds to each other) ( A list of CATIAPspConnector)
Example: 
 Dim objThisIntf As PspConnectable
 Dim objArg1 As PspListOfBSTRs
 Dim objArg2 As PspListofObjects
 Dim objArg3 As PspListofObjects
 Dim objArg4 As PspListofObjects
  ...
 objThisIntf.ListConnectables objArg1,objArg2,objArg3,objArg4

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