Library | Package Java Toolkit

Class ParamValue

package com.ptc.pfc.pfcModelItem;

public class ParamValue
  implements jxobject



Description

This class describes the value of the parameter.

This determines the type of parameter.



Method Summary
booleanGetBoolValue ()
    Get method for attribute "BoolValue"
    If the parameter type is PARAM_BOOLEAN, this is a Boolean value.
ParamValueTypeGetdiscr ()
    Returns the union discriminant value.

doubleGetDoubleValue ()
    Get method for attribute "DoubleValue"
    If the parameter type is PARAM_DOUBLE, this is a double value.
intGetIntValue ()
    Get method for attribute "IntValue"
    If the parameter type is PARAM_INTEGER, this is an integer value.
intGetNoteId ()
    Get method for attribute "NoteId"
    If the parameter type is PARAM_NOTE, this is a note identifier.
StringGetStringValue ()
    Get method for attribute "StringValue"
    If the parameter type is PARAM_STRING, this is a string value.
voidSetBoolValue (boolean value)
    Set method for attribute "BoolValue"
    If the parameter type is PARAM_BOOLEAN, this is a Boolean value.
voidSetDoubleValue (double value)
    Set method for attribute "DoubleValue"
    If the parameter type is PARAM_DOUBLE, this is a double value.
voidSetIntValue (int value)
    Set method for attribute "IntValue"
    If the parameter type is PARAM_INTEGER, this is an integer value.
voidSetNoteId (int value)
    Set method for attribute "NoteId"
    If the parameter type is PARAM_NOTE, this is a note identifier.
voidSetStringValue (String value)
    Set method for attribute "StringValue"
    If the parameter type is PARAM_STRING, this is a string value.

Method Detail

Getdiscr

ParamValueTypeGetdiscr ()


    Returns the union discriminant value.



GetStringValue/SetStringValue

StringGetStringValue ()
voidSetStringValue (String value)


    If the parameter type is PARAM_STRING, this is a string value.

Exceptions thrown (but not limited to):

XBadGetParamValue - Parameter value is not string


Manual References:
Dimensions and Parameters: Accessing the ParamValue Value, Family Tables: Accessing Cell Information, Family Tables: Accessing Cell Information, Dimensions and Parameters: Accessing the ParamValue Value



GetIntValue/SetIntValue

intGetIntValue ()
voidSetIntValue (int value)


    If the parameter type is PARAM_INTEGER, this is an integer value.

Exceptions thrown (but not limited to):

XBadGetParamValue - Parameter value is not an integer


Manual References:
Dimensions and Parameters: Accessing the ParamValue Value, Family Tables: Accessing Cell Information, Family Tables: Accessing Cell Information, Dimensions and Parameters: Accessing the ParamValue Value



GetBoolValue/SetBoolValue

booleanGetBoolValue ()
voidSetBoolValue (boolean value)


    If the parameter type is PARAM_BOOLEAN, this is a Boolean value.

Exceptions thrown (but not limited to):

XBadGetParamValue - Parameter value is not boolean


Manual References:
Dimensions and Parameters: Accessing the ParamValue Value, Family Tables: Accessing Cell Information, Dimensions and Parameters: Accessing the ParamValue Value



GetDoubleValue/SetDoubleValue

doubleGetDoubleValue ()
voidSetDoubleValue (double value)


    If the parameter type is PARAM_DOUBLE, this is a double value.

Exceptions thrown (but not limited to):

XBadGetParamValue - Parameter value is not double


Manual References:
Dimensions and Parameters: Accessing the ParamValue Value, Family Tables: Accessing Cell Information, Family Tables: Accessing Cell Information, Dimensions and Parameters: Accessing the ParamValue Value



GetNoteId/SetNoteId

intGetNoteId ()
voidSetNoteId (int value)


    If the parameter type is PARAM_NOTE, this is a note identifier.

Exceptions thrown (but not limited to):

XBadGetParamValue - Parameter value is not a note identifier


Manual References:
Dimensions and Parameters: Accessing the ParamValue Value