com.apama.md
Event EP


ExtraParam snapshot datastream event.
Member Summary
 integersessionId

The Id of the Source where this datastream event was sent from.
 integerconnectionId

The Id of the Connection this datastream event is for.
 stringsymbol

The symbol which is associated with this datastream event.
 stringdestStreamType

Stream Type that this EP is for (e.g. "com.apama.md.T").
 dictionary<string, string >epValues

A dictionary of Extra Parameter names, and their corresponding value (as a string) passed from the Source/Adapter.
 dictionary<integer, float >__timestamps

The timestamp when this datastream event was sent from the Source/Adapter.
 
Action Summary
 voidaddParam(string paramName, string paramValue)

This function adds an Extra Parameter name and its corresponding value (as an EPSI event) to the list of Extra Parameters. If the parameter already exists, it will be overwritten with this new value.
 stringgetParam(string paramName)

This function returns information about the specified Extra Parameter name as a Extra Parameter Snapshot Item (EPSI) event.
 booleanhasParam(string paramName)

This function allows the user to check whether the specified parameter name is in the list of Extra Parameters returned from the Source/Adapter.
 booleanisEmpty()

This function allows the user to check whether the list of Extra Parameters is empty or not.
 
Member Detail

__timestamps

dictionary<integer, float > __timestamps
The timestamp when this datastream event was sent from the Source/Adapter.

connectionId

integer connectionId
The Id of the Connection this datastream event is for.

destStreamType

string destStreamType
Stream Type that this EP is for (e.g. "com.apama.md.T").

epValues

dictionary<string, string > epValues
A dictionary of Extra Parameter names, and their corresponding value (as a string) passed from the Source/Adapter.

sessionId

integer sessionId
The Id of the Source where this datastream event was sent from.

symbol

string symbol
The symbol which is associated with this datastream event.
Action Detail

addParam

void addParam(string paramName, string paramValue)
This function adds an Extra Parameter name and its corresponding value (as an EPSI event) to the list of Extra Parameters. If the parameter already exists, it will be overwritten with this new value.
Parameters:
paramName - The name of the parameter to add to the list of Control Parameters.
paramValue - The value of the parameter to be added to the list.

getParam

string getParam(string paramName)
This function returns information about the specified Extra Parameter name as a Extra Parameter Snapshot Item (EPSI) event.
Parameters:
paramName - The name of the parameter to get the details for.
Returns:
The value if it has been added, or an empty string if the parameter has not been added to the list.

hasParam

boolean hasParam(string paramName)
This function allows the user to check whether the specified parameter name is in the list of Extra Parameters returned from the Source/Adapter.
Parameters:
paramName - The name of the parameter to check is supported.
Returns:
true if supported, false otherwise.

isEmpty

boolean isEmpty()
This function allows the user to check whether the list of Extra Parameters is empty or not.
Returns:
true if the list is empty, false otherwise.