Apama  9.12.0.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
com::apama::engine::MonitorScript Class Referenceabstract

A MonitorScript object encapsulates a MonitorScript code fragment, containing package, event and monitor definitions to be injected into an Engine. More...

#include <engine_client_cpp.hpp>

Public Member Functions

virtual const char * getText () const =0
 Retrieve the text of a MonitorScript fragment as a string. More...
 

Friends

AP_ENGINE_CLIENT_API
MonitorScript
createMonitorScript (const char *monitorString)
 This function allows creation of MonitorScript objects. More...
 
AP_ENGINE_CLIENT_API void deleteMonitorScript (MonitorScript *mon)
 This function allows deletion of MonitorScript objects. More...
 
std::ostream & operator<< (std::ostream &stream, const MonitorScript &obj)
 Output a reference to a std::ostream. More...
 
std::ostream & operator<< (std::ostream &stream, const MonitorScript *obj)
 Output a pointer to a std::ostream. More...
 

Detailed Description

A MonitorScript object encapsulates a MonitorScript code fragment, containing package, event and monitor definitions to be injected into an Engine.

Must be created using com::apama::engine::createMonitorScript. Must be delete using com::apama::engine::deleteMonitorScript.

Member Function Documentation

virtual const char* com::apama::engine::MonitorScript::getText ( ) const
pure virtual

Retrieve the text of a MonitorScript fragment as a string.

Returns
C style string containing the text of the MonitorScript fragment. Note that this string should be encoded in UTF-8.

Friends And Related Function Documentation

AP_ENGINE_CLIENT_API MonitorScript* createMonitorScript ( const char *  monitorString)
friend

This function allows creation of MonitorScript objects.

Parameters
monitorStringMonitorScript monitor/event definitions
Returns
A MonitorScript object.
AP_ENGINE_CLIENT_API void deleteMonitorScript ( MonitorScript mon)
friend

This function allows deletion of MonitorScript objects.

Parameters
monThe MonitorScript object to delete.
std::ostream& operator<< ( std::ostream &  stream,
const MonitorScript obj 
)
friend

Output a reference to a std::ostream.

std::ostream& operator<< ( std::ostream &  stream,
const MonitorScript obj 
)
friend

Output a pointer to a std::ostream.


The documentation for this class was generated from the following file: