abstract class %Monitor.Adaptor
extends %RegisteredObject
Monitor enabling class. Users inherit from this class to register
as a Monitor class.
• parameter APPLICATION;
Monitor parameters - optional
User name for application. Default = Package name
• parameter GROUPNAME;
User name for this group of metrics. Default = classname
• parameter INDEX;
Comma separated list of properties to act as primary key for instances. Default = ""
• abstract method GetSample()
as %Status
USER MUST IMPLEMENT THIS CLASS
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.
• method Initialize()
as %Status
USER MAY IMPLEMENT THIS CLASS
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.
• method Shutdown()
as %Status
USER MAY IMPLEMENT THIS CLASS
This method is called once when the control object is closed at the end of sampling
The user may cleanup the control class
• method Startup()
as %Status
USER MAY IMPLEMENT THIS CLASS
This method is called once when the control object is created at the beginning of sampleing.
The user may initialize the control class
