Library | Package Java Toolkit

Class ArgValue

package com.ptc.pfc.pfcArgument;

public class ArgValue
  implements jxobject



Description

This interface represents an argument value, which may be one of several different types.
See Also:
pfcArgument.CreateASCIIStringArgValue(String), pfcArgument.CreateBoolArgValue(boolean), pfcArgument.CreateDoubleArgValue(double), pfcArgument.CreateIntArgValue(int), pfcArgument.CreateSelectionArgValue(Selection), pfcArgument.CreateStringArgValue(String), pfcArgument.CreateTransformArgValue(Transform3D), pfcArgument.Argument_Create(String, ArgValue)



Method Summary
StringGetASCIIStringValue ()
    Get method for attribute "ASCIIStringValue"
    Used if the argument value contains a character string.
booleanGetBoolValue ()
    Get method for attribute "BoolValue"
    Used if the argument value contains a boolean.
ArgValueTypeGetdiscr ()
    Returns the union discriminant value.

doubleGetDoubleValue ()
    Get method for attribute "DoubleValue"
    Used if the argument value contains a double.
intGetIntValue ()
    Get method for attribute "IntValue"
    Used if the argument value contains an integer.
SelectionGetSelectionValue ()
    Get method for attribute "SelectionValue"
    Used if the argument value contains a Creo Parametric selection.
StringGetStringValue ()
    Get method for attribute "StringValue"
    Used if the argument value contains a string.
Transform3DGetTransformValue ()
    Get method for attribute "TransformValue"
    Used if the argument value contains a coordinate transformation.
voidSetASCIIStringValue (String value)
    Set method for attribute "ASCIIStringValue"
    Used if the argument value contains a character string.
voidSetBoolValue (boolean value)
    Set method for attribute "BoolValue"
    Used if the argument value contains a boolean.
voidSetDoubleValue (double value)
    Set method for attribute "DoubleValue"
    Used if the argument value contains a double.
voidSetIntValue (int value)
    Set method for attribute "IntValue"
    Used if the argument value contains an integer.
voidSetSelectionValue (Selection value)
    Set method for attribute "SelectionValue"
    Used if the argument value contains a Creo Parametric selection.
voidSetStringValue (String value)
    Set method for attribute "StringValue"
    Used if the argument value contains a string.
voidSetTransformValue (Transform3D value)
    Set method for attribute "TransformValue"
    Used if the argument value contains a coordinate transformation.

Method Detail

Getdiscr

ArgValueTypeGetdiscr ()


    Returns the union discriminant value.



GetIntValue/SetIntValue

intGetIntValue ()
voidSetIntValue (int value)


    Used if the argument value contains an integer.

Exceptions thrown (but not limited to):

XBadGetArgValue - Argument value does not contain an integer


Manual References:
Task Based Application Libraries: Managing Application Arguments, Task Based Application Libraries: Managing Application Arguments



GetDoubleValue/SetDoubleValue

doubleGetDoubleValue ()
voidSetDoubleValue (double value)


    Used if the argument value contains a double.

Exceptions thrown (but not limited to):

XBadGetArgValue - Argument value does not contain a double


Manual References:
Task Based Application Libraries: Managing Application Arguments, Task Based Application Libraries: Managing Application Arguments



GetBoolValue/SetBoolValue

booleanGetBoolValue ()
voidSetBoolValue (boolean value)


    Used if the argument value contains a boolean.

Exceptions thrown (but not limited to):

XBadGetArgValue - Argument value does not contain a boolean


Manual References:
Task Based Application Libraries: Managing Application Arguments, Task Based Application Libraries: Managing Application Arguments



GetASCIIStringValue/SetASCIIStringValue

StringGetASCIIStringValue ()
voidSetASCIIStringValue (String value)


    Used if the argument value contains a character string.

Exceptions thrown (but not limited to):

XBadGetArgValue - Argument value does not contain a character string


Manual References:
Task Based Application Libraries: Managing Application Arguments, Task Based Application Libraries: Managing Application Arguments



GetStringValue/SetStringValue

StringGetStringValue ()
voidSetStringValue (String value)


    Used if the argument value contains a string.

Exceptions thrown (but not limited to):

XBadGetArgValue - Argument value does not contain a string


Manual References:
Task Based Application Libraries: Managing Application Arguments, Task Based Application Libraries: Managing Application Arguments



GetSelectionValue/SetSelectionValue

SelectionGetSelectionValue ()
voidSetSelectionValue (Selection value)


    Used if the argument value contains a Creo Parametric selection.

Exceptions thrown (but not limited to):

XBadGetArgValue - Argument value does not contain a Creo Parametric selection


Manual References:
Task Based Application Libraries: Managing Application Arguments, Task Based Application Libraries: Managing Application Arguments



GetTransformValue/SetTransformValue

Transform3DGetTransformValue ()
voidSetTransformValue (Transform3D value)


    Used if the argument value contains a coordinate transformation.

Exceptions thrown (but not limited to):

XBadGetArgValue - Argument value does not contain a coordinate transformation


Manual References:
Task Based Application Libraries: Managing Application Arguments, Task Based Application Libraries: Managing Application Arguments