All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSchPlatformInterfaces Interface CATISchBaseFactory
System.IUnknown
|
+---CATISchBaseFactory
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchBaseFactory
Interface to create Schematic basic set of objects.
Role: This is the factory for schematic base set of objects.
Method Index
- o
CreateNetwork(CATIUnknownList*,CATIUnknownList*,CATIUnknownList**)
- Create schematic networks for query.
- o
CreateRouteAndConnectToObjects(IUnknown*,CATISchAppConnector*,CATISchAppConnector*,CATISchGRRComp*,CATISchGRRComp*,double*,int,CATSchRouteMode,CATISchRoute**)
- Create a route and connect its extremity connectors to input objects.
- o
CreateSchCompGroup(IUnknown*,CATIUnknownList*,CATIUnknownList*,CATISchCompGroupExt**)
- Create a Schematic Component Group object.
- o
CreateSchComponent(IUnknown*,CATIUnknownList*,CATISchComponent**)
- Create a Schematic Component reference.
- o
CreateSchRouteByPoints(IUnknown*,double*,int,CATISchRoute**)
- Create a Schematic Route object with a list of points.
- o
CreateSchRouteByPrim(IUnknown*,CATIUnknownList*,CATISchRoute**)
- Create a Schematic Route object with primitives.
- o
CreateSchZone(IUnknown*,CATIUnknownList*,CATISchZone**)
- Create a Schematic Zone object.
- o
DeleteObject(IUnknown*)
- Delete a schematic object.
Methods
o CreateNetwork
-
Create schematic networks for query. These are volatile objects and will not
be saved in the model.
- Parameters:
-
- iLCntbl
- A list of related objects that belong to the network (CATISchAppConnectable pointers).
These objects do not need to be connected.
This method will do the analysis and returns the network(s) containing these objects.
- iLCntbl
- A list of graphical images interface (CATISchGRR) pointers. Each member corresponds
to the members in iLCntbl.
- oNetwork
- [out, IUnknown#Release] Pointer to the network analysis interface pointers.
o CreateRouteAndConnectToObjects
-
Create a route and connect its extremity connectors to input objects.
- Parameters:
-
- iAppRoute
- Application route (at least a feature)
- See also:
- CATISchAppObjectFactory.AppCreateRoute
- iCntrCompFrom
- Pointer to component connector to connect starting end of the route to
If NULL, no connection is made at this end.
- iCntrCompTo
- Pointer to component connector to connect end of the route to
If NULL, no connection is made at this end.
- iGRRCompFrom
- Pointer to first component graphical image, if NULL, the PRIMARY image
associated with component will be used
- iGRRCompTo
- Pointer to second component graphical image, if NULL, the PRIMARY image
associated with component will be used
- iLDb2PtPath
- A list of X-Y coordinates of points to be used for the route image.
2 doubles per point. Not used if iERouteMode=SchRouteMode_AroundObject
input a NULL for this case
- iSizeOfPath
- Total number of points in the list. 2 times the number of points.
- iERouteMode
- Route mode to use. Only used when iLDb2PtPath is NULL.
- oSchRoute
- Pointer to the new route
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o CreateSchCompGroup
-
Create a Schematic Component Group object.
- Parameters:
-
- iAppGroup
- Application group object (at least a feature)
Optional, it could be NULL. If NULL, one will be created by the platform
- iLGRR
- A list of graphical representation. Optional, it could be NULL.
- iLMembers
- A list of initial members. Optional, it could be NULL.
- oSchGroup
- Pointer to the new group.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o CreateSchComponent
-
Create a Schematic Component reference.
- Parameters:
-
- iAppComponentRef
- Application component reference (at least a feature)
- See also:
- CATISchAppObjectFactory.AppCreateCompRef
- iLGRR
- A list of graphical representations.
- oSchComp
- Pointer to the new component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o CreateSchRouteByPoints
-
Create a Schematic Route object with a list of points.
- Parameters:
-
- iAppRoute
- Application route (at least a feature)
- See also:
- CATISchAppObjectFactory.AppCreateRoute
- iLDbPt
- A list of X-Y coordinates of points. 2 doubles per point.
- iSizeOfPath
- Total number of points in the list. 2 times the number of points.
- oSchRoute
- Pointer to the new route
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o CreateSchRouteByPrim
-
Create a Schematic Route object with primitives.
- Parameters:
-
- iAppRoute
- Application route (at least a feature)
- See also:
- CATISchAppObjectFactory.AppCreateRoute
- iLGRR
- A list of graphical primitives.
pointer).
- oSchRoute
- Pointer to the new route
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o CreateSchZone
-
Create a Schematic Zone object.
- Parameters:
-
- iAppZone
- Application zone object (at least a feature)
- See also:
- CATISchAppObjectFactory.AppCreateZone
- iLGRR
- A list of graphical representation.
- oSchZone
- Pointer to the new zone.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o DeleteObject
-
Delete a schematic object.
- Parameters:
-
- iObject
- interface pointer to the object to be deleted
This object is included in the file: CATISchBaseFactory.h