A convenience helper class for Apama.Services.Scenario.ParameterType.
More...
| static bool Apama.Services.Scenario.ParameterTypeHelper.CanConvertString |
( |
string |
value, |
|
|
ParameterType |
parameterType |
|
) |
| |
|
static |
(deprecated) Utility method to check whether a string representation of a parameter value (in the format used by the Correlator) can be converted to a .NET object, based on its type identifier.
Deprecated - This method is not intended for public use, and will be removed in a future release.
- Parameters
-
| value | the stringified value to be decoded, in the format used by the Apama Correlator. |
| parameterType | the type identifier to indicate which type to convert to. If None is specified, an exception will be thrown. |
- Returns
- true if it can be decoded, false otherwise.
| static object Apama.Services.Scenario.ParameterTypeHelper.ConvertString |
( |
string |
value, |
|
|
ParameterType |
parameterType |
|
) |
| |
|
static |
(deprecated) Utility method to convert from the EPL string representation of a parameter value to a .NET object, based on its type identifier.
Deprecated - This method is not intended for public use, and will be removed in a future release.
Note that this method is for decoding strings in the format used by the Correlator (see also the Apama.Event.Parser namespace for more classes to format and parse EPL strings). User interface code should normally use user-friendly locale-sensitive parsing methods instead.
If the value cannot be parsed, a warning is logged and a default value is returned; this method does not throw an exception unless the parameterType is None.
- Parameters
-
| value | the stringified value to be decoded, in the format used by the Apama EPL. |
| parameterType | the type identifier to indicate which type to convert to. If None is specified, an exception will be thrown. |
- Returns
- an object of the correct type.
| static ParameterType Apama.Services.Scenario.ParameterTypeHelper.FromScenarioType |
( |
string |
value | ) |
|
|
static |
(deprecated) Static utility method to determine the enum value from the scenario version of a type.
Deprecated - This method is not intended for public use, and will be removed in a future release.
- Returns
- One of the static predefined instances of this class, or null for any error case.
- Exceptions
-
| ArgumentException | If the parameter does not represent a valid type. |
| static FieldType Apama.Services.Scenario.ParameterTypeHelper.ToMonitorScriptFieldType |
( |
this ParameterType |
value | ) |
|
|
static |
Get the EPL type that is used to hold values of this scenario parameter type.
- Parameters
-
| value | The scenario parameter type. |
- Returns
- A valid FieldType. Never null.
| static string Apama.Services.Scenario.ParameterTypeHelper.ToMonitorScriptType |
( |
ParameterType |
value | ) |
|
|
static |
Get the String name of the EPL type that is used to hold values of this scenario parameter type.
- Returns
- a string that specifies the MonitorScript type, e.g. "string".
| static string Apama.Services.Scenario.ParameterTypeHelper.ToScenarioType |
( |
ParameterType |
value | ) |
|
|
static |
(deprecated) Get the type as defined in the Scenario definition file (sdf), and which is also returned from the correlator.
Deprecated - This method is not intended for public use, and will be removed in a future release.
- Returns
- a string that specifies the Scenario type, e.g. "enumeration".
