Detailed Description

This contains lists of days, hours and minutes that the archive holds footage for.

It also holds information about bookmarks in the archive. The Timeline class holds all timestamps in UTC time to prevent overlaps/gaps when daylight savings time changes occur.

Availability

Available in version 6.0 of Decoder SDK. Requires a server version greater than 5.0

#include <Timeline.h>

Public Member Functions
void	RegisterWatcher (ITimelineWatcher *watcher)
	Adds a new timeline watcher to be notified whenever the timeline is updated. More...

void	UnRegisterWatcher (ITimelineWatcher *watcher)
	Removes a registered timeline watcher. More...

std::wstring	Timezone () const
	Gets the timezone that the timeline uses. More...

void	Timezone (const std::wstring &tz)
	Sets the timezone that the timeline uses. More...

void	Insert (const TimesList &times, TimelineEntryFlags resolution)
	Inserts new times into the appropriate times list. More...

DB_EDGEVIS_SDK size_t	CountDays () const
	Gets the number of days in the timeline. More...

DB_EDGEVIS_SDK size_t	CountHours () const
	Gets the number of hours in the timeline. More...

DB_EDGEVIS_SDK size_t	CountMins () const
	Gets the number of minutes in the timeline. More...

DB_EDGEVIS_SDK TimesIteratorPair	Days () const
	Gets an iterator pair (start and end positions in the list) of the days in the timeline. More...

DB_EDGEVIS_SDK TimesIteratorPair	Hours () const
	Gets an iterator pair (start and end positions in the list) of the hours in the timeline. More...

DB_EDGEVIS_SDK TimesIteratorPair	Mins () const
	Gets an iterator pair (start and end positions in the list) of the minutes in the timeline. More...

DB_EDGEVIS_SDK TimesList	DaysList () const
	Gets the list of days in the timeline. More...

DB_EDGEVIS_SDK TimesList	HoursList () const
	Gets the list of hours in the timeline. More...

DB_EDGEVIS_SDK TimesList	MinsList () const
	Gets the list of minutes in the timeline. More...

DB_EDGEVIS_SDK int64_t	FirstDay () const
	Gets the first day in the Timeline. More...

DB_EDGEVIS_SDK int64_t	LastDay () const
	Gets the last day in the Timeline. More...

DB_EDGEVIS_SDK int64_t	FirstHour () const
	Gets the first hour in the Timeline. More...

DB_EDGEVIS_SDK int64_t	LastHour () const
	Gets the last hour in the Timeline. More...

DB_EDGEVIS_SDK int64_t	FirstMin () const
	Gets the first minute in the Timeline. More...

DB_EDGEVIS_SDK int64_t	LastMin () const
	Gets the last minute in the Timeline. More...

Static Public Member Functions
static DB_EDGEVIS_SDK int64_t	CurrentTimeUTC ()
	Gets the current time in UTC. More...

Member Function Documentation

void EdgeVisDecoderSDK::Timeline::RegisterWatcher ( ITimelineWatcher * watcher )

Adds a new timeline watcher to be notified whenever the timeline is updated.

Parameters

watcher Pointer to the new to be notified of timeline updates.

See also: ITimelineWatcher

void EdgeVisDecoderSDK::Timeline::UnRegisterWatcher ( ITimelineWatcher * watcher )

Removes a registered timeline watcher.

The watcher will no longer be notified of timeline updates.

Parameters

watcher Pointer to the timeline watcher object to be removed.

std::wstring EdgeVisDecoderSDK::Timeline::Timezone ( ) const

Gets the timezone that the timeline uses.

This is set whenever results are added to the Timeline via a query using the IEVArchiveService. If the timeline is empty the timezone will be an empty string.

Returns: The name of the timezone as a string.

void EdgeVisDecoderSDK::Timeline::Timezone ( const std::wstring & tz )

Sets the timezone that the timeline uses.

Parameters

tz	The name of the timezone.

void EdgeVisDecoderSDK::Timeline::Insert	(	const TimesList &	times,
		TimelineEntryFlags	resolution
	)

Inserts new times into the appropriate times list.

A TimelineUpdated event will be fired after the update.

Parameters

times	The list of new timestamps.
resolution	Either DAYS, HOURS or MINS.

DB_EDGEVIS_SDK size_t EdgeVisDecoderSDK::Timeline::CountDays ( ) const

Gets the number of days in the timeline.

Returns: The number of days in the timeline.

DB_EDGEVIS_SDK size_t EdgeVisDecoderSDK::Timeline::CountHours ( ) const

Gets the number of hours in the timeline.

Returns: The number of hours in the timeline.

DB_EDGEVIS_SDK size_t EdgeVisDecoderSDK::Timeline::CountMins ( ) const

Gets the number of minutes in the timeline.

Returns: The number of minutes in the timeline.

DB_EDGEVIS_SDK TimesIteratorPair EdgeVisDecoderSDK::Timeline::Days ( ) const

Gets an iterator pair (start and end positions in the list) of the days in the timeline.

Times are in UTC time.

Returns: An iterator pair over the list of days in the timeline.

DB_EDGEVIS_SDK TimesIteratorPair EdgeVisDecoderSDK::Timeline::Hours ( ) const

Gets an iterator pair (start and end positions in the list) of the hours in the timeline.

Times are in UTC time.

Returns: An iterator pair over the list of hours in the timeline.

DB_EDGEVIS_SDK TimesIteratorPair EdgeVisDecoderSDK::Timeline::Mins ( ) const

Gets an iterator pair (start and end positions in the list) of the minutes in the timeline.

Times are in UTC time.

Returns: An iterator pair over the list of minutes in the timeline.

DB_EDGEVIS_SDK TimesList EdgeVisDecoderSDK::Timeline::DaysList ( ) const

Gets the list of days in the timeline.

Times are in UTC time.

Returns: The list of days in the timeline.

DB_EDGEVIS_SDK TimesList EdgeVisDecoderSDK::Timeline::HoursList ( ) const

Gets the list of hours in the timeline.

Times are in UTC time.

Returns: The list of hours in the timeline.

DB_EDGEVIS_SDK TimesList EdgeVisDecoderSDK::Timeline::MinsList ( ) const

Gets the list of minutes in the timeline.

Times are in UTC time.

Returns: The list of minutes in the timeline.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Timeline::FirstDay ( ) const

Gets the first day in the Timeline.

Times are in UTC time.

Returns: The timestamp of the first day in the Timeline.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Timeline::LastDay ( ) const

Gets the last day in the Timeline.

Times are in UTC time.

Returns: The timestamp of the last day in the Timeline.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Timeline::FirstHour ( ) const

Gets the first hour in the Timeline.

Times are in UTC time.

Returns: The timestamp of the first hour in the Timeline.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Timeline::LastHour ( ) const

Gets the last hour in the Timeline.

Times are in UTC time.

Returns: The timestamp of the last hour in the Timeline.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Timeline::FirstMin ( ) const

Gets the first minute in the Timeline.

Times are in UTC time.

Returns: The timestamp of the first minute in the Timeline.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Timeline::LastMin ( ) const

Gets the last minute in the Timeline.

Times are in UTC time.

Returns: The timestamp of the last minute in the Timeline.

static DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Timeline::CurrentTimeUTC ( )

static

Gets the current time in UTC.

Returns: Current UTC time in milliseconds since the epoch.

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

SDKs/EdgeVisDecoderSDK/Timeline.h

Detailed Description

Availability

Public Member Functions

Static Public Member Functions

Member Function Documentation