Adaptor Class Reference

Monitor enabling class. More...

Inheritance diagram for Adaptor:

Collaboration diagram for Adaptor:

Public Member Functions
_.Library.Status	OnNew ()
	Initialize the collection.
_.Library.Status	GetSample ()
	USER MUST IMPLEMENT THIS METHOD More...
_.Library.Status	Initialize ()
	USER MAY IMPLEMENT THIS METHOD More...
_.Library.Status	Shutdown ()
	USER MAY IMPLEMENT THIS METHOD More...
_.Library.Status	Startup ()
	USER MAY IMPLEMENT THIS METHOD More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Attributes
	APPLICATION = None
	User name for application. More...
	GROUPNAME = None
	User name for this group of metrics. More...
	INDEX = None
	Comma separated list of properties to act as primary key for instances. More...
	SECURITYRESOURCE = None
	Comma separated list of Resources required to view the CSP page. More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

Monitor enabling class.

Users inherit from this class to register as a Monitor class.

Member Function Documentation

GetSample()

_.Library.Status GetSample

(

)

USER MUST IMPLEMENT THIS METHOD

This method is called to initialize and populate properties for successive sample instances.
A return code of $$$OK indicates there is a new sample instance.
A return code of 0 indicates there is no sample instance.

NOTE: If an INDEX is specified, i.e. we expect to collect multiple samples for each sampling period, then the System Monitor will loop calling GetSample() until "0" is returned. Users code MUST return "0" when all indexed sample have been collected for a period, in order to terminate the loop.

Initialize()

_.Library.Status Initialize

(

)

USER MAY IMPLEMENT THIS METHOD

This method is called to initialize the control for the first sample of a set of sample instances.
A return code of $$$OK indicates there is a new sample instance.
A return code of 0 indicates there is no sample instance.

Shutdown()

_.Library.Status Shutdown

(

)

USER MAY IMPLEMENT THIS METHOD

This method is called once when the control object is closed at the end of sampling. The user may cleanup the control class.

Startup()

_.Library.Status Startup

(

)

USER MAY IMPLEMENT THIS METHOD

This method is called once when the control object is created at the beginning of sampling. The user may initialize the control class.

Member Data Documentation

APPLICATION

APPLICATION = None

static

User name for application.

Default = Package name

GROUPNAME

GROUPNAME = None

static

User name for this group of metrics.

Default = classname

INDEX

INDEX = None

static

Comma separated list of properties to act as primary key for instances.

Default = ""

SECURITYRESOURCE

SECURITYRESOURCE = None

static

Comma separated list of Resources required to view the CSP page.

Default = ""