All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMIntegrationUse Interface CATIAdpPLMValueReader

Usage: you must use this class as is. You should never derive it.

interface CATIAdpPLMValueReader

This interface provides a read access to an attribute value.

Role: provides a read access to an attribute value.

Method Index

o GetBooleanValue(CATBoolean&): Gets the value of a boolean.
o GetDoubleValue(double&): Gets the value of a double.
o GetIntValue(int&): Gets the value of an integer.
o GetStringValue(CATUnicodeString&): Gets the value of a string.
o GetTimeValue(CATTime&): Gets the value of a time.
o GetType(): Returns the type of the value.

Methods

o GetBooleanValue

public virtual GetBooleanValue( oValue)

Gets the value of a boolean.
Role: Gives the value of a boolean value.

Parameters:

oValue: [out] the boolean value.

Returns:

S_OK if the boolean value is correctly provided.
E_FAIL if the value is not of type boolean_val.

o GetDoubleValue

public virtual GetDoubleValue( oValue)

Gets the value of a double.
Role: Gives the value of a double value.

Parameters:

oValue: [out] the double value.

Returns:

S_OK if the double value is correctly provided.
E_FAIL if the value is not of type double_val.

o GetIntValue

public virtual GetIntValue( oValue)

Gets the value of an integer.
Role: Gives the value of an integer value.

Parameters:

oValue: [out] The integer value.

Returns:

S_OK if the integer value is correctly provided.
E_FAIL if the value is not of type integer_val.

o GetStringValue

public virtual GetStringValue( oValue)

Gets the value of a string.
Role: Gives the value of a string value.

Parameters:

oValue: [out] the string value.

Returns:

S_OK if the string value is correctly provided.
E_FAIL if the value is not of type string_val.

o GetTimeValue

public virtual GetTimeValue( oValue)

Gets the value of a time.
Role: Gives the value of a time value.

Parameters:

oValue: [out] the CATTime value.

Returns:

S_OK if the time value is correctly provided.
E_FAIL if the value is not of type time_val.

o GetType

public virtual GetType(

)

Returns the type of the value.
Role: This method gives the type of the attribute value.

So for example if the value is an integer_val, use #GetIntValue to get the value.

Returns:: The type of the attribute value; If the value is unset, it returns undefined.

This object is included in the file: CATIAdpPLMValueReader.h
If needed, your Imakefile.mk should include the module: CATPLMIntegrationUse