All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchComponent

System.IUnknown
  |
  +---CATISchComponent
 

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


interface CATISchComponent

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


Method Index


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

Methods


o CreateComponentInst
public virtual HRESULT CreateComponentInst(CATISchGRRComp* iGRR,
double* iDb6Axis,
CATISchComponent** oNewComponent) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o CreateLocalReference
public virtual HRESULT CreateLocalReference(CATDocument* iDocumentToPutCopyIn,
CATISchComponent** oSchComp) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o FlipConnected
public virtual HRESULT FlipConnected(CATISchGRRComp* iGRR) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o FlipHorizontal
public virtual HRESULT FlipHorizontal(CATISchGRRComp* iGRR) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o FlipOnLine
public virtual HRESULT FlipOnLine(CATISchGRRComp* iGRR) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o FlipVertical
public virtual HRESULT FlipVertical(CATISchGRRComp* iGRR) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o InsertIntoRouteWithInfo
public virtual HRESULT InsertIntoRouteWithInfo(IUnknown* iInsertInfo,
CATISchComponent** oNewComponent,
CATISchRoute** oNewRoute) = 0
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.
See also:
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
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o IsAReference
public virtual HRESULT IsAReference(CATBoolean* oBYes) = 0
Query whether the component is a reference (as opposed to an instance).
Parameters:
oBYes
If TRUE, the component is a reference.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o IsInserted
public virtual HRESULT IsInserted(CATISchGRRComp* iGRR,
CATBoolean* oBYes) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o OKToFlipConnected
public virtual HRESULT OKToFlipConnected(CATISchGRRComp* iGRR,
CATBoolean* oBYes) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o OKToFlipHorizontal
public virtual HRESULT OKToFlipHorizontal(CATISchGRRComp* iGRR,
CATBoolean* oBYes) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o OKToFlipOnLine
public virtual HRESULT OKToFlipOnLine(CATISchGRRComp* iGRR,
CATBoolean* oBYes,
double* oDb2LinePt,
double* oDb2LineVec) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o OKToFlipVertical
public virtual HRESULT OKToFlipVertical(CATISchGRRComp* iGRR,
CATBoolean* oBYes) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o OKToPlaceInSpace
public virtual HRESULT OKToPlaceInSpace(CATISchGRRComp* iGRR,
CATBoolean* oBYes) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o OKToScale
public virtual HRESULT OKToScale(CATISchGRRComp* iGRR,
CATBoolean* oBYes) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o OKToSlide
public virtual HRESULT OKToSlide(CATISchGRRComp* iGRR,
CATBoolean* oBYes) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o OKToUninsert
public virtual HRESULT OKToUninsert(CATISchGRRComp* iGRR,
CATBoolean* oBYes) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o PlaceInSpace
public virtual HRESULT PlaceInSpace(CATISchGRRComp* iGRR,
const double[6] iDb6Axis,
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.
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 PlaceOnComponentWithInfo
public virtual HRESULT PlaceOnComponentWithInfo(IUnknown* iPlaceInfo,
CATISchComponent** oNewComponent) = 0
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.
See also:
CATISchCompatible.GetBestFitPlaceInfo
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,
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.
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 QueryConnectAbility
public virtual HRESULT QueryConnectAbility(CATISchGRRComp* iGRR,
IUnknown** oPlaceInfo) = 0
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
See also:
CATISchCompatible.IsComponentCompatible
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o Slide
public virtual HRESULT Slide(CATISchGRRComp* iGRR,
const double[2] iDb2PtToSlideTo) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o Uninsert
public virtual HRESULT Uninsert(CATISchGRRComp* iGRR) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchComponent.h

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