All Frameworks  Class Hierarchy  This Framework  Indexes   

CATSchPlatformInterfaces Interface CATISchAppObjectFactory2

Usage: you can reimplement this interface by deriving the supplied CATEASchAppObjectFactory2 adapter class.


interface CATISchAppObjectFactory2

Interface to create application objects.
Application must derived implementation of this interface from CATEASchAppObjectFactory2. Role: This is the factory for application objects that are to associated with Schematic basic set of objects.

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.


Method Index


o AppCreateCompRef(char*,CATDocument*,IUnknown**)
Create an Application Component reference.
o AppCreateConnection(char*,CATDocument*,IUnknown**)
Create an Application Connection object.
o AppCreateGroup(char*,CATDocument*,IUnknown**)
Create an Application Group object.
o AppCreateRoute2(char*,CATDocument*,CATUnicodeString*,IUnknown**)
Create an Application Route object.
o AppCreateRouteFromRef2(CATISchAppRoute*,CATDocument*,CATUnicodeString*,IUnknown**)
Create an Application Route object with a specific reference.
o AppCreateRouteFromRef(CATISchAppRoute*,CATDocument*,char*,IUnknown**)
o AppCreateRouteWithInfo(char*,IUnknown*,IUnknown**)
Create an Application Route object with application information.
o AppCreateRoute(char*,CATDocument*,char*,IUnknown**)
o AppCreateZone(char*,CATDocument*,IUnknown**)
Create an Application Zone object.

Methods


o AppCreateCompRef
public virtual AppCreateCompRef( const iAppCompClassType,
const iDoc,
oAppComp)
Create an Application Component reference.
Parameters:
iAppCompClassType
Class type of the Application Component reference.
iDoc
Pointer to a document to create the object in. If NULL, the document associated with the current Editor will be used.
oAppComp
The new Application Component object created (CATISchAppComponent interface pointer).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppCreateConnection
public virtual AppCreateConnection( const iAppCntnClassType,
const iDoc,
oAppConnection)
Create an Application Connection object.
Parameters:
iAppCntnClassType
Class type of the Application Connection object.
iDoc
Pointer to a document to create the object in. If NULL, the document associated with the current Editor will be used.
oAppConnection
The new Application Connection object created (CATISchAppConnection interface pointer).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppCreateGroup
public virtual AppCreateGroup( const iAppGroupClassType,
const iDoc,
oAppGroup)
Create an Application Group object.
Parameters:
iAppGroupClassType
Class type of the Application Group object.
iDoc
Pointer to a document to create the object in. If NULL, the document associated with the current Editor will be used.
oAppGroup
The new Application Group object created (CATISchAppGroup interface pointer).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppCreateRoute2
public virtual AppCreateRoute2( const iAppRouteClassType,
const iDoc,
const iLogLineID,
oAppRoute)
Create an Application Route object.
Parameters:
iAppRouteClassType
Class type of the Application Route object.
iDoc
Pointer to a document to create the object in. If NULL, the document associated with the current Editor will be used.
iLogLineID
The logical line ID that will contain the new route. This is an optional input. If could be NULL.
oAppRoute
The new Application Route object created (CATISchAppRoute interface pointer).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppCreateRouteFromRef2
public virtual AppCreateRouteFromRef2( iRouteReference,
const iDoc,
const iLogLineID,
oAppRoute)
Create an Application Route object with a specific reference.
Parameters:
iAppRouteRef
Route reference to creaet the output route from
iDoc
Pointer to a document to create the object in. If NULL, the document associated with the current Editor will be used.
iLogLineID
The logical line ID that will contain the new route. This is an optional input. If could be NULL.
oAppRoute
The new Application Route object created (CATISchAppRoute interface pointer).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppCreateRouteFromRef
public virtual AppCreateRouteFromRef( iRouteReference,
const iDoc,
const iLogLineID,
oAppRoute)
Deprecated:
V5R15 Use CATISchAppObjectFactory2.AppCreateRouteFromRef2 instead. Create an Application Route object with a specific reference.
Parameters:
iAppRouteRef
Route reference to creaet the output route from
iDoc
Pointer to a document to create the object in. If NULL, the document associated with the current Editor will be used.
iLogLineID
The logical line ID that will contain the new route. This is an optional input. If could be NULL.
oAppRoute
The new Application Route object created (CATISchAppRoute interface pointer).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppCreateRouteWithInfo
public virtual AppCreateRouteWithInfo( const iAppRouteClassType,
iAppInfo,
oAppRoute)
Create an Application Route object with application information.
Parameters:
iAppRouteClassType
Class type of the Application Route object.
iAppInfo
Application data pointer
oAppRoute
The new Application Route object created (CATISchAppRoute interface pointer).
o AppCreateRoute
public virtual AppCreateRoute( const iAppRouteClassType,
const iDoc,
const iLogLineID,
oAppRoute)
Deprecated:
V5R15 Use CATISchAppObjectFactory2.AppCreateRoute2 instead. Create an Application Route object.
Parameters:
iAppRouteClassType
Class type of the Application Route object.
iDoc
Pointer to a document to create the object in. If NULL, the document associated with the current Editor will be used.
iLogLineID
The logical line ID that will contain the new route. This is an optional input. If could be NULL.
oAppRoute
The new Application Route object created (CATISchAppRoute interface pointer).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppCreateZone
public virtual AppCreateZone( const iAppZoneClassType,
const iDoc,
oAppZone)
Create an Application Zone object.
Parameters:
iAppZoneClassType
Class type of the Application Zone object.
iDoc
Pointer to a document to create the object in. If NULL, the document associated with the current Editor will be used.
oAppZone
The new Application Zone object created (CATISchAppZone interface pointer).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchAppObjectFactory2.h

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