All Frameworks Class Hierarchy This Framework Indexes
CATPlantShipInterfaces Interface 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 CreateGroup( | const | iCurrentProduct, |
| const | iGroupType, |
| const | iGroupID, |
| | oGroup) |
-
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 DeleteCompartment( | const | iCompartment) |
-
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 DeleteGroup( | const | iGroup) |
-
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 DeleteLogicalLine( | const | iLogicalLine) |
-
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 DeletePart( | const | iProduct) |
-
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 GetCompartment( | const | iCurrentProduct, |
| const | iCompartmentID, |
| | oCompartment) |
-
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 GetLogicalLine( | const | iCurrentProduct, |
| const | iLogicalLineID, |
| | oLogicalLine) |
-
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 ListCompartments( | const | iCurrentProduct, |
| | oListOfCompartments) |
-
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 ListGroups( | const | iCurrentProduct, |
| | oListOfGroups) |
-
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 ListLogicalLines( | const | iCurrentProduct, |
| | oListOfLogicalLines) |
-
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