All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPlantShipInterfaces Interface CATIPspApplication

System.IUnknown
  |
  +---CATIPspApplication
 

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


interface CATIPspApplication

Interface to initialize and query an application.
Role: To activate and query a Plant Ship application.


Method Index


o GetApplicationDomain(CATString&)
Retrieve the application main domain.
o Initialization(CATIContainer*)
Initialize the application environment (load feature start up objects, activate the application.
o Is3DApplication(CATBoolean*)
Is the application that we are dealing with a 3D Application?.
o ListDomains(CATICStringList**)
Retrieve a list of all domain names supported by this application.
o LoadFeatFiles(CATIContainer*)
Load the associated application domains *.

Methods


o GetApplicationDomain
public virtual HRESULT GetApplicationDomain(CATString& oAppDomainName)= 0
Retrieve the application main domain.
Parameters:
oAppDomainName
Application main domain name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o Initialization
public virtual HRESULT Initialization(CATIContainer* iCont)= 0
Initialize the application environment (load feature start up objects, activate the application...)
Parameters:
iCont
The container of the application objects.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o Is3DApplication
public virtual HRESULT Is3DApplication(CATBoolean* obYesOrNo) =0
Is the application that we are dealing with a 3D Application?.
Parameters:
obYesOrNo
TRUE the application is a 3D application. FALSE the application is not a 3D application.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListDomains
public virtual HRESULT ListDomains(CATICStringList** oListOfDomains)= 0
Retrieve a list of all domain names supported by this application.
Parameters:
oListOfDomains
[out, IUnknown#Release] A list of domain names.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o LoadFeatFiles
public virtual HRESULT LoadFeatFiles(CATIContainer* iCont) = 0
Load the associated application domains *.feat and *.CATfct files.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIPspApplication.h

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