IlsMvTimeManager

Category

Dynamic view-related class (server side)

Inheritance Path

IlsMvTimeManager

Description

This singleton manages the current timer used by the dynamic view that exploits the currentTime view attribute. 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.

Library

Header File

#include <ilserver/mvview.h>

Synopsis

class IlsMvTimeManager

{

static IlsBoolean AutoStart();

static void AutoStart(IlsBoolean b);

static int GetDefaultRefreshRate();

static void SetDefaultRefreshRate(int r);

static const IlsMvDateTime& GetCurrentTime();

};

Member Functions

[static] IlsBoolean AutoStart();

This static member function 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.

[static] void AutoStart(IlsBoolean b);

This static member function controls the autostart mode of the time manager. The default value is IlsTrue.

[static] int GetDefaultRefreshRate();

This static member function returns the default refresh rate used to update the currentTime attribute. The default value is 1 second.

[static] void SetDefaultRefreshRate(int r);

This static member function starts the default refresh rate used to update the currentTime attribute. You can use the ILS_MVTIME_PERIOD environment variable to control the default value.

[static] const IlsMvDateTime& GetCurrentTime();

This static member function returns the current time.