IlsMvTimeManager Class Reference

This singleton manages the current timer used by the dynamic view that exploits the currentTime view attribute. More...

#include <ilserver/mvview.h>

Static Public Member Functions
static IlsBoolean	AutoStart ()
	Returns IlsTrue if the time manager is in autostart mode. More...
static void	AutoStart (IlsBoolean b)
	Controls the autostart mode of the time manager. More...
static const IlsMvDateTime &	GetCurrentTime ()
	Returns the current time. More...
static int	GetDefaultRefreshRate ()
	Returns the default refresh rate used to update the currentTime attribute. More...
static void	SetDefaultRefreshRate (int r)
	Sets the default refresh rate used to update the currentTime attribute. More...

Detailed Description

This singleton manages the current timer used by the dynamic view that exploits the currentTime view attribute.

Library: mvserver

By default, this object starts to update the current time as soon as the dynamic view is opened. You can control this behavior using the autostart property. As soon as this manager is started, all the dynamic views that use the currentTime attribute are updated at a refresh rate. The default refresh rate is 1 second.

See also

IlsTimer, IlsTimerManager.

Member Function Documentation

AutoStart() [1/2]

static IlsBoolean IlsMvTimeManager::AutoStart ( )

static

Returns IlsTrue if the time manager is in autostart mode.

Autostart mode means that the time manager will start to update the current time as soon as a dynamic view using the currentTime attribute is opened.

Returns

IlsTrue if the time manager is in autostart mode

AutoStart() [2/2]

static void IlsMvTimeManager::AutoStart ( IlsBoolean  b )

static

Controls the autostart mode of the time manager.

The default value is IlsTrue.

Parameters

b	autostart mode

GetCurrentTime()

static const IlsMvDateTime& IlsMvTimeManager::GetCurrentTime ( )

static

Returns the current time.

Returns

current time

GetDefaultRefreshRate()

static int IlsMvTimeManager::GetDefaultRefreshRate ( )

static

Returns the default refresh rate used to update the currentTime attribute.

The default value is 1 second.

Returns

the default refresh rate used to update the currentTime attribute

SetDefaultRefreshRate()

static void IlsMvTimeManager::SetDefaultRefreshRate ( int  r )

static

Sets the default refresh rate used to update the currentTime attribute.

You can use the ILS_MVTIME_PERIOD environment variable to control the default value.

Parameters

r	default refresh rate