All Frameworks  Class Hierarchy  This Framework  Indexes   

CATPlantShipInterfaces Interface CATIPspAttribute

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIPspAttribute

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


Method Index


o GetLiteral(CATUnicodeString&,CATICkeParm**)
Get the parameter associated with the attribute.
o GetType(CATUnicodeString&,CATAttrKind&)
Return the type of attribute.
o IsDerivable(CATUnicodeString&,CATBoolean*)
Check if the attribute can be derived from its logical line.
o IsDerived(CATUnicodeString&,CATBoolean*)
Check if the attribute value is derived from its logical line.
o IsDiscrete(CATUnicodeString&,CATBoolean&,int&)
Test if a discrete attribute.
o IsReadOnly(CATUnicodeString&,CATBoolean&)
Check if the read only attribute is to be displayed writable in Properties Panel.
o ListAttributes(CATUnicodeString&,CATListValCATUnicodeString**)
List all attribute names available in the given domain.
o ListDiscreteValues(CATUnicodeString&,CATListValCATUnicodeString&,CATListValCATUnicodeString&)
List encode type of discrete values.
o ListDiscreteValues(CATUnicodeString&,void*)
o ListDomainNames(CATListValCATUnicodeString**)
List available domain names.
o ListDoubleDiscreteValues(CATUnicodeString&,CATListOfDouble&)
List standard type of double (real) discrete values.
o ListIntegerDiscreteValues(CATUnicodeString&,CATListOfInt&)
List standard type of integer discrete values.
o ListStringDiscreteValues(CATUnicodeString&,CATListValCATUnicodeString&)
List standard type of string discrete values.
o ResetDerivedAttr(CATUnicodeString&)
Reset the attribute value to be derived from its logical line.
o UnsetAttrValue(CATUnicodeString&)
Unset the attribute value.

Methods


o GetLiteral
public virtual GetLiteral( const iAttributeName,
oCkeParm)
Get the parameter associated with the attribute.
Parameters:
iAttributeName
An attribute name.
oCkeParm
[out, IUnknown#Release] A parameter for this attribute.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetType
public virtual GetType( const iAttributeName,
oType)
Return the type of attribute.
Parameters:
iAttributeName
Attribute name.
oType
Attribute type.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o IsDerivable
public virtual IsDerivable( const iAttributeName,
oBYes)
Check if the attribute can be derived from its logical line.
Parameters:
iAttributeName
An attribute name.
oBYes
If TRUE, then it is derivable from the logical line.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o IsDerived
public virtual IsDerived( const iAttributeName,
oBYes)
Check if the attribute value is derived from its logical line.
Parameters:
iAttributeName
An attribute name.
oBYes
If TRUE, then its value is derived from the logical line.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o IsDiscrete
public virtual IsDiscrete( const iAttributeName,
oStatus,
oDiscreteType)
Test if a discrete attribute.
Parameters:
iAttributeName
Attribute name.
oStatus
status.
oDiscreteType
=1 standard discrete attribute. =2 Encoded discrete attribute.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o IsReadOnly
public virtual IsReadOnly( const iAttributeName,
oFlag)
Check if the read only attribute is to be displayed writable in Properties Panel.
Parameters:
iAttributeName
An attribute name. if a null string is passed, then it is applicable for all attributes.
oFlag
If TRUE, then its value is derived from the logical line.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListAttributes
public virtual ListAttributes( const iDomain,
oListOfAttributeNames)
List all attribute names available in the given domain.
Parameters:
iDomain
Domain name for attributes.
oListOfAttributeNames
A list of attribute names.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListDiscreteValues
public virtual ListDiscreteValues( const iAttributeName,
oListShortValues,
oListLongValues)
List encode type of discrete values.
Parameters:
iAttributeName
Attribute name.
oListShortValues
short discrete values.
oListLongValues
long discrete values.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListDiscreteValues
public virtual ListDiscreteValues( const iAttributeName,
oListDiscreteValues)
Deprecated:
V5R15 - Use ListStringDiscreteValues, ListDoubleDiscreteValues or ListStringDiscreteValues method instead.
List standard type of discrete values.
Parameters:
iAttributeName
Attribute name.
oListDiscreteValues
discrete values.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListDomainNames
public virtual ListDomainNames( oListOfDomains)
List available domain names.
Parameters:
oListOfDomains
A list of domain names associated to the attribute.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListDoubleDiscreteValues
public virtual ListDoubleDiscreteValues( const iAttrName,
oListDbValues)
List standard type of double (real) discrete values. Use it for attribute of type tk_double.
Parameters:
iAttributeName
Attribute name.
oListDbValues
double discrete values.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListIntegerDiscreteValues
public virtual ListIntegerDiscreteValues( const iAttrName,
oListIntValues)
List standard type of integer discrete values. Use it for attribute of type tk_integer.
Parameters:
iAttributeName
Attribute name.
oListIntValues
integer discrete values.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListStringDiscreteValues
public virtual ListStringDiscreteValues( const iAttrName,
oListStrValues)
List standard type of string discrete values. Use it for attribute of type tk_string.
Parameters:
iAttributeName
Attribute name.
oListStrValues
string discrete values.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ResetDerivedAttr
public virtual ResetDerivedAttr( const iAttributeName)
Reset the attribute value to be derived from its logical line.
Parameters:
iAttributeName
An attribute name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o UnsetAttrValue
public virtual UnsetAttrValue( const iAttributeName)
Unset the attribute value.
Parameters:
iAttributeName
An attribute name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIPspAttribute.h

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