Public Member Function Documentation

new(scalar class)
The object constructor.
Parameters
class
The package name.
Returns
(object) The new class object.
This function calls the _Internal constructor and creates a new AE object.
DESTROY()
The object destructor.
Returns
None.
This function is a finalization method that cleans up the class state when there are no more references to an object or the program exits.
openLog(scalar logfile)
Opens a logfile.
Parameters
logfile
The logfile name.
Returns
None.
This function opens a log file ans sets it to non-blocking mode. it also sets the environment variable nzaeDebugLog to the file handle.
closeLog()
Closes a logfile.
Returns
None.
writeToLog(scalar msg)
Writes the specified message to a logfile.
Parameters
msg
(String) Optional. The message to be written.
Returns
None.
This function writes a message to the logfile specified by the nzaeDebugLog environment variable.
writeToLogVerbose(scalar msg)
Writes the specified message to the logfile if debugging is enabled.
Parameters
msg
The message to be written.
Returns
None.
This function determines if the debug level has been set greater than 0. If so, it writes the message to the logfile.
SetNonBlock(scalar filehandle)
Puts a filehandle in nonblocking mode.
Parameters
fielhandle
The filehandle for which nonblocking mode is set.
Returns
None.
This function puts a file handle into nonblocking mode.
initDebug()
Initializes the name of the logfile and calls the openLog() function.
Returns
None.
This function determines if debugging is enabled for the system. If so, the logfile name is created using environment variables and openLog() is called.
getLogLevelDebug()
Gets the log level debug.
Returns
(integer) The value of _Internal.LOG_LEVEL_DEBUG.
getLogLevelTrace()
Gets the log level trace.
Returns
(integer) The value of _Internal.LOG_LEVEL_TRACE.
log(scalar text, scalar logLevel)
Uses AE logging to display logging text to the user.
Parameters
text
(String) The log text.
logLevel
(String) The log level.
Returns
None.
getDataTypeBool()
Gets the Data Type Bool.
Returns
(integer) The value of _Internal.DATA_TYPE__BOOL.
GetDataTypeInt8()
Gets the Data Type Int8.
Returns
(integer) The value of _Internal.DATA_TYPE__INT8.
GetDataTypeInt16()
Gets the Data Type Int16.
Returns
(integer) The value of _Internal.DATA_TYPE__INT16.
GetDataTypeInt32()
Gets the Data Type Int32.
Returns
(integer) The value of _Internal.DATA_TYPE__INT32.
GetDataTypeInt64()
Gets the Data Type Int64.
Returns
(integer) The value of _Internal.DATA_TYPE__INT64.
getDataTypeDouble()
Gets the Data Type Double.
Returns
(integer) The value of _Internal.DATA_TYPE__DOUBLE.
getDataTypeFloat()
Gets the Data Type Float.
Returns
(integer) The value of _Internal.DATA_TYPE__FLOAT.
getDataTypeNumeric32()
Gets the Data Type Numeric 32.
Returns
(integer) The value of _Internal.DATA_TYPE__NUMERIC32.
getDataTypeNumeric64()
Gets the Data Type Numeric 64.
Returns
(integer) The value of _Internal.DATA_TYPE__NUMERIC64.
getDataTypeNumeric128()
Gets the Data Type Numeric 128.
Returns
(integer) The value of _Internal.DATA_TYPE__NUMERIC128.
getDataTypeFixed()
Gets the Data Type Fixed.
Returns
(integer) The value of _Internal.DATA_TYPE__FIXED.
getDataTypeVariable()
Gets the Data Type Variable.
Returns
(integer) The value of _Internal.DATA_TYPE__VARIABLE.
getDataTypeNationalFixed()
Gets the Data Type National Fixed.
Returns
(integer) The value of _Internal.DATA_TYPE__NATIONAL_FIXED.
getDataTypeNationalVariable()
Gets the Data Type National Variable.
Returns
(integer) The value of _Internal.DATA_TYPE__NATIONAL_VARIABLE.
getDataTypeVarbinary()
Gets the Data Type Varbinary.
Returns
(integer) The value of _Internal.DATA_TYPE__VARBINARY.
getDataTypeNationalGeometry()
Gets the Data Type Geometry.
Returns
(integer) The value of _Internal.DATA_TYPE__GEOMETRY.
getAggregateTypeInitialize()
Gets the Aggregation Type Initialize.
Returns
(integer) The value of _Internal.AGGREGATION_TYPE__INITIALIZE.
getAggregateTypeAccumulate()
Gets the Aggregation Type Accumulate.
Returns
(integer) The value of _Internal.AGGREGATION_TYPE__ACCUMULATE.
getAggregateTypeMerge()
Gets the Aggregation Type Merge.
Returns
(integer) The value of _Internal.AGGREGATION_TYPE__MERGE.
getAggregateTypeFinalResult()
Gets the Aggregation Type Final Result.
Returns
(integer) The value of _Internal.AGGREGATION_TYPE__FINAL_RESULT.
getAggregateTypeEnd()
Gets the Aggregation Type End.
Returns
(integer) The value of _Internal.AGGREGATION_TYPE__END.
getAggregateTypeError()
Gets the Aggregation Type Error.
Returns
(integer) The value of _Internal.AGGREGATION_TYPE__ERROR.
getDataStringHash()
Gets String Data Types in a hash.
Returns
hash<integer,String> The integer denotes the value of string type, the string denotes the name of string type.
getDataNumericHash()
Gets Numeric Data Types in a hash.
Returns
hash<integer,String> The integer denotes the value of numeric type, the string denotes the name of string type.
getDataIntegerHash()
Gets Integer Data Types in a hash.
Returns
hash<integer,String> The integer denotes the value of integer type, the string denotes the name of string type.
getDataTypeName(scalar inputType)
Gets the name of a specified data type.
Parameters
inputType
(DATA_TYPE) The data type.
Returns
(String) The name of the specified data type.
getInputTypes()
Gets a list of input data types.
Returns
The list of input data types.
getNumberOfInputColumns()
Gets the number of input columns.
Returns
(integer) The number of input columns.
This function is valid for function and shaper AEs and when aggregate AEs are in the 'accumulate' processing state.
getNumberOfOutputColumns()
Gets the number of output columns.
Returns
(integer) The number of output columns.
This function is valid for function AEs and when aggregate AEs are in the 'finalize' processing state.
getInputPrecision(scalar columnIndex)
Gets the precision of an input numeric.
Parameters
columnIndex
(integer) The index of the column.
Returns
(integer) The precision of the input string at the specified column index.
This function is valid for function and shaper AEs and when aggregate AEs are in the 'accumulate' processing state.
getInputScale(scalar columnIndex)
Gets the scale of an input numeric.
Parameters
columnIndex
(integer) The index of the column.
Returns
(integer) The scale of the input string at the specified column index.
This function is valid for function and shaper AEs and when aggregate AEs are in the 'accumulate' processing state.
getInputSize(scalar columnIndex)
Gets the size of input column at specified index.
Parameters
columnIndex
(integer) The index of the column.
Returns
(integer) The size of the input string at the specified column index.
This function is valid for function and shaper AEs and when aggregate AEs are in the 'accumulate' processing state.
getInputType(scalar columnIndex)
Gets the data type of input column at specified index.
Parameters
columnIndex
(integer) The index of the column.
Returns
(DATA_TYPE) The data type of the input column at the specified column index.
This function is valid for function and shaper AEs and when aggregate AEs are in the 'accumulate' processing state.
getOutputPrecision(scalar columnIndex)
Gets the precision of an output numeric.
Parameters
columnIndex
(integer) The index of the column.
Returns
(integer) The precision of the output string at the specified column index.
This function is valid for function AEs and when aggregate AEs are in the 'finalize' processing state.
getOutputScale(scalar columnIndex)
Gets the scale of an output numeric.
Parameters
columnIndex
(integer) The index of the column.
Returns
(integer) The scale of the output string at the specified column index.
This function is valid for function AEs and when aggregate AEs are in the 'finalize' processing state.
getOutputSize(scalar columnIndex)
Gets the size of output column at specified index.
Parameters
columnIndex
(integer) The index of the column.
Returns
(integer) The size of the output string at the specified column index.
This function is valid for function AEs and when aggregate AEs are in the 'finalize' processing state.
getOutputType(scalar columnIndex)
Gets the data type of output column at specified index.
Parameters
columnIndex
(integer) The index of the column.
Returns
(DATA_TYPE) The data type of the output column at the specified column index.
This function is valid for function AEs and when aggregate AEs are in the 'finalize' processing state.
getUdfReturnType(scalar columnIndex)
Gets the return data type for a UDF.
Parameters
columnIndex
(integer) The index of the column.
Returns
(DATA_TYPE) The data type of the output field.
This function is valid only for UDF sizer AEs.
isCalledWithOrderByClause()
Determines if the function was called with an ORDER BY clause.
Returns
(Boolean) A value of 1 if the function was called with an ORDER BY clause; otherwise returns 0.
This function is valid only for function AEs.
isCalledWithOverClause()
Determines if the function was called with an OVER clause.
Returns
(Boolean) A value of 1 if the function was called with an OVER clause; otherwise returns 0.
This function is valid only for function AEs.
isCalledWithPartitionByClause()
Determines if the function was called with a PARTITION BY clause.
Returns
(Boolean) A value of 1 if the function was called with a PARTITION BY clause; otherwise returns 0.
This function is valid only for function AEs.
isDataInnerCorrelated()
Determines if the function data is inner-correlated.
Returns
(Boolean) A value of 1 if the function data is inner-correlated; otherwise returns 0.
This function is valid only for function AEs.
isDataLeftCorrelated()
Determines if the function data is left correlated.
Returns
(Boolean) A value of 1 if the function data is left correlated; otherwise returns 0.
This function is valid only for function AEs.
isDataUncorrelated()
Determines if the function data is uncorrelated.
Returns
(Boolean) A value of 1 if the function data uncorrelated; otherwise returns 0.
This function is valid only for function AEs.
getCurrentUsername()
Gets the database username of the current AE being run.
Returns
(String) The current username.
getDatasliceId()
Determines the ID of the dataslice being serviced by the AE.
Returns
(integer) The dataslice ID being serviced by the AE.
getHardwareId()
Determines the ID of the hardware on which the AE is running.
Returns
(integer) The hardware ID for the hardware where the AE is running.
getNumberOfDataSlices()
Gets the number of data slices that are running on the Netezza appliance.
Returns
(integer) The number of data slices running on the Netezza appliance.
getNumberOfSpus()
Gets the number of SPUs sunning on the Netezza appliance.
Returns
(integer) The number of SPUs running on the Netezza appliance.
getSuggestedMemoryLimit()
Gets the suggested memory limit for the AE that is running.
Returns
The suggested memory limit for the AE that is running
getSessionId()
Gets the session ID associated with the AE that is running.
Returns
(integer) The session ID associated with the AE that is running.
getTransactionId()
Gets the transaction ID associated with the AE that is running.
Returns
The transaction ID associated with the AE that is running
isAUserQuery()
Determines if the AE is handling a user query.
Returns
(Boolean) A value of 1 if the AE is handling a user query; otherwise returns 0.
isLoggingEnabled()
Determines if logging is enabled.
Returns
(Boolean) A value of 1 if logging in enabled; otherwise returns 0.
isRunningPostgres()
Determines if the AE is running in Postgres.
Returns
(Boolean) A value of 1 if the AE is running in Prostgres; otherwise returns 0.
isRunningInDbos()
Determines if the AE is running in DBOS.
Returns
(Boolean) A value of 1 if the AE is running in DBOS; otherwise returns 0.
isRunningOnSpu()
Determines if the AE is running on the SPU.
Returns
(Boolean) A value of 1 if the AE is running on the SPU; otherwise returns 0.
isRunningOnHost()
Determines if the AE is running on the host.
Returns
(Boolean) A value of 1 if the AE is running on the host; otherwise returns 0.
setAeInfo(scalar aeInfo)
Sets the AeInfo for the AE object that is running.
Parameters
aeInfo
The AeInfo object.
Returns
None.
getRemoteProtocolCodeControlData()
Gets the Remote Protocol message type Control Data.
Returns
(integer) The value of _AeInternal.REMOTE_PROTOCOL_CODE__CONTROL_DATA.
getRemoteProtocolCodePing()
Gets the Remote Protocol message type Ping.
Returns
(integer) The value of _AeInternal.REMOTE_PROTOCOL_CODE__PING.
getRemoteProtocolCodeRequest()
Gets the Remote Protocol message type Code Request.
Returns
(integer) The value of _AeInternal.REMOTE_PROTOCOL_CODE__REQUEST.
getRemoteProtocolCodeStatus()
Gets the Remote Protocol message type Code Status.
Returns
(integer) The value of _AeInternal.REMOTE_PROTOCOL_CODE__STATUS.
getRemoteProtocolCodeStop()
Gets the Remote Protocol message type Code Stop.
Returns
(integer) The value of _AeInternal.REMOTE_PROTOCOL_CODE__STOP.
getDefaultRequestHandlingStyle()
Gets the default remote request handling style.
Returns
(integer) The value of the default request handling style.
setDefaultRequestHandlingStyle(scalar style)
Sets the default remote request handling style.
Parameters
style
(integer) The value denoting the request handling style for the remote AE.
Returns
None.
This function sets the default remote request handling style for requests to a Remote AE. Options are getRequestHandlingStyleFork and getRequestHandlingStyleSingleThreaded.
getRequestHandlingStyleFork()
Gets the remote request handling style fork handle.
Returns
The value denoting the request fork handling of the remote AE request.
getRequestHandlingStyleSingleThreaded()
Gets the remote request handling style single threaded handle.
Returns
The value denoting the single threaded handling of the remote AE request.
getConnectionPointName()
Returns the connection point name for the AE.
Returns
(String) The connection point name.
getConnectionPointDatasliceId()
Returns the connection point dataslice ID for the AE.
Returns
(integer) The dataslice ID; returns -1 if the AE is not running in remote mode by dataslice. This function returns the dataslice ID where the AE is running.
getConnectionPointSessionId()
Returns the connection point session ID for the AE.
Returns
(integer) The session ID; returns -1 if the AE is not running in remote mode by session. This function returns the session ID where the AE is running.
getConnectionPointTransactionId()
Returns the connection point transaction ID for the AE.
Returns
(integer) The transaction ID; returns -1 if the AE is not running in remote mode by transaction. This function returns the transaction ID where the AE is running.
setConnectionPointName(scalar connectionPointName)
Sets the connection point name for the AE.
Parameters
connectionPointName
(String) The name of the connection point.
Returns
None.
This function sets the connection point name. If using the built-in remote AE launching mechanism, the connection point info is automatically set from the process environment, and this function does not need to be called. An alternative to this function is to allow the deriving class to override the class variable, CONNECTION_POINT_NAME.
setConnectionPointDatasliceId(scalar datasliceId)
Sets the connection point dataslice ID for the AE.
Parameters
datasliceId
(integer) The connection point dataslice ID.
Returns
None.
This function sets the connection point dataslice ID. If using the built-in remote AE launching mechanism, the connection point info is automatically set from the process environment, and this function does not need to be called.
setConnectionPointSessionId(scalar sessionId)
Sets the connection point session ID for the AE.
Parameters
sessionId
(integer) The connection point session ID.
Returns
None.
This function sets the connection point session ID. If using the built-in remote AE launching mechanism, the connection point info is automatically set from the process environment, and this function does not need to be called.
setConnectionPointTransactionId(scalar transactionId)
Sets the connection point transaction ID for the AE.
Parameters
transactionId
(integer) The connection point transaction ID.
Returns
None.
This function sets the connection point transaction ID. If using the built-in remote AE launching mechanism, the connection point info is automatically set from the process environment, and this function does not need to be called.
isLocal()
Determines if the AE that is currently running is a local AE.
Returns
(Boolean) A value of 1 if the AE is a local AE; 0 otherwise.
isRemote()
Determines if the AE that is currently running is a remote AE.
Returns
(Boolean) A value of 1 if the AE is a remote AE; 0 otherwise.
isAggregateAe()
Determines if the AE that is currently running is an aggregate AE.
Returns
(Boolean) A value of 1 if the AE is an aggregate AE; 0 otherwise.
isFunctionAe()
Determines if the AE that is currently running is a function AE.
Returns
(Boolean) A value of 1 if the AE is a function AE; 0 otherwise.
isShaper()
Determines if the AE that is currently running is a shaper/sizer AE.
Returns
(Boolean) A value of 1 if the AE is a shaper/sizer AE; 0 otherwise.
isUda()
Determines if the AE that is currently running is an aggregate AE.
Returns
(Boolean) A value of 1 if the AE is an aggregate AE; 0 otherwise.
isUdf()
Determines if the AE that is currently running is a UDF-based AE.
Returns
(Boolean) A value of 1 if the AE is a UDF based AE; 0 otherwise.
isUdfSizer()
Determines if the AE that is currently running is a UDF sizer AE.
Returns
(Boolean) A value of 1 if the AE is a UDF sizer AE; 0 otherwise.
isUdtf()
Determines if the AE that is currently running is a UDTF-based AE.
Returns
(Boolean) A value of 1 if the AE is a UDTF based AE; 0 otherwise.
isUdtfShaper()
Determines if the AE that is currently running is a UDTF shaper AE.
Returns
(Boolean) A value of 1 if the AE is a UDTF shaper AE; 0 otherwise.
didClassRun()
Determines if the class was run.
Returns
(Boolean) A value of 1 if the class was run; 0 otherwise.
run()
Runs an AE.
Returns
None.
This function determines whether the AE has already been run. If so, it prints an error and exits. If the AE has not run, the function determines whether the AE is remote or local and calls the appropriate run method. For local AEs, when a request is made, this function calls runLocal() on the AE class. For remote AEs, when a request is made, it calls runRemote() on the AE class.
pingNps()
Notifies the Netezza software that work is still being performed and the AE should not be terminated.
Return
None.
This function should be called when there are long period of inactivity with the AE system to notify the NPS that the AE is still working.
runLocal()
This function can be overridden to control morning of local AEs.
Returns
None.
This function, by default, instantiates the AE and then calls runInstance(). The capability to override this function is provided for advanced users, since typically an AE writer does not override he function.
runRemote()
This function can be overridden to control morning of remote AEs.
Returns
None.
This function, by default, creates an AE remote listener, accepts requests from the Netezza software forks or runs single threaded as appropriate, creates instance of the AE, and calls _runInstance(). It also handles exceptions appropriately. The capability to override this function is provided for advanced users since typically an AE writer does not override the function.
_doRemoteRunWork(scalar aeInfo)
This function can be overridden to control how remote AEs are run during single-threaded operation.
Parameters
aeInfo
The object,
Returns
None.
This function, by default, sets the AeInfo for single-threaded operation and calls runInstance(). The function is called from runRemote(). The capability to override this function is provided for advanced users since typically an AE writer does not override the function.
_onIdle()
This function can be overridden to handle idle time for remote AEs.
Returns
None.
runInstance(scalar dontexit)
This function can be overridden to control generic running of an AE instance.
Parameters
dontexit
(Boolean) Optional. A value to prevent exit on completion, where 1 causes the instance to exit and 0 does not.
Returns
None.
This function, by default calls _setup, _run, _clean Up, done(), and close() for a specified AE instance, and handles exceptions appropriately. This capability is provided for advanced users since typically an AE writer does not override the function.
_setup()
This function can be overridden for one-time setup of the AE instance.
Returns
None.
This function is called by runInstance() immediately after creating the instance of the AE. It is possible to override the new function of the AE to perform the initialization, however, it is preferable to perform custom initialization in _setup to guarantee appropriate setup of the underlying Perl AE system before performing custom initialization. This provides better exception handling during custom initialization.
_run()
This function can be overridden to handle generic running of AEs.
Returns
None.
This function is called for all AEs by default. Typically, an AE writer should import the Ae class and override runUdtf, runUdf, runUda, runShaper, or runSizer as appropriate. This capability is provided for advanced users since typically an AE writer does not override the function.
runUdtf()
This function can be overridden to handle running a UDTF.
Returns
None.
This function, by default, fetches input rows and calls _getFunctionResult(), then outputs the result of the _getFunctionResult() function. The AE writer can override _getFunctionResult() to output more or less than one line of output.
runUdf()
This function may be overridden to handle running a UDF.
Returns
None.
This function, by default, iterates through rows and sends data to getFunctionResults(), then outputs the results of the _getFunctionResult() fiction. An AE writer can override _getFunctionResult() for a simpler interface to UDF functionality.
runShaper()
This function must be overridden to handle running a Shaper.
Returns
None.
This function must be overridden to implement shaper functionality.
runSizer()
This function must be overridden to run Sizer function.
Returns
None.
This function must be overridden to implement sizer functionality.
_cleanUp()
This function may be overridden for one-time clean-up of the AE.
Returns
None..
iter()
This function may be overridden to iterate over input rows, call getFunctionResult() and send to output.
Returns
None.
This function, by default, iterates over the input row, calls getFunctionResult() and passes its results to the output functions. An AE writer can override this function for a simpler interface to UDF functionality.
_initializeResult()
This function must be overridden to initialize state for an aggregate function.
Returns
None.
_accumulate()
This function must be overridden to run aggregation functionality over values in the same dataslice.
Returns
None.
_merge()
This function must be overridden to merge states gathered from various dataslices.
Returns
None.
_finalResult()
This function must be overridden to set and return the final result for an aggregate function.
Returns
None.
runUda()
This function runs the user-defined aggregate function.
Returns
None.
This function, by default, gets the aggregation type and depending on the type calls the appropriate function: initialize, accumulate, merge, or finalize. This can be override by the user for more granular control of the aggregate function operation.
_handleRemoteProtocol(scalar code, scalar data)
This function may be overridden to handle generic remote protocol functionality.
Parameters
code
(integer) The remote protocol code identifying the remote protocol request.
data
(String) The remote protocol data.
Returns
(tuple<integer,String>) A tuple of the output code, where 0 means a size of zero K, and the return data.
This function is not typically override. It is more typical to override either _getRemoteProtocolStatus(), _handleremoteProtocolControlData, _handleRemoteProtocolRequest, or _handleRemoteProtocolStopRequest(). However, this capability is provided for the advanced AE writer.
_handleRemoteProtocolControlData(scalar data)
This function may be overridden to handle generic remote protocol control of data.
Parameters
data
(String) The data received from the remote protocol subsystem.
Returns
(String) The data to be sent to the remote protocol subsystem.
_handleRemoteProtocolStopCommand()
This function may be overridden to handle the remote protocol stop command in a non-standard way.
Returns
None.
This function, by default, calls the DESTROY() function.
_handleRemoteProtocolRequest(scalar request)
This function may be overridden to handle generic remote protocol requests.
Parameters
request
(String) The request received from the remote protocol subsystem.
Returns
(String) The data to be sent to the remote protocol subsystem.
_handlingException(scalar exception)
Handles exceptions by writing to the logfile and sending the user the error, if needed.
Parameters
exception
Optional. The exception string.
Returns
None.
output(list args)
Sets the output of the AE.
Parameters
args
The list of output arguments.
Returns
None.
This function, by default, accepts one or mu arguments and sets the output values or values using these arguments.
setOutputWithList(list theList)
Sets the output value using a list.
Parameters
theList
The list of output arguments.
Returns
None.
This function, given a list of values, sets the output value using those values. It is called in output.
setOutputValue(scalar columnIndex,scalar value)
Checks the output value type using a library function and calls the appropriate set output function.
Parameters
columnIndex
The column index.
value
Optional. The value to be set.
Returns
A Boolean value indicating whether a value was set or not. A value of 1 indicates the value was set; otherwise 0.
This function, given a value, sets the output value. It is called in output.
setOutputNull(scalar columnIndex)
Sets the value at column specified by column index to null.
Parameters
columnIndex
The column index.
Returns
None.
setOutputString(scalar columnIndex,scalar value, scalar length)
Sets the value at column specified by column index to a string value.
Parameters
columnIndex
The column index.
value
The string value to be set.
length
The length of the string value to be set.
Returns
None.
setOutputInt32(scalar columnIndex,scalar value)
Sets the value at column specified by the column index to an Int32 value.
Parameters
columnIndex
The column index.
value
The Int32 value to be set.
Returns
None.
setOutputInt64(scalar columnIndex,scalar value)
Sets the value at column specified by the column index to an Int64 value.
Parameters
columnIndex
The column index.
value
The Int64 value to be set.
Returns
None.
setOutputInt8(scalar columnIndex,scalar value)
Sets the value at column specified by the column index to an Int8 value.
Parameters
columnIndex
The column index.
value
The Int8 value to be set.
Returns
None.
setOutputInt16(scalar columnIndex,scalar value)
Sets the value at column specified by the column index to an Int16 value.
Parameters
columnIndex
The column index.
value
The Int16 value to be set.
Returns
None.
setOutputFloat(scalar columnIndex,scalar value)
Sets the value at column specified by the column index to a float value.
Parameters
columnIndex
The column index.
value
The float value to be set.
Returns
None.
setOutputDouble(scalar columnIndex,scalar value)
Sets the value at column specified by the column index to a double value.
Parameters
columnIndex
The column index.
value
The double value to be set.
Returns
None.
setOutputBool(scalar columnIndex,scalar value)
Sets the value at column specified by the column index to a Bool value.
Parameters
columnIndex
The column index.
value
The double value to be set.
Returns
None.
setOutputUdsData(scalar columnIndex,scalar value)
Sets the value at column specified by the column index to a generic value.
Parameters
columnIndex
The column index.
value
The generic value to be set.
Returns
None.
getInputRow()
Gets a single input row as an array.
Returns
The array containing the row elements.
This function iterates over an input rowans adds the value of each elements in that row to an array.
getInputValue(scalar columnIndex)
Looks up the relevant element in the row.
Parameters
columnIndex
The column index.
Returns
(Boolean )A value indicating whether the value was successfully retrieved. A value of 1 indicates success; otherwise 0.
This function, given a column index, looks up the relevant element in the row and returns each element in that row to an array.
getInputStringLength(scalar columnIndex)
Gets the string length value at column specified by column index.
Parameters
columnIndex
The column index.
Returns
int value.
getInputString(scalar columnIndex)
Gets the string value at column specified by column index.
Parameters
columnIndex
The column index.
Returns
String value.
getInputInt32(scalar columnIndex)
Gets the Int32 value at column specified by column index.
Parameters
columnIndex
The column index.
Returns
Int32 value.
getInputInt64(scalar columnIndex)
Gets the Int64 value at column specified by column index.
Parameters
columnIndex
The column index.
Returns
Int64 value.
getInputInt8(scalar columnIndex)
Gets the Int8 value at column specified by column index.
Parameters
columnIndex
The column index.
Returns
Int8 value.
getInputInt16(scalar columnIndex)
Gets the Int16 value at column specified by column index.
Parameters
columnIndex
The column index.
Returns
Int16 value.
getInputFloat(scalar columnIndex)
Gets the float value at column specified by column index.
Parameters
columnIndex
The column index.
Returns
Float value.
getInputDouble(scalar columnIndex)
Gets the double value at column specified by column index.
Parameters
columnIndex
The column index.
Returns
Double value.
getInputUdsData(scalar columnIndex)
Gets the generic value at column specified by column index.
Parameters
columnIndex
The column index.
Returns
Generic Udsdata value.
getNext()
Loads the new input row into memory.
Returns
None.
getState(scalar columnIndex)
Gets the state for a given column index or all indices.
Parameters
columnIndex
Optional. The column index.
Returns
An array containing input state value elements or a single state value.
This function determines if the column index has been passed in to the function. If so it retrieves the specific values, otherwise it iterates over all state columns and returns an array containing all state values.
getInputState(scalar columnIndex)
Gets the input state for a given column indexer all indices.
Parameters
columnIndex
Optional. The column index.
Returns
An array containing input state value elements or a single state value.
This function determines if the column index has been passed in to the function. If so it retries the specific input state value, otherwise it iterates over all state locums and returns an array containing all inout state values. In this instance "state" is the state to merge.
_setState(list indexOrState, list inState)
Sets a single aggregate value or a list of aggregate values.
Parameters
indexOrState
Either a variable indicating the state index to be set or a list of states. If the value of the inState parameter has elements, then the first element of this array corresponds to the state that is to be set. If the second parameter does not contain any elements, ts indicates a list of state values to be set.
inState
The state of a specific index.
Returns
None.
This function sets a single aggregate value or a list of aggregate values.
getStateValue(scalar index, scalar getMergedState)
Gets value of a state variable.
Parameters
index
The column index of the state variable.
getMergedState
Optional. If set to 1 the value being returned is the merged state. If set to 0 or undefined the value returned is the state to be merged.
Returns
The state value.
getStateString(scalar columnIndex,scalar getInputState)
Gets the string state variable value at column specified by column index.
Parameters
columnIndex
The column index.
getInputState
Indicates whether value to be obtained is state or input value. 0 indicates state value and 1 indicates input value.
Returns
String value.
getStateInt32(scalar columnIndex,scalar getInputState)
Gets the Int32 state variable value at column specified by column index.
Parameters
columnIndex
The column index.
getInputState
Indicates whether value to be obtained is state or input value. 0 indicates merged state value and 1 indicates state to be merged value.
Returns
Int32 value.
getStateInt64(scalar columnIndex,scalar getInputState)
Gets the Int64 state variable value at column specified by column index.
Parameters
columnIndex
The column index.
getInputState
Indicates whether value to be obtained is state or input value. 0 indicates merged state value and 1 indicates state to be merged value.
Returns
Int64 value.
getStateInt8(scalar columnIndex,scalar getInputState)
Gets the Int8 state variable value at column specified by column index.
Parameters
columnIndex
The column index.
getInputState
Indicates whether value to be obtained is state or input value. 0 indicates merged state value and 1 indicates state to be merged value.
Returns
Int8 value.
getStateInt16(scalar columnIndex,scalar getInputState)
Gets the Int16 state variable value at column specified by column index.
Parameters
columnIndex
The column index.
getInputState
Indicates whether value to be obtained is state or input value. 0 indicates merged state value and 1 indicates state to be merged value.
Returns
Int16 value.
getStateFloat(scalar columnIndex,scalar getInputState)
Gets the float state variable value at column specified by column index.
Parameters
columnIndex
The column index.
getInputState
Indicates whether value to be obtained is state or input value. 0 indicates merged state value and 1 indicates state to be merged value.
Returns
Float value.
getStateDouble(scalar columnIndex,scalar getInputState)
Gets the double state variable value at column specified by column index.
Parameters
columnIndex
The column index.
getInputState
Indicates whether value to be obtained is state or input value. 0 indicates merged state value and 1 indicates state to be merged value.
Returns
Double value.
getStateUdsData(scalar columnIndex,scalar getInputState)
Gets the generic state variable value at column specified by column index.
Parameters
columnIndex
The column index.
getInputState
Indicates whether value to be obtained is state or input value. 0 indicates merged state value and 1 indicates state to be merged value.
Returns
Generic Udsdata value.
_setAggregateResult(list result, scalar forFinalResult)
Sets the aggregate result value.
Parameters
result
The result value or array.
forFinalResult
A Boolean value indicating whether the result is final or not. A value of 1 indicates a final value; otherwise 0.
Returns
None.
This function gets the value resulting from an aggregation operation and, using that result, sets the aggregate value.
_setAggregateValue(scalar index, scalar value, scalar forFinalResult)
Sets the return value for an aggregate.
Parameters
index
The index of the value parameter.
value
The value to be set.
forFinalResult
(Boolean) A value indicating whether the result is final or not. A value of 1 indicates a final value; otherwise 0.
Returns
(Boolean) A value indicating whether the result is final or not. A value of 1 indicates a final value; otherwise 0.
This function sets the return value for an aggregate. For the _initializeState(), _accumulate, and _merge functions, this value is the resulting state. For _finalResult the value is the result of the aggregate.
setAggregateNull(scalar columnIndex)
Sets the aggregate or state value at column specified by column index to null.
Parameters
columnIndex
The column index.
Returns
None.
setAggregateString(scalar column Index,scalar value, scalar length)
Sets the aggregate of state value at column specified by column index to a string value.
Parameters
columnIndex
The column index.
value
The string aggregate or state value to be set.
length
The length of the string value to be set.
Returns
None.
setAggregateInt32(scalar columnIndex, scalar value)
Sets the aggregate or state value at the column specified by the column index to an Int32 value.
Parameters
columnIndex
The column index.
value
The Int32 aggregate or state value to be set.
Returns
None.
setAggregateInt64(scalar columnIndex, scalar value)
Sets the aggregate or state value at the column specified by the column index to an Int64 value.
Parameters
columnIndex
The column index.
value
The Int64 aggregate or state value to be set.
Returns
None.
setAggregateInt8(scalar columnIndex, scalar value)
Sets the aggregate or state value at the column specified by the column index to an Int8 value.
Parameters
columnIndex
The column index.
value
The Int8 aggregate or state value to be set.
Returns
None.
setAggregateInt16(scalar columnIndex, scalar value)
Sets the aggregate or state value at the column specified by the column index to an Int16 value.
Parameters
columnIndex
The column index.
value
The Int16 aggregate or state value to be set.
Returns
None.
setAggregateFloat(scalar columnIndex, scalar value)
Sets the aggregate or state value at the column specified by the column index to a float value.
Parameters
columnIndex
The column index.
value
The float aggregate or state value to be set.
Returns
None.
setAggregateDouble(scalar columnIndex, scalar value)
Sets the aggregate or state value at the column specified by the column index to a double value.
Parameters
columnIndex
The column index.
value
The double aggregate or state value to be set.
Returns
None.
setAggregateUdsData(scalar columnIndex, scalar value)
Sets the aggregate or state value at the column specified by the column index to a generic value.
Parameters
columnIndex
The column index.
value
The generic aggregate or state value to be set.
Returns
None.
getNumberOfStateColumns()
Gets the number of state columns.
Returns
(integer) The number of state columns.
getStatePrecision(scalar columnIndex)
Gets the precision of a field a state at the specified column index.
Parameters
columnIndex
The column index.
Returns
(integer) The precision of the column.
getStateScale(scalar columnIndex)
Gets the scale of a field of state at the specified column index.
Parameters
columnIndex
The column index.
Returns
(integer) The scale of the column.
getStateSize(scalar columnIndex)
Gets the size of field of state at the specified column index.
Parameters
columnIndex
The column index.
Returns
(integer) The size of the column.
getStateType(scalar columnIndex)
Gets the data rye of state field at specified index.
Parameters
columnIndex
The column index.
Returns
(DATA_TYPE) The data type of the state column at the specified column index.
getEnvironment()
Returns a hash containing the entire environment.
Returns
(hash<String,String>) Name value pair of AE environment arable and its value.
getEnvironmentVariable(scalar variableName, list defaultValue)
Gets the value of an AE environment variable.
Parameters
variableName
(String) The name of the environment variable to fetch.
defaultValue
(object) The result to be returned if the entry is not found.
Returns
The environment value.
This function returns the environment value for variableName. If no default value is specified and the variable is not in the environment, an exception is thrown.
getSharedLibraryPath(scalar libraryName,scalar caseSensitive)
Gets the path to a shared library.
Parameters
libraryName
(String) The name of the shared library.
caseSensitive
(boolean) Optional. Specifies whether the search should be performed in a case-sensitive manner. The default is 1.
Returns
(String) The full path to the shared library.
This function throws a AeSharedLibraryNotFoundException if the shared library is not found.
yieldSharedLibraries(scalar forProcess)
Returns a hash that yields a shared library name and the corresponding full path for each shared library entry.
Parameters
forProcess
(boolean) Optional. If 1, specifies the shared library names and full paths are for the remote AE process. The default value is 0.
Returns
(hash<String,String>) Each element in the hash yields a library name(asked) and the full path(as value) to that library.