All Frameworks  Object Hierarchy  This Framework  Indexes

PspID (Object)

Represents the interface to generate and set IDs for the Distributive System Objects.
Role: This is the interface for Plant Ship object ID generation.

Method Index

GenAndPutIDNoGenSeqNum
Generates ID without the sequence number and is stored on the object.
GenAndPutID
Returns the Generated ID with the sequence number and is stored on the object.
GenIDNoGenSeqNum
Generates ID without the sequence number( if not set previously) and is not stored on the object.
GetID
Gets ID for the object.
GetLocalID
Retrieves local ID of the object.
IsIDGenerated
Checks if the ID on the object is generated( based on the ID Schema).
SetID
Sets ID for the object.

Methods


o Func GenAndPutIDNoGenSeqNum() As
Generates ID without the sequence number and is stored on the object.
Returns:
ID generated
Example: 
 Dim objThisIntf As PspID
 
 Dim iStrVar1 As String
  ...
 iStrVar1 =objThisIntf.GenAndPutIDNoGenSeqNum
o Func GenAndPutID() As
Returns the Generated ID with the sequence number and is stored on the object.
Returns:
ID generated
Example: 
 Dim objThisIntf As PspID
 
 Dim iStrVar1 As String
  ...
 iStrVar1 =objThisIntf.GenAndPutID
o Func GenIDNoGenSeqNum() As
Generates ID without the sequence number( if not set previously) and is not stored on the object.
Parameters:
oGeneratedID
ID generated
Example: 
 Dim objThisIntf As PspID
 
 Dim iStrVar1 As String
  ...
 iStrVar1 =objThisIntf.GenIDNoGenSeqNum
o Func GetID() As
Gets ID for the object.
Returns:
ID of the object.
Example: 
 Dim objThisIntf As PspID
 
 Dim iStrVar1 As String
  ...
 iStrVar1 =objThisIntf.GetID
o Func GetLocalID() As
Retrieves local ID of the object.
Returns:
Local ID generated
Example: 
 Dim objThisIntf As PspID
 
 Dim iStrVar1 As String
  ...
 iStrVar1 =objThisIntf.GetLocalID
o Func IsIDGenerated() As
Checks if the ID on the object is generated( based on the ID Schema).
Parameters:
oBIsGenerated
TRUE if ID is generated from the ID schema
Example: 
 Dim objThisIntf As PspID
 
 Dim bVar1 As boolean
  ...
 bVar1 =objThisIntf.IsIDGenerated
o Sub SetID( iID)
Sets ID for the object.
Parameters:
oID
ID to be set.
Example: 
 Dim objThisIntf As PspID
 
 Dim iStrVar1 As String
  ...
 objThisIntf.SetID iStrVar1

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