All Frameworks  Object Hierarchy  This Framework  Indexes

SchAppComponent (Object)

Represents an application component object.

Method Index

AppCreateComponentInst
Create a component instance.
AppCreateLocalReference
Create Local Reference object.
AppGetDefaultGRRName
Get the default graphical representation names of an application component.
AppListGRRNames
Find all the valid graphical representation names of an application component.
AppOKToFlipConnected
Query whether it is OK to reconnect a component to a different compatible configuration.
AppOKToFlipHorizontal
Query whether it is OK to flip the application component about Y.
AppOKToFlipOnLine
Query whether it is OK to flip a component about its inserted line.
AppOKToFlipVertical
Query whether it is OK to flip the application component about X.
AppOKToPlaceInSpace
Query whether the application component can be placed in free space.
AppOKToScale
Query whether it is OK to scale the application component.
AppOKToSlide
Query whether the application component can be slided.
AppOKToUninsert
Query whether it is OK to uninsert the application component.
AppPostFlipConnectedProcess
Post process after reconnecting a component to a different compatible configuration.
AppPostFlipHorizontalProcess
Post process after flipping a component in "x".
AppPostFlipOnLineProcess
Post process after flipping an inserted component about the inserted line segment of the route.
AppPostFlipVerticalProcess
Post process after flipping a component in "y".
AppPostPlaceProcess
Post process after placing an application component instance.
AppPostSlideProcess
Post process after sliding a component.
AppPostSwitchGraphicProcess
Post process after switching a component's graphic representation.
AppPostUninsertProcess
Post process after uninserting a component, disconnecting it from a route.

Methods


o Func AppCreateComponentInst() As
Create a component instance.
Parameters:
oNewAppCompInst
Interface pointer (CATISchAppComponent) to the new application component instance placed.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim objArg1 As AnyObject
  ...
 Set objArg1 = objThisIntf.AppCreateComponentInst
o Func AppCreateLocalReference( iDocToCopyTo) As
Create Local Reference object. Given a reference object (the "this"), This method make a copy of the reference into another document.
Parameters:
iDocToCopyTo
Pointer to a document to copy the reference to,
oNewAppCompRef
Interface pointer (CATISchAppComponent) to the new application component Reference copied.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim objArg1 As Document
 Dim objArg2 As AnyObject
  ...
 Set objArg2 = objThisIntf.AppCreateLocalReference(objArg1)
o Sub AppGetDefaultGRRName( oGRRDefaultName)
Get the default graphical representation names of an application component.
Parameters:
oGRRDefaultName
The default name to be used for the graphical representation of a component
Example: 
 Dim objThisIntf As SchAppComponent
 Dim strVar1 As String
  ...
 objThisIntf.AppGetDefaultGRRNamestrVar1
o Func AppListGRRNames() As
Find all the valid graphical representation names of an application component.
Parameters:
oLGRRNames
A list of all the valid graphical representation names with this connector for connections.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim objArg1 As SchListOfBSTRs
  ...
 Set objArg1 = objThisIntf.AppListGRRNames
o Sub AppOKToFlipConnected( oBYes)
Query whether it is OK to reconnect a component to a different compatible configuration.
Parameters:
oBYes
If TRUE, then it is OK to flip the component.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim bVar1 As boolean
  ...
 objThisIntf.AppOKToFlipConnectedbVar1
o Sub AppOKToFlipHorizontal( oBYes)
Query whether it is OK to flip the application component about Y.
Parameters:
oBYes
If TRUE, then it is OK to flip the component.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim bVar1 As boolean
  ...
 objThisIntf.AppOKToFlipHorizontalbVar1
o Sub AppOKToFlipOnLine( oBYes)
Query whether it is OK to flip a component about its inserted line.
Parameters:
oBYes
If TRUE, then it is OK to flip the component.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim bVar1 As boolean
  ...
 objThisIntf.AppOKToFlipOnLinebVar1
o Sub AppOKToFlipVertical( oBYes)
Query whether it is OK to flip the application component about X.
Parameters:
oBYes
If TRUE, then it is OK to flip the component.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim bVar1 As boolean
  ...
 objThisIntf.AppOKToFlipVerticalbVar1
o Sub AppOKToPlaceInSpace( oBYes)
Query whether the application component can be placed in free space.
Parameters:
oBYes
If TRUE, the component can be slided.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim bVar1 As boolean
  ...
 objThisIntf.AppOKToPlaceInSpacebVar1
o Sub AppOKToScale( oBYes)
Query whether it is OK to scale the application component.
Parameters:
oBYes
If TRUE, then it is OK to scale the component.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim bVar1 As boolean
  ...
 objThisIntf.AppOKToScalebVar1
o Sub AppOKToSlide( oBYes)
Query whether the application component can be slided.
Parameters:
oBYes
If TRUE, the component can be slided.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim bVar1 As boolean
  ...
 objThisIntf.AppOKToSlidebVar1
o Sub AppOKToUninsert( oBYes)
Query whether it is OK to uninsert the application component.
Parameters:
oBYes
If TRUE, then it is OK to uninsert the component.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim bVar1 As boolean
  ...
 objThisIntf.AppOKToUninsertbVar1
o Sub AppPostFlipConnectedProcess()
Post process after reconnecting a component to a different compatible configuration.
Example: 
 Dim objThisIntf As SchAppComponent
  ...
 objThisIntf.AppPostFlipConnectedProcess
o Sub AppPostFlipHorizontalProcess()
Post process after flipping a component in "x".
Example: 
 Dim objThisIntf As SchAppComponent
  ...
 objThisIntf.AppPostFlipHorizontalProcess
o Sub AppPostFlipOnLineProcess()
Post process after flipping an inserted component about the inserted line segment of the route.
Example: 
 Dim objThisIntf As SchAppComponent
  ...
 objThisIntf.AppPostFlipOnLineProcess
o Sub AppPostFlipVerticalProcess()
Post process after flipping a component in "y".
Example: 
 Dim objThisIntf As SchAppComponent
  ...
 objThisIntf.AppPostFlipVerticalProcess
o Sub AppPostPlaceProcess( iNewCompInst,
iCntblConnectedTo)
Post process after placing an application component instance.
Parameters:
iNewCompInst
The newly placed component instance (CATISchComponent interface pointer).
iCntbleConnectedTo
The connectable that the placed component is connected to or placed onto
Example: 
 Dim objThisIntf As SchAppComponent
 Dim objArg1 As SchComponent
 Dim objArg2 As SchAppConnectable
  ...
 objThisIntf.AppPostPlaceProcessobjArg1,objArg2
o Sub AppPostSlideProcess()
Post process after sliding a component.
Example: 
 Dim objThisIntf As SchAppComponent
  ...
 objThisIntf.AppPostSlideProcess
o Sub AppPostSwitchGraphicProcess( iGRR)
Post process after switching a component's graphic representation.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim objArg1 As SchGRR
  ...
 objThisIntf.AppPostSwitchGraphicProcessobjArg1
o Sub AppPostUninsertProcess( iOldAppRoute1,
iOldAppRoute2,
iNewAppRoute)
Post process after uninserting a component, disconnecting it from a route.
Parameters:
iOldAppRoute1
One of the route that was connected to one connector of the inserted component before the operation.
iOldAppRoute2
The other route that was connected to the other connector of the inserted component before the operation. This would be NULL if the component was connected at extremity.
iNewAppRoute
The new route created after the operation. This would be NULL if the component was connected at extremity.
Example: 
 Dim objThisIntf As SchAppComponent
 Dim objArg1 As SchRoute
 Dim objArg2 As SchRoute
 Dim objArg3 As SchRoute
  ...
 objThisIntf.AppPostUninsertProcessobjArg1,objArg2,objArg3

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