Apama API Reference for .NET  10.3.1.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Package Apama.Services.Scenario

Classes

class  IllegalCallingThreadException
 Thrown when an attempt is made to change the state of running scenarios in the data queue processing thread. More...
 
class  InvalidInputParameterException
 InvalidInputParameterException is a specialized exception class that is used by classes of the Scenario Service to indicate that an invalid input parameter has been provided to create or edit a ScenarioInstance. More...
 
interface  IScenarioDefinition
 IScenarioDefinition is the public interface for a class that represents a Scenario (not an instance). More...
 
interface  IScenarioInstance
 IScenarioInstance is the public interface for a class that represents a Scenario instance. More...
 
interface  IScenarioService
 IScenarioService is an interface that represents the public API to the ScenarioService. More...
 
class  ParameterTypeHelper
 A convenience helper class for Apama.Services.Scenario.ParameterType. More...
 
struct  ScenarioDefinitionConstants
 
class  ScenarioServiceConfig
 ScenarioServiceConfig is a helper class that assists in building a properties map for use when creating a new ScenarioService via the ScenarioServiceFactory. More...
 
struct  ScenarioServiceConstants
 Constants used by the Scenario Service. More...
 
class  ScenarioServiceException
 ScenarioServiceException is a base exception class for all other specialized exceptions within with the Scenario Service. More...
 
class  ScenarioServiceFactory
 ScenarioServiceFactory is a class that provides factory methods for creating new instances of classes that implement the IScenarioService interface. More...
 

Enumerations

enum  DiscoveryStatus { DiscoveryStatus.None, DiscoveryStatus.Pending, DiscoveryStatus.Active, DiscoveryStatus.Complete }
 An enumeration to represent the discovery status within the Scenario Service. More...
 
enum  InstanceState { InstanceState.Running, InstanceState.Ended, InstanceState.Failed }
 Enum to handle the StateChange event. More...
 
enum  ParameterType {
  ParameterType.None, ParameterType.Boolean, ParameterType.Enumeration, ParameterType.Float,
  ParameterType.Decimal, ParameterType.Integer, ParameterType.String
}
 An enumeration that models the "type" of scenario input/output parameters. More...
 
enum  ScenarioType { Scenario, DataView, Query, Unknown }
 An enumeration that models the "type" of scenario. More...
 

Enumeration Type Documentation

An enumeration to represent the discovery status within the Scenario Service.

The possible String value of the states are "Pending", "Active" and "Complete".

The are three static instances of the class, one for each element in the enum.

  • None indicates an invalid/unitialised state.
  • Pending indicates that the discovery process has not yet started. Possible next states: Active.
  • Active indicates that the discovery process has started but is not yet complete. Possible next states: Pending, Complete.
  • Complete indicates that the discovery process is complete. Possible next states: Pending.
Enumerator
None 

None indicates an invalid/unitialised state.

Pending 

Pending indicates that the discovery process has not yet started.

Active 

Active indicates that the discovery process has started but is not yet complete.

Complete 

Complete indicates that the discovery process is complete.

Enum to handle the StateChange event.

The valid states are Running, Ended and Failed.

  • Running is the default state when an Instance is created.
  • Ended when the instance reaches the END.
  • Failed when the instance died unexpectedly.
Enumerator
Running 

The default state when an Instance is created.

Ended 

The state when the instance reaches the END.

Failed 

The state when the instance died unexpectedly.

An enumeration that models the "type" of scenario input/output parameters.

For extension and helper methods for this type, see Apama.Services.Scenario.ParameterTypeHelper.

There are several type structures used when dealing with scenarios: .NET types, MonitorScript types, and a kind of extension to MonitorScript types that are used within ScenarioManager to add support for enumerations. The point of this enumeration is to ease the development of code that must deal with these types and conversions between them. Note that the Scenario enumeration type is modelled as a string in MonitorScript, and a System.String in .NET.

The following table shows the relationship between these type systems.

ScenarioManager GUI Scenario Type MonitorScript Type .NET Type

Java Type

Text string string System.String java.lang.String
Whole Number integer integer System.Int64 java.lang.Long
Number float float System.Double java.lang.Double
? decimal decimal DecimalFieldValue DecimalFieldValue
True/False boolean boolean System.Boolean java.lang.Boolean
Choice enumeration string System.String java.lang.String
Enumerator
None 

(deprecated) None Type

Deprecated - None is not a supported type for scenario variables, and this enumeration member may be removed in a future release. Please do not use.

Boolean 

Boolean Type

Enumeration 

Enumeration Type

Float 

Float Type

Decimal 

Decimal Type

Integer 

Integer Type

String 

String Type

An enumeration that models the "type" of scenario.

There are several scenario types: ordinary Scenarios, DataViews and Queries. The point of this enumeration is to ease the distinction between them. Unkown is used for types that cannot be resolved or is none of the above.

Submit a bug or feature
Copyright (c) 2013-2019 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG.