Indexes  Previous Next

PspFunctional (Object)

Represents Plant Ship functional object.
Role: To access Plant Ship Functional object information.

Property Index

CatalogPartName
Returns catalog part name of physical object that realizes this function.
FunctionStatus
Returns function object status.
PartCatalogName
Returns Part catalog name of physical object that realizes this function.
PartNumber
Returns part number of physical object that realizes this function.
PartType
Returns the part type of physical object that realizes this function.
Physicals
Returns a list of all associated physical objects.
Standard
Return Standard.

Method Index

GetCompatiblePartTypes
Retrieves a list of all physical part types that are compatible with this function.
IsOKToIntegrate
Check it is OK to integrate (realize) this function with a physical part.
IsRealized
Checks if the Function object is realized or not.
IsSpecDriven
Checks if the functional object is specification driven or not.
ListCompatiblePartNumbers
Retrieves a list of compatible Part numbers and part types.

Properties


o Property CatalogPartName() As CATBSTR (Read Only)
Returns catalog part name of physical object that realizes this function.
Example: 
 Dim objThisIntf As PspFunctional
 Dim strVar1 As CATBSTR
  ...
 Set strVar1 = objThisIntf.CatalogPartName
o Property FunctionStatus() As CatPspIDLFunctionStatus (Read Only)
Returns function object status.
Example: 
 Dim objThisIntf As PspPhysical
 Dim objArg1 As CatPspIDLFunctionStatus
  ...
 objArg1 = objThisIntf.FunctionStatus
o Property PartCatalogName() As CATBSTR (Read Only)
Returns Part catalog name of physical object that realizes this function.
Example: 
 Dim objThisIntf As PspFunctional
 Dim strVar1 As CATBSTR
  ...
 strVar1 = objThisIntf.PartCatalogName
o Property PartNumber() As CATBSTR (Read Only)
Returns part number of physical object that realizes this function.
Example: 
 Dim objThisIntf As PspFunctional
 Dim strVar1 As CATBSTR
  ...
 strVar1 = objThisIntf.PartNumber
o Property PartType() As CATBSTR (Read Only)
Returns the part type of physical object that realizes this function.
Example: 
 Dim objThisIntf As PspFunctional
 Dim strVar1 As CATBSTR
  ...
 strVar1 = objThisIntf.PartType
o Property Physicals() As PspListOfObjects (Read Only)
Returns a list of all associated physical objects.
Example: 
 Dim objThisIntf As PspFunctional
 Dim objArg1 As PspListOfObjects
  ...
 Set objArg1 = objThisIntf.Physicals
o Property Standard() As CATBSTR (Read Only)
Return Standard.
Example: 
 Dim objThisIntf As PspFunctional
 Dim strVar1 As CATBSTR
  ...
 strVar1 = objThisIntf.Standard

Methods


o Func GetCompatiblePartTypes(CATBSTR iuStandard) As PspListOfBSTRs
Retrieves a list of all physical part types that are compatible with this function.
Parameters:
iuStandard
Standard name
Returns:
List of Compatible Part Types.
Example: 
 Dim objThisIntf As PspFunctional  
 Dim strVar1 As CATBSTR
 Dim objArg2 As PspListOfBSTRs
 
  ...
 Set objArg1 = objThisIntf.GetCompatiblePartTypes   (strVar1)
o Func IsOKToIntegrate() As boolean
Check it is OK to integrate (realize) this function with a physical part.
Returns:
TRUE if ok to be integrated
Example: 
 Dim objThisIntf As PspFunctional  
 Dim objArg1 As boolean  
  ...
 objArg1 = objThisIntf.IsOKToIntegrate
o Func IsRealized() As boolean
Checks if the Function object is realized or not.
Returns:
TRUE if the object is Realized
Example: 
 Dim objThisIntf As PspFunctional  
 Dim objArg1 As boolean  
  ...
 objArg1 = objThisIntf.IsRealized
o Func IsSpecDriven() As boolean
Checks if the functional object is specification driven or not.
Returns:
TRUE if this object is specification driven.
Example: 
 Dim objThisIntf As PspFunctional  
 Dim objArg1 As boolean  
  ...
 objArg1 = objThisIntf.IsSpecDriven
o Sub ListCompatiblePartNumbers(CATBSTR iuPartType,
CATBSTR iuStandard,
CATBSTR iuCatalogName,
PspListOfBSTRs oLPartTypes,
PspListOfBSTRs oLCatalogPartNames)
Retrieves a list of compatible Part numbers and part types.
Parameters:
iuPartType
part type
iuStandard
Standard name
iuCatalogName
catalog name
oLPartTypes
a list of part types
oLCatalogPartNames
List of catalog part names
Example: 
 Dim objThisIntf As PspFunctional
 Dim strVar1 As CATBSTR
 Dim strVar2 As CATBSTR
 Dim strVar3 As CATBSTR
 Dim objArg4 As PspListOfBSTRs
 Dim objArg5 As PspListOfBSTRs
 
 ..
 ..
 objThisIntf.ListCompatiblePartNumbers strVar1,strVar2,strVar3,objArg4,objArg5

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