All Frameworks  Object Hierarchy  This Framework  Indexes

PspAppFactory (Object)

Represents the application factory.
Role: To create, instanciate, delete and query groups, logical lines, compartments and parts.

Method Index

CreateGroup
Creates a group in the current Product.
DeleteCompartment
Delete a compartment instance.
DeleteGroup
Delete a group.
DeleteLogicalLine
Delete a logical line instance.
DeletePart
Delete a part.
GetCompartment
Instanciate a compartment from the catalog into the current Product.
GetLogicalLine
Returns a PspLogicalLine Logical line Instance.
ListCompartments
Retrieves a list of Compartments in the current Product.
ListGroups
Retrieve a list of Groups in the current Product.
ListLogicalLines
Returns a list of logical lines in the current Product.
ListPhysicals
Returns a list of Physical objects in the node.

Methods


o Func CreateGroup( iCurrentProduct,
iGroupType,
iGroupID) As
Creates a group in the current Product.
Parameters:
iCurrentProduct
The current Product to query.
iGroupType
Group Startup type.
iGroupID
Group ID. A default ID will be generated if input is NULL.
Returns:
Created Group instance.
Example: 
 Dim objThisIntf As PspAppFactory
 Dim iobj1 As Product
 Dim iStrVar2 As String
 Dim iStrVar3 As String
 Dim iObj4 As PspGroup
  ...
 Set iObj4=objThisIntf.CreateGroup (iobj1,iStrVar2,iStrVar3 )
o Sub DeleteCompartment( iCompartment)
Delete a compartment instance.
Parameters:
iCompartment
Compartment to be deleted
Example: 
 Dim objThisIntf As PspAppFactory
 Dim iobj1 As PspGroup

 
  ...
 objThisIntf.DeleteCompartment iobj1
o Sub DeleteGroup( iGroup)
Delete a group.
Parameters:
iGroup
Group to be deleted.
Example: 
 Dim objThisIntf As PspAppFactory
 Dim iobj1 As PspGroup

 
  ...
 objThisIntf.DeleteGroup iobj1
o Sub DeleteLogicalLine( iLogicalLine)
Delete a logical line instance.
Parameters:
iLogicalLine
Logical Line to be deleted
Example: 
 Dim objThisIntf As PspAppFactory
 Dim iobj1 As PspLogicalLine

 
  ...
 objThisIntf.DeleteLogicalLine iobj1
o Sub DeletePart( iPart)
Delete a part.
Parameters:
iProduct
Part to be deleted.
Example: 
 Dim objThisIntf As PspAppFactory
 Dim iobj1 As Product

 
  ...
 objThisIntf.DeletePart iobj1
o Func GetCompartment( iCurrentProduct,
iCompartmentID) As
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.
Returns:
Compartment instance.
Example: 
 Dim objThisIntf As PspAppFactory
 Dim iobj1 As Product
 Dim iStrVar2 As String
 Dim iObj3 As PspGroup
  ...
 Set iObj3=objThisIntf.GetCompartment (iobj1,iStrVar2 )
o Func GetLogicalLine( iCurrentProduct,
iLogicalLineID) As
Returns a PspLogicalLine Logical line Instance.
Parameters:
iCurrentProduct
The current Product into which a logical line will be instanciated.
iLogicalLineID
Logical line ID to get from the logical line catalog.
Returns:
Logical line instance.
Example: 
 Dim objThisIntf As PspAppFactory
 Dim iobj1 As Product
 Dim iStrVar2 As String
  ...
 objThisIntf.GetLogicalLine (iobj1,iStrVar2 )
o Func ListCompartments( iCurrentProduct) As
Retrieves a list of Compartments in the current Product.
Parameters:
iCurrentProduct
The current Product to query.
Returns:
A list of Compartmemts ( A list of CATIAPspGroup)
Example: 
 Dim objThisIntf As PspAppFactory
 Dim iobj1 As Product
 Dim objArg2 As PspListOfObjects
 
  ...
 Set ObjArg2 = objThisIntf.ListCompartments (iobj1 )
o Func ListGroups( iCurrentProduct) As
Retrieve a list of Groups in the current Product.
Parameters:
iCurrentProduct
The current Product to query..
Returns:
A list of Groups ( A list of CATIAPspGroup)
Example: 
 Dim objThisIntf As PspAppFactory
 Dim iobj1 As Product
 Dim objArg2 As ListOfObjects
 
  ...
 Set ObjArg2 = objThisIntf.ListGroups (iobj1)
o Func ListLogicalLines( iCurrentProduct) As
Returns a list of logical lines in the current Product.
Parameters:
iCurrentProduct
The current Product to query..
Returns:
A list of logical Lines (A list of PspLogicalLine)
Example: 
 Dim objThisIntf As PspAppFactory
 Dim iobj1 As Product
 Dim objArg2 As PspListOfObjects
 
  ...
 Set ObjArg2 = objThisIntf.ListLogicalLines (iobj1 )
o Func ListPhysicals( iCurrentProduct,
iDomainID) As
Returns a list of Physical objects in the node.
Parameters:
iCurrentProduct
The current Product to query.
iDomainID
Physical objects that have this domain ID. To get list of all in all domains set iDomainID= catPspIDLNone.
Returns:
A list of physical objects (A list of PspPhysical objects)
Example: 
 Dim objThisIntf As PspAppFactory
 Dim iobj1 As Product
 Dim iobjArg2 As CatPspIDLDomainID
 Dim objArg3 As PspListOfObjects
 
  ...
 Set ObjArg3 = objThisIntf.ListPhysicals (iobj1, iobjArg2 )

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