---

ResourceMonitor::RMmonitor Class Reference

#include <ResourceMonitor.h>

Inheritance diagram for ResourceMonitor::RMmonitor::

List of all members.

Public Methods
	RMmonitor (const rmMonitorConfiguration &config, rmMonitorControl *control)
	if this constructor fails to create a monitor, it throws an exception See also: rmCreateMonitor. More...
	RMmonitor (const rmUID MonitorId)
	if this constructor fails to access a monitor, it throws an exception See also: rmAccessMonitor. More...
	RMmonitor (const rmSessionHandle session, const rmMonitorConfiguration &config, rmMonitorControl *control)
	if this constructor fails to create a monitor, it throws an exception See also: rmCreateConsumerSession, rmCreateMonitor. More...
	RMmonitor (const rmSessionHandle session, const rmUID MonitorId)
	if this constructor fails to access a monitor, it throws an exception See also: rmCreateConsumerSession, rmAccessMonitor. More...
	~RMmonitor ()
	monitors are not deleted in this destructor unless RMmonitor::OnDestructionDeleteMonitor has been called. See also: rmDeleteMonitor. More...
void	OnDestructionDeleteMonitor ()
	delete a monitor in the destructor of this class. See also: rmDeleteMonitor. More...
int	GetMonitorControl (rmMonitorControl *control) const
	See also: rmGetMonitorControl. More...
int	SetMonitorControl (const rmMonitorControl &control)
	See also: rmSetMonitorControl. More...
int	GetMonitorConfiguration (rmMonitorConfiguration *config) const
	See also: rmGetMonitorConfiguration. More...
int	SetMonitorConfiguration (const rmMonitorConfiguration &config)
	See also: rmSetMonitorConfiguration. More...
int	GetMonitorState (rmMonitorState *state) const
	See also: rmGetMonitorState. More...
int	GetMonitorInfo (rmMonitorInfo *buffer) const
	See also: rmGetMonitorInfo. More...
rmString	GetMonitorDescription (const rmDescriptions which) const
	See also: rmGetMonitorDescription. More...
int	SetMonitorDescription (const rmDescriptions which, const rmString description)
	See also: rmSetMonitorDescription. More...
int	StartMonitor ()
	See also: rmStartMonitor. More...
int	StopMonitor ()
	See also: rmStopMonitor. More...
int	ResetMonitor ()
	See also: rmResetMonitor. More...
int	PauseNotification ()
	See also: rmPauseNotification. More...
int	ResetNotification ()
	See also: rmResetNotification. More...
Private Attributes
rmHandle	m_MonitorHandle
bool	m_deleteInDestructor

---

Detailed Description

RMmonitor is a session that provides access to a monitor of a statistic.

The member functions of this class provide the same functionality as the corresponding rmXxxxYyyy() functions.

---

Constructor & Destructor Documentation

ResourceMonitor::RMmonitor::RMmonitor ( const rmMonitorConfiguration & config, rmMonitorControl * control )

if this constructor fails to create a monitor, it throws an exception See also: rmCreateMonitor.

ResourceMonitor::RMmonitor::RMmonitor ( const rmUID MonitorId )

if this constructor fails to access a monitor, it throws an exception See also: rmAccessMonitor.

ResourceMonitor::RMmonitor::RMmonitor ( const rmSessionHandle session, const rmMonitorConfiguration & config, rmMonitorControl * control )

if this constructor fails to create a monitor, it throws an exception See also: rmCreateConsumerSession, rmCreateMonitor.

ResourceMonitor::RMmonitor::RMmonitor ( const rmSessionHandle session, const rmUID MonitorId )

if this constructor fails to access a monitor, it throws an exception See also: rmCreateConsumerSession, rmAccessMonitor.

ResourceMonitor::RMmonitor::~RMmonitor ( )

monitors are not deleted in this destructor unless RMmonitor::OnDestructionDeleteMonitor has been called. See also: rmDeleteMonitor.

---

Member Function Documentation

int ResourceMonitor::RMmonitor::GetMonitorConfiguration ( rmMonitorConfiguration * config ) const

See also: rmGetMonitorConfiguration.

int ResourceMonitor::RMmonitor::GetMonitorControl ( rmMonitorControl * control ) const

See also: rmGetMonitorControl.

rmString ResourceMonitor::RMmonitor::GetMonitorDescription ( const rmDescriptions which ) const

See also: rmGetMonitorDescription.

int ResourceMonitor::RMmonitor::GetMonitorInfo ( rmMonitorInfo * buffer ) const

See also: rmGetMonitorInfo.

int ResourceMonitor::RMmonitor::GetMonitorState ( rmMonitorState * state ) const

See also: rmGetMonitorState.

void ResourceMonitor::RMmonitor::OnDestructionDeleteMonitor ( )

delete a monitor in the destructor of this class. See also: rmDeleteMonitor.

int ResourceMonitor::RMmonitor::PauseNotification ( )

See also: rmPauseNotification.

int ResourceMonitor::RMmonitor::ResetMonitor ( )

See also: rmResetMonitor.

int ResourceMonitor::RMmonitor::ResetNotification ( )

See also: rmResetNotification.

int ResourceMonitor::RMmonitor::SetMonitorConfiguration ( const rmMonitorConfiguration & config )

See also: rmSetMonitorConfiguration.

int ResourceMonitor::RMmonitor::SetMonitorControl ( const rmMonitorControl & control )

See also: rmSetMonitorControl.

int ResourceMonitor::RMmonitor::SetMonitorDescription ( const rmDescriptions which, const rmString description )

See also: rmSetMonitorDescription.

int ResourceMonitor::RMmonitor::StartMonitor ( )

See also: rmStartMonitor.

int ResourceMonitor::RMmonitor::StopMonitor ( )

See also: rmStopMonitor.

---

Member Data Documentation

rmHandle ResourceMonitor::RMmonitor::m_MonitorHandle [private]

bool ResourceMonitor::RMmonitor::m_deleteInDestructor [private]

---

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

• /root/resourcemonitord/resourcemonitord/ResourceMonitor/ResourceMonitor.h

---