com.sl.gmsjrtview
Class GmsRtViewFunctionArgument

java.lang.Object
  com.sl.gmsjrtview.GmsRtViewFunctionArgument

public class GmsRtViewFunctionArgument
extends java.lang.Object

The GmsRtViewCustomFunctionArgument class defines a function argument.

Constructor Summary

GmsRtViewFunctionArgument(java.lang.String argName, int argType)
Creates a GmsRtViewFunctionArgument.

Method Summary

java.lang.String	getArgName() Returns the name of this argument.
int	getArgType() Returns the type of this argument.
double	getDoubleValue(GmsModelVariables functionIcon) Return the double value for this argument obtained from the functionIcon.
int	getIntValue(GmsModelVariables functionIcon) Return the int value for this argument obtained from the functionIcon.
java.lang.String	getStringValue(GmsModelVariables functionIcon) Return the string value for this argument obtained from the functionIcon.
GmsTabularData	getTableValue(GmsModelVariables functionIcon) Return the table value for this argument obtained from the functionIcon.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GmsRtViewFunctionArgument

public GmsRtViewFunctionArgument(java.lang.String argName,
                                 int argType)

Creates a GmsRtViewFunctionArgument.

Parameters:

argName - The name to use for this argument. This will be displayed in the Edit Function dialog.

argType - The type for this argument. Valid values are GMS.G_DOUBLE, GMS.G_INTEGER, GMS.G_STRING, GMS.G_TABLE.

Method Detail

getArgName

public java.lang.String getArgName()

Returns the name of this argument.

getArgType

public int getArgType()

Returns the type of this argument. Returned values are GMS.G_DOUBLE, GMS.G_INTEGER, GMS.G_STRING, GMS.G_TABLE.

getDoubleValue

public double getDoubleValue(GmsModelVariables functionIcon)

Return the double value for this argument obtained from the functionIcon.

Parameters:

functionIcon - the function object

getIntValue

public int getIntValue(GmsModelVariables functionIcon)

Return the int value for this argument obtained from the functionIcon.

Parameters:

functionIcon - the function object

getStringValue

public java.lang.String getStringValue(GmsModelVariables functionIcon)

Return the string value for this argument obtained from the functionIcon.

Parameters:

functionIcon - the function object

getTableValue

public GmsTabularData getTableValue(GmsModelVariables functionIcon)

Return the table value for this argument obtained from the functionIcon.

Parameters:

functionIcon - the function object