All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchGRR

System.IUnknown
  |
  +---CATISchGRR
 

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


interface CATISchGRR

Interface to manage graphic representations for Schematic basic sets of objects.
Role: To add or remove primitives (members) of a graphic representation of a schematic object.


Method Index


o GetGRRName(char**)
o GetGRRName2(CATUnicodeString&)
Get current name of the GRR.
o GetSchCntrOwners(CATISchAppConnector**,CATISchGRR**)
Get the schematic objects that own this connector graphic representation.
o GetSchObjOwner(CATISchAppConnectable**)
Get the schematic object that owns this graphic representation.
o ListConnectedGRRs(CATISchAppConnectable*,CATICStringList*,CATIUnknownList**,CATIUnknownList**,CATIUnknownList**,CATIUnknownList**)
Get a list of graphical objects that connects to this graphic representation.
o SetGRRName(char*)
o SetGRRName2(CATUnicodeString&)
Set current name of the GRR.

Methods


o GetGRRName
public virtual HRESULT GetGRRName(char** oGRRName) = 0
Deprecated:
V5R15 Use CATISchGRR.GetGRRName2 instead. Get current name of the GRR.
Parameters:
oGRRName
The name of this GRR. A component can be associated with more than one GRRs. Each GRR is identified by a specific name. Valid names are specified by the application when building the component. Every component should have a GRR named "Primary". The GRR by this name is used in the catalog.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetGRRName2
public virtual HRESULT GetGRRName2(CATUnicodeString& oGRRName) = 0
Get current name of the GRR.
Parameters:
oGRRName
The name of this GRR. A component can be associated with more than one GRRs. Each GRR is identified by a specific name. Valid names are specified by the application when building the component. Every component should have a GRR named "Primary". The GRR by this name is used in the catalog.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetSchCntrOwners
public virtual HRESULT GetSchCntrOwners(CATISchAppConnector** oCntrOwner,
CATISchGRR** oGRROwner) = 0
Get the schematic objects that own this connector graphic representation.
Parameters:
oCntrOwner
A schematic connector that owns this connector graphic representation.
oGRROwner
A component or route graphic representation that owns this connector graphic representation.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetSchObjOwner
public virtual HRESULT GetSchObjOwner(CATISchAppConnectable** oGRROwner) = 0
Get the schematic object that owns this graphic representation.
Parameters:
oGRROwner
A schematic object that owns this graphic representation.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListConnectedGRRs
public virtual HRESULT ListConnectedGRRs(CATISchAppConnectable* iGRROwner,
CATICStringList* iLCntbleClassFilter,
CATIUnknownList** oLCntbleGRRs,
CATIUnknownList** oLCntbles,
CATIUnknownList** oLCntrsOnThisObj,
CATIUnknownList** oLCntrsOnConnected) = 0
Get a list of graphical objects that connects to this graphic representation.
Parameters:
iGRROwner
A CATISchAppConnectable that owns this graphic representation. In the case of GRRCntr (this object), iGRROwner is the owner of the owner of this graphic.
oLCntrClassFilter
A list of all the class types for filtering the output application objects list.
oLCntbleGRRs
A list of GRRs connected to this GRR. (members are CATISchGRR interface pointers).
oLCntbles
A list of application objects connected to this object. (members are CATISchAppConnectable interface pointers).
oLCntrsOnThisObj
A list of connectors on this object through which the connection is made. (members are CATISchAppConnector interface pointers).
oLCntrsOnConnected
A list of connectors on the connected objects through which the connection is made. (members are CATISchAppConnector interface pointers). Members in this list corresponds to those in oLCntrsOnThisObj in making the corresponding connections.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetGRRName
public virtual HRESULT SetGRRName( const char* iGRRName) = 0
Deprecated:
V5R15 Use CATISchGRR.SetGRRName2 instead. Set current name of the GRR.
Parameters:
iGRRName
The name of this GRR to be set.
See also:
GetGRRName
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetGRRName2
public virtual HRESULT SetGRRName2( const CATUnicodeString& iGRRName) = 0
Set current name of the GRR.
Parameters:
iGRRName
The name of this GRR to be set.
See also:
GetGRRName
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchGRR.h

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