All Frameworks  Class Hierarchy  This Framework  Next  Indexes

CATPlantShipInterfaces Interface CATIPspAppFactory

System.IUnknown
  |
  +---CATIPspAppFactory
 

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


interface CATIPspAppFactory

Interface to manage groups, logical lines, compartments.
Role: To create, instanciate, delete and query groups, logical lines, compartments and parts.


Method Index


o CreateGroup(CATIProduct*,CATUnicodeString&,CATUnicodeString&,CATIPspGroup**)
Create a group in the current Product.
o DeleteCompartment(IUnknown*)
Delete a compartment instance.
o DeleteGroup(CATIPspGroup*)
Delete a group.
o DeleteLogicalLine(CATIPspLogicalLine*)
Delete a logical line instance.
o DeletePart(CATIProduct*)
Delete a part.
o GetCompartment(CATIProduct*,CATUnicodeString&,IUnknown**)
Instanciate a compartment from the catalog into the current Product.
o GetLogicalLine(CATIProduct*,CATUnicodeString&,CATIPspLogicalLine**)
Instanciate a logical line from the catalog into the current Product.
o ListCompartments(CATIProduct*,CATIUnknownList**)
Retrieve a list of compartments in the current Product.
o ListGroups(CATIProduct*,CATIUnknownList**)
Retrieve a list of groups in the current Product.
o ListLogicalLines(CATIProduct*,CATIUnknownList**)
Retrieve a list of logical lines in the current Product.

Methods


o CreateGroup
public virtual HRESULT CreateGroup( const CATIProduct* iCurrentProduct,
const CATUnicodeString& iGroupType,
const CATUnicodeString& iGroupID,
CATIPspGroup** oGroup) = 0
Create a group in the current Product. The current Product into which a new group will be instanciated.
Parameters:
iGroupType
Group Startup type.
iGroupID
Group ID. A default ID will be generated if input is NULL.
oGroup
[out, IUnknown#Release] Group instance.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o DeleteCompartment
public virtual HRESULT DeleteCompartment( const IUnknown* iCompartment) = 0
Delete a compartment instance.
Parameters:
iCompartment
Compartment to be deleted.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o DeleteGroup
public virtual HRESULT DeleteGroup( const CATIPspGroup* iGroup) = 0
Delete a group.
Parameters:
iGroup
Group to be deleted.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o DeleteLogicalLine
public virtual HRESULT DeleteLogicalLine( const CATIPspLogicalLine* iLogicalLine) = 0
Delete a logical line instance.
Parameters:
iLogicalLine
Logical line to be deleted.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o DeletePart
public virtual HRESULT DeletePart( const CATIProduct* iProduct) = 0
Delete a part.
Parameters:
iProduct
Part to be deleted.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetCompartment
public virtual HRESULT GetCompartment( const CATIProduct* iCurrentProduct,
const CATUnicodeString& iCompartmentID,
IUnknown** oCompartment) = 0
Instanciate a compartment from the catalog into the current Product.
Parameters:
iCurrentProduct
The current Product into which a compartment will be instanciated.
iCompartmentID
Compartment ID to get from the compartment catalog.
oCompartment
[out, IUnknown#Release] Compartment instance.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetLogicalLine
public virtual HRESULT GetLogicalLine( const CATIProduct* iCurrentProduct,
const CATUnicodeString& iLogicalLineID,
CATIPspLogicalLine** oLogicalLine) = 0
Instanciate a logical line from the catalog into the current Product.
Parameters:
iCurrentProduct
The current Product into which a logical line will be instanciated.
iLogicalLineID
Logical line ID to get from the logical line catalog.
oLogicalLine
[out, IUnknown#Release] Logical line instance.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListCompartments
public virtual HRESULT ListCompartments( const CATIProduct* iCurrentProduct,
CATIUnknownList** oListOfCompartments) = 0
Retrieve a list of compartments in the current Product.
Parameters:
iCurrentProduct
The current Product to query.
oListOfCompartments
[out, IUnknown#Release] List of compartments.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListGroups
public virtual HRESULT ListGroups( const CATIProduct* iCurrentProduct,
CATIUnknownList** oListOfGroups) = 0
Retrieve a list of groups in the current Product.
Parameters:
iCurrentProduct
The current Product to query.
oListOfGroups
[out, IUnknown#Release] List of groups.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListLogicalLines
public virtual HRESULT ListLogicalLines( const CATIProduct* iCurrentProduct,
CATIUnknownList** oListOfLogicalLines) = 0
Retrieve a list of logical lines in the current Product.
Parameters:
iCurrentProduct
The current Product to query.
oListOfLogicalLines
[out, IUnknown#Release] List of logical lines.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIPspAppFactory.h

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