All Frameworks  Object Hierarchy  This Framework  Indexes

SchComponent (Object)

Manage a schematic component.

CreateComponentInst: Create a component instance.
CreateLocalReference: Make a local component reference in another document by copying an existing one in the current document.
FlipConnected: For component that is connected to another component or is inserted into a route.
FlipHorizontal: Mirror transform a component's image about the horizontal-axis centered at the local axis of the component.
FlipOnLine: Mirror the graphical object of this component.
FlipVertical: Mirror transform a component's image about the vertical-axis centered at the local axis of the component.
InsertIntoRouteWithInfo: Insert a component into a route.
IsAReference: Query whether the component is a reference (as opposed to an instance).
IsInserted: Query whether the component is inserted into a route.
OKToFlipConnected: Query whether it is OK to connect the component via next compatible connectors.
OKToFlipHorizontal: Query whether it is OK to flip the component about the horizontal axis.
OKToFlipOnLine: Query whether it is OK to flip the component about the inserted route segment.
OKToFlipVertical: Query whether it is OK to flip the component about vertical axis.
OKToPlaceInSpace: Query whether the component can be placed in free space.
OKToScale: Query whether it is OK to scale the component.
OKToSlide: Query whether the component can be slided.
OKToUninsert: Query whether it is OK to uninsert the component.
PlaceInSpace: Place a component in space, unconnected to other objects.
PlaceOnComponentWithInfo: Place a component connected to another component.
PlaceOnObject: Place a component connected to another component or insert into a route.
QueryConnectAbility: Find the Schematic component information for placement.
Slide: Slide a component (applicable to inserted component only).
Uninsert: Remove all connections of a component with a route.

Methods

o Sub CreateComponentInst(		`iGRR`,
		`iDb6Axis`,
		`oNewComponent`)

Create a component instance. The reference component must exist in current document

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the "Primary" graphical representation will be used.
iDb6Axis: X-axis of the local axis of the new instance Y-axis of the local axis of the new instance X-Y coordinates of the orgin of the new instance. This axis defines the orientation and location of the new instance in space. Optional (could be NULL). If provided, the instance will be and orientated as defined. Else (1.0,0.0,0.0,1.0,0.0,0.0) is used
oNewComponent: Interface pointer to the new component instance placed.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim dbVar2(6) As CATSafeArrayVariant
 Dim objArg3 As SchComponent
  ...
 objThisIntf.CreateComponentInstobjArg1,dbVar2,objArg3

o Func CreateLocalReference( iDocumentToPutCopyIn) As

Make a local component reference in another document by copying an existing one in the current document.

Parameters:

iDocumentToPutCopyIn: Pointer to the document to make the copy in
oSchComp: Pointer to the copy.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As Document
 Dim objArg2 As SchComponent
  ...
 Set objArg2 = objThisIntf.CreateLocalReference(objArg1)

o Sub FlipConnected( iGRR)

For component that is connected to another component or is inserted into a route. This method changes the current connections on this component and connects the component to the next compatible connector (connectors-pair in case of inserted component).

Parameters:

iGRR: Pointer to the component graphical representation object. if NULL the first insert image found will be used.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
  ...
 objThisIntf.FlipConnectedobjArg1

o Sub FlipHorizontal( iGRR)

Mirror transform a component's image about the horizontal-axis centered at the local axis of the component. This component should not be connected to any other object.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first insert image found will be used.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
  ...
 objThisIntf.FlipHorizontalobjArg1

o Sub FlipOnLine( iGRR)

Mirror the graphical object of this component. Ths mirror line is the inserted route segment. The current connections on the component is not changed. case of inserted component).

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first insert image found will be used.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
  ...
 objThisIntf.FlipOnLineobjArg1

o Sub FlipVertical( iGRR)

Mirror transform a component's image about the vertical-axis centered at the local axis of the component. This component should not be connected to any other object.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first insert image found will be used.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
  ...
 objThisIntf.FlipVerticalobjArg1

o Sub InsertIntoRouteWithInfo(		`iInsertInfo`,
		`oNewComponent`,
		`oNewRoute`)

Insert a component into a route. An internal structure is prerequisite to calling this method. This structure is obtained from calling CATISchCompatible::GetBestFitInsertInfo.

Parameters:

iInsertInfo: Pointer to an internal class which contains structured information of a component for placement. This is the output for calling CATISchCompatible::GetBestFitInsertInfo.
oNewComponent: Interface pointer to the new component instance placed.
oNewRoute: Interface pointer to the new route instance, created when the component is inserted into the route

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As AnyObject
 Dim objArg2 As SchComponent
 Dim objArg3 As SchRoute
  ...
 objThisIntf.InsertIntoRouteWithInfoobjArg1,objArg2,objArg3

o Sub IsAReference( oBYes)

Query whether the component is a reference (as opposed to an instance).

Parameters:

oBYes: If TRUE, the component is a reference.

Example:

 Dim objThisIntf As SchComponent
 Dim bVar1 As boolean
  ...
 objThisIntf.IsAReferencebVar1

o Sub IsInserted(		`iGRR`,
		`oBYes`)

Query whether the component is inserted into a route.

Parameters:

iGRR: Pointer to the component graphical representation.
oBYes: If TRUE, the component is currently inserted in a route.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim bVar2 As boolean
  ...
 objThisIntf.IsInsertedobjArg1,bVar2

o Sub OKToFlipConnected(		`iGRR`,
		`oBYes`)

Query whether it is OK to connect the component via next compatible connectors.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first insert image found will be used.
oBYes: If TRUE, then it is OK to flip the component.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim bVar2 As boolean
  ...
 objThisIntf.OKToFlipConnectedobjArg1,bVar2

o Sub OKToFlipHorizontal(		`iGRR`,
		`oBYes`)

Query whether it is OK to flip the component about the horizontal axis.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first insert image found will be used.
oBYes: If TRUE, then it is OK to flip the component.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim bVar2 As boolean
  ...
 objThisIntf.OKToFlipHorizontalobjArg1,bVar2

o Sub OKToFlipOnLine(		`iGRR`,
		`oBYes`,
		`oDb2LinePt`,
		`oDb2LineVec`)

Query whether it is OK to flip the component about the inserted route segment.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first insert image found will be used.
oBYes: If TRUE, then it is OK to flip the component.
oDb2LinePt: Absolute X-Y coordinates of a point on the segment.
oDb2LineVec: Absolute X-Y component vector along the segment.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim bVar2 As boolean
 Dim objArg3 As SchListOfDoubles
 Dim objArg4 As SchListOfDoubles
  ...
 objThisIntf.OKToFlipOnLineobjArg1,bVar2,objArg3,objArg4

o Sub OKToFlipVertical(		`iGRR`,
		`oBYes`)

Query whether it is OK to flip the component about vertical axis.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first insert image found will be used.
oBYes: If TRUE, then it is OK to flip the component.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim bVar2 As boolean
  ...
 objThisIntf.OKToFlipVerticalobjArg1,bVar2

o Sub OKToPlaceInSpace(		`iGRR`,
		`oBYes`)

Query whether the component can be placed in free space.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first insert image found will be used.
oBYes: If TRUE, the component can be slided.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim bVar2 As boolean
  ...
 objThisIntf.OKToPlaceInSpaceobjArg1,bVar2

o Sub OKToScale(		`iGRR`,
		`oBYes`)

Query whether it is OK to scale the component.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first image found will be used.
oBYes: If TRUE, then it is OK to scale the component.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim bVar2 As boolean
  ...
 objThisIntf.OKToScaleobjArg1,bVar2

o Sub OKToSlide(		`iGRR`,
		`oBYes`)

Query whether the component can be slided.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first insert image found will be used.
oBYes: If TRUE, the component can be slided.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim bVar2 As boolean
  ...
 objThisIntf.OKToSlideobjArg1,bVar2

o Sub OKToUninsert(		`iGRR`,
		`oBYes`)

Query whether it is OK to uninsert the component.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first insert image found will be used.
oBYes: If TRUE, then it is OK to uninsert the component.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim bVar2 As boolean
  ...
 objThisIntf.OKToUninsertobjArg1,bVar2

o Sub PlaceInSpace(		`iGRR`,
		`iDb6Axis`,
		`oNewComponent`)

Place a component in space, unconnected to other objects. It will create local reference (from a catalog referenced document) if necessary.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the "Primary" graphical representation will be used.
iDb6Axis[6]: X-axis of the local axis of the new instance Y-axis of the local axis of the new instance X-Y coordinates of the orgin of the new instance. This axis defines the orientation and location of the new instance in space.
oNewComponent: Interface pointer to the new component instance placed.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim dbVar2(6) As CATSafeArrayVariant
 Dim objArg3 As SchComponent
  ...
 objThisIntf.PlaceInSpaceobjArg1,dbVar2,objArg3

o Func PlaceOnComponentWithInfo( iPlaceInfo) As

Place a component connected to another component. An internal structure is prerequisite to calling this method. This structure is obtained from calling CATISchCompatible::GetBestFitPlaceInfo.

Parameters:

iPlaceInfo: Pointer to an internal class which contains structured information of a component for placement. This is the output for calling CATISchCompatible::GetBestFitPlaceInfo.
oNewComponent: Interface pointer to the new component instance placed.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As AnyObject
 Dim objArg2 As SchComponent
  ...
 Set objArg2 = objThisIntf.PlaceOnComponentWithInfo(objArg1)

o Sub PlaceOnObject(		`iGRR`,
		`iDb6Axis`,
		`iObjectToConnect`,
		`oNewComponent`)

Place a component connected to another component or insert into a route.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the "Primary" graphical representation will be used.
iDb6Axis[6]: X-axis of the local axis of the new instance Y-axis of the local axis of the new instance X-Y coordinates of the orgin of the new instance. This axis defines the orientation and location of the new instance in space.
iObjectToConnect: Pointer to a component to connect the new instance to or a route object to insert new component into.
oNewComponent: Interface pointer to the new component instance placed.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim dbVar2(6) As CATSafeArrayVariant
 Dim objArg3 As SchAppConnectable
 Dim objArg4 As SchComponent
  ...
 objThisIntf.PlaceOnObjectobjArg1,dbVar2,objArg3,objArg4

o Func QueryConnectAbility( iGRR) As

Find the Schematic component information for placement.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the "Primary" graphical representation will be used.
oPlaceInfo: Pointer to an internal class which contains structured information of a component for placement. This is the input for calling CATISchCompatible::IsComponentCompatible

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim objArg2 As AnyObject
  ...
 Set objArg2 = objThisIntf.QueryConnectAbility(objArg1)

o Sub Slide(		`iGRR`,
		`iDb2PtToSlideTo`)

Slide a component (applicable to inserted component only). The component is moved along the route and remain inserted.

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first insert image found will be used.
iDb2PtToSlideTo[2]: X-Y coordinates of the point to slide the component to.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
 Dim dbVar2(2) As CATSafeArrayVariant
  ...
 objThisIntf.SlideobjArg1,dbVar2

o Sub Uninsert( iGRR)

Remove all connections of a component with a route. (applicable to inserted component only).

Parameters:

iGRR: Pointer to the component graphical representation. if NULL the first insert image found will be used.

Example:

 Dim objThisIntf As SchComponent
 Dim objArg1 As SchGRRComp
  ...
 objThisIntf.UninsertobjArg1

SchComponent (Object)

Method Index

Methods