All Frameworks  Object Hierarchy  This Framework  Indexes

PspAttribute (Object)

Represents Attribute Interface to query Plant Ship objects' attributes.
Role: To query and reset attributes.

Method Index

GetMultiStringAttributeValues
Retrieves String values for the input attribute the type catPspIDLMultiString.
GetParameter
Retrieve parameter for the input attribute name.
GetType
Retrieves type of the input attribute.
IsDerived
Retrieve Derived status for the input attribute.
IsDiscrete
Query whether the input attribute is discrete or not.
ListAttributes
Retrieves a list of Attributes of an object in the the input domain ID.
ListDoubleDiscreteValues
Retrieves double discrete values for the input attribute.
ListEncodedDecodedDiscreteValues
Retrieves Encoded-decoded discrete values for the input attribute.
ListIntegerDiscreteValues
Retrieve integer (long) discrete values for the input attribute.
ListStringDiscreteValues
RetrievesString discrete values for the input attribute.
ResetDerivedAttr
Reset derived status of the attribute to not-derived.

Methods


o Func GetMultiStringAttributeValues( iAttributeName) As
Retrieves String values for the input attribute the type catPspIDLMultiString.
Parameters:
iAttributeName
Attribute Name
Returns:
List of string values
Example: 
 Dim objThisIntf As PspAttribute
 Dim strVar1 As CATBSTR
 Dim objArg2 As PspListOfBSTRs
 
  ...
 Set objArg2 = objThisIntf.GetMultiStringAttributeValues (strVar1)
o Func GetParameter( iAttributeName) As
Retrieve parameter for the input attribute name.
Parameters:
iAttributeName
Attribute Name
Returns:
Parameter of the attribute
Example: 
 Dim objThisIntf As PspAttribute
 Dim strVar1 As CATBSTR
 Dim ObjVar2 As Parameter
 
  ...
 Set objArg2 = objThisIntf.GetParameter (strVar1 )
o Func GetType( iAttributeName) As
Retrieves type of the input attribute. If the type of the attribute is catPspIDLMultiString use GetMultiStringAttributeValues. for others, use GetParameter().
Parameters:
iAttributeName
Attribute Name
Returns:
Type of the attribute.
Example: 
 Dim objThisIntf As PspAttribute
 Dim strVar1 As CATBSTR
 Dim eType As CatPspIDLAttrDataType
 
  ...
 eType = objThisIntf.GetType (strVar1)
o Func IsDerived( iAttributeName) As
Retrieve Derived status for the input attribute.
Parameters:
iAttributeName
Attribute Name
Returns:
TRUE if the attribute is derived
Example: 
 Dim objThisIntf As PspAttribute
 Dim strVar1 As CATBSTR
 Dim bIsDerived As boolean
  
  ...
 bIsDerived = objThisIntf.IsDerived (strVar1)
o Func IsDiscrete( iAttributeName,
obStatus) As
Query whether the input attribute is discrete or not.
Parameters:
iAttributeName
Attribute Name
obStatus
TRUE if attribute is discrete else FALSE
Returns:
Discrete Type value 1-Standard 2-Encoded discrete
Example: 
 Dim objThisIntf As PspAttribute
 Dim strVar1 As CATBSTR
 Dim boolVar2 As Boolean
 Dim shortVar3  As Short
  ...
 shortVar3 = objThisIntf.IsDiscrete (strVar1,boolVar2)
o Func ListAttributes( iDomainID) As
Retrieves a list of Attributes of an object in the the input domain ID.
Parameters:
iDomainID
Domain ID. If set to catPspIDLNone, then it will return attributes in all the domains.
Returns:
List of attributes ( A list of CATIAPspGroupables)
Example: 
 Dim objThisIntf As PspAttribute
 Dim objArg1 As CatPspIDLDomainID
 Dim objArg2 As PspListOfBSTRs
  ...
 Set objArg2 = objThisIntf.ListAttributes (objArg1)
o Func ListDoubleDiscreteValues( iAttributeName) As
Retrieves double discrete values for the input attribute.
Parameters:
iAttributeName
Attribute Name
Returns:
Discrete list of double values
Example: 
 Dim objThisIntf As PspAttribute
 Dim strVar1 As CATBSTR
 Dim objArg2 As PspListOfDoubles
 
  ...
 Set objArg2 = objThisIntf.ListDoubleDiscreteValues (strVar1 )
o Sub ListEncodedDecodedDiscreteValues( iAttributeName,
oLDiscreteEncodedValues,
oLDiscreteDecodedValue)
Retrieves Encoded-decoded discrete values for the input attribute.
Parameters:
iAttributeName
Attribute Name
oLDiscreteEncodedValues
Discrete list of encoded string values
oLDiscreteDecodedValue
Discrete list of decoded string values
Example: 
 Dim objThisIntf As PspAttribute
 Dim strVar1 As CATBSTR
 Dim objArg2 As PspListOfBSTRs
 Dim objArg3 As PspListOfBSTRs
 
  ...
 objThisIntf.ListEncodedDecodedDiscreteValues strVar1, objArg2, objArg3
o Func ListIntegerDiscreteValues( iAttributeName) As
Retrieve integer (long) discrete values for the input attribute.
Parameters:
iAttributeName
Attribute Name
Returns:
Discrete list of integer values
Example: 
 Dim objThisIntf As PspAttribute
 Dim strVar1 As CATBSTR
 Dim objArg2 As PspListOfLongs
 
  ...
 Set objArg2 = objThisIntf.ListIntegerDiscreteValues (strVar1)
o Func ListStringDiscreteValues( iAttributeName) As
RetrievesString discrete values for the input attribute.
Parameters:
iAttributeName
Attribute Name
Returns:
Discrete list of string values
Example: 
 Dim objThisIntf As PspAttribute
 Dim strVar1 As CATBSTR
 Dim objArg2 As PspListOfBSTRs
 
  ...
 Set objArg2 = objThisIntf.ListStringDiscreteValues (strVar1)
o Sub ResetDerivedAttr( iAttributeName)
Reset derived status of the attribute to not-derived.
Parameters:
iAttributeName
Attribute Name
Example: 
 Dim objThisIntf As PspAttribute
 Dim strVar1 As CATBSTR

  ...
 objThisIntf.ResetDerivedAttr strVar1

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