com::apama::engine::MonitorScript Class Reference

A MonitorScript object encapsulates an EPL 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 an EPL 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

getText()

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 EPL fragment. Note that this string should be encoded in UTF-8.

Friends And Related Function Documentation

createMonitorScript

AP_ENGINE_CLIENT_API MonitorScript* createMonitorScript ( const char *  monitorString )

friend

This function allows creation of MonitorScript objects.

Parameters

monitorString

EPL monitors or event definitions

Returns

A MonitorScript object.

deleteMonitorScript

AP_ENGINE_CLIENT_API void deleteMonitorScript ( MonitorScript *  mon )

friend

This function allows deletion of MonitorScript objects.

Parameters

mon	The MonitorScript object to delete.

operator<< [1/2]

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

friend

Output a reference to a std::ostream.

operator<< [2/2]

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:

• engine_client_cpp.hpp