All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchComponent2

System.IUnknown
  |
  +---CATISchComponent2
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISchComponent2

Interface to manage a Schematic component object.
Role: Defines Schematic component object behaviors


Method Index


o PlaceInSpace(CATISchGRRComp*,double[6],CATDocument*,CATISchComponent**)
Place a component in space, unconnected to other objects.
o PlaceOnObject(CATISchGRRComp*,double[6],CATISchAppConnectable*,CATDocument*,CATISchComponent**)
Place a component connected to another component or insert into a route.

Methods


o PlaceInSpace
public virtual HRESULT PlaceInSpace(CATISchGRRComp* iGRR,
const double[6] iDb6Axis,
CATDocument* iDoc,
CATISchComponent** oNewComponent) = 0
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.
iDoc
Pointer to a document to create the object in. If NULL, the document associated with the current Editor will be used.
oNewComponent
Interface pointer to the new component instance placed.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o PlaceOnObject
public virtual HRESULT PlaceOnObject(CATISchGRRComp* iGRR,
const double[6] iDb6Axis,
CATISchAppConnectable* iObjectToConnect,
CATDocument* iDoc,
CATISchComponent** oNewComponent) = 0
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.
iDoc
Pointer to a document to create the object in. If NULL, the document associated with the current Editor will be used.
oNewComponent
Interface pointer to the new component instance placed.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchComponent2.h

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