Class PvxState

This object is used by the ProvideX Event Manager to store information about the current state for an event.

Build Information

Author Jarett Smith
Date Nov 16, 2006
Outputfile PvxState.pvc
Forcelinenumbers false

Constructor

Create a new object to store the state information for the specified event

ParameterDescription
initMajor$ The major code used to identify the event
initMinor$ The minor code used to identify the event

Properties

No Properties

Methods

FUNCTION addArgument(eclipseData)

Add an argument

ParameterDescription
eclipseData A reference to [ProvideX Class:pvx_data]
FUNCTION argumentIterator()

Initialize an iterator for the arguments [ProvideX Library Class:*obj/group] object

Returns A reference to [ProvideX Class:iterator]
FUNCTION containsArgument(argKey$)

ParameterDescription
argKey$ The name of the argument to be found.
Returns A simple boolean (0=False, 1=true) if there is an argument with the name specified.
FUNCTION deleteArgument(argKey$)

Delete an argument with the name specified, if it exists

ParameterDescription
argKey$ The name of the argument to be deleted
FUNCTION getArgument(argKey$)

ParameterDescription
argKey$ The name of the argument to be found.
Returns A reference to [ProvideX Class:pvx_data] for the argument with the name specified
FUNCTION getArgumentValue$(thisName$)

ParameterDescription
thisName$ The name of the argument to be found.
Returns The value for the string argument with the name specified
FUNCTION getArgumentValue(thisName$)

ParameterDescription
thisName$ The name of the argument to be found.
Returns The value for the numeric argument with the name specified
FUNCTION getBooleanPreference(thisName$)

ParameterDescription
thisName$ The name of the argument to be found.
Returns A simple value (0=False, 1=True) for the boolean preference with the name specified
FUNCTION getMajor$()

Returns The major name of the current event
FUNCTION getMinor$()

Returns The minor name of the current event
FUNCTION getStringPreference$(thisName$)

ParameterDescription
thisName$ The name of the argument to be found.
Returns The value of the string preference with the name specified
FUNCTION overrideBoolPref(thisName$, NewValue)

FUNCTION setArgument(argKey$, argValue$)

Set the value of the specified argument to the string value specified

ParameterDescription
argKey$ The name of the argument to be found.
argValue$ The string value to be assigned
FUNCTION setArgument(argKey$, argValue)

Set the value of the specified argument to the numeric value specified

ParameterDescription
argKey$ The name of the argument to be found.
argValue The numeric value to be assigned