Represents a schedule trigger. A schedule trigger is a time range and an optional event that together act as a trigger to activate a schedule and cause it to perform its configured action. More...

#include <IVxScheduleTrigger.h>

Public Member Functions
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...

virtual VxResult::Value	DeleteScheduleTrigger () const =0
	Deletes this schedule trigger from the VideoXpert system. More...

virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...

virtual VxResult::Value	SetDailyEndTime (char dailyEndTime[64])=0
	Sets the time at which the schedule trigger ends. More...

virtual VxResult::Value	SetDailyStartTime (char dailyStartTime[64])=0
	Sets the time at which the schedule trigger starts. More...

virtual VxResult::Value	SetEndDate (char endDate[64])=0
	Sets the date at which the schedule trigger ends. More...

virtual VxResult::Value	SetEventSourceDevice (char eventSourceDevice[64])=0
	Sets the event source device. Events will activate the schedule trigger only when they occur on this device. More...

virtual VxResult::Value	SetStartDate (char startDate[64])=0
	Sets the date at which the schedule trigger starts. More...

virtual VxResult::Value	SetPostTrigger (int postTrigger)=0
	Sets the amount of time to continue to consider the schedule trigger active when it becomes inactive ("post alarm"). More...

virtual VxResult::Value	SetPreTrigger (int preTrigger)=0
	Sets the amount of time to consider the schedule trigger active prior to when it becomes active ("pre alarm"). More...

virtual VxResult::Value	SetTimeout (int timeout)=0
	Sets the amount of time to consider the schedule trigger active immediately after it becomes active ("duration recording"). More...

virtual VxResult::Value	SetMonthlyRecurrence (int *daysOfMonth, int daysOfMonthSize)=0
	Sets the days of the month that the schedule trigger shall only be active on. More...

virtual VxResult::Value	SetWeeklyRecurrence (int *daysOfWeek, int daysOfWeekSize)=0
	Sets the days of the week that the schedule trigger shall only be active on. More...

virtual VxResult::Value	SetYearlyRecurrence (int *monthsOfYear, int monthsOfYearSize)=0
	Sets the months of the year that the schedule trigger shall only be active on. More...

virtual VxResult::Value	SetEventProperties (VxKvObject *eventProperties, int eventPropertySize)=0
	Sets the event properties that must be present to activate the schedule trigger. More...

virtual VxResult::Value	SetFramerate (VxRecordingFramerate::Value framerate)=0
	Sets the framerate level to record at. More...

virtual VxResult::Value	SetRecurrence (VxRecurrenceType::Value recurrence)=0
	Sets the interval at which the schedule trigger repeats. More...

virtual VxResult::Value	SetEventType (VxSituationType::Value eventType)=0
	Sets the VxSituationType that will activate the schedule trigger. More...

Public Attributes
char	dailyEndTime [64]
	The time at which the schedule trigger ends. A schedule trigger is active each day, only from dailyStartTime to dailyEndTime. If the dailyEndTime is less than the dailyStartTime, it is to be considered as occurring later (the following day). If these values are equal, the schedule trigger is not restricted by time. More...

char	dailyStartTime [64]
	The time at which the schedule trigger begins. A schedule trigger is active each day, only from dailyStartTime to dailyEndTime. If these values are equal, the schedule trigger is not restricted by time. More...

char	endDate [64]
	The date at which the schedule trigger ends. A schedule trigger is active, only from startDate to endDate. If the endDate is prior or equal to the startDate, the schedule trigger is not limited by date. More...

char	eventSourceDevice [64]
	The unique identifier of a device. If set, the event will activate the schedule trigger only when it occurs on this device. More...

char	id [64]
	The unique identifier of the schedule trigger. More...

char	startDate [64]
	The date at which the schedule trigger begins. A schedule trigger is active, only from startDate to endDate. If the endDate is prior or equal to the startDate, the schedule trigger is not limited by date. More...

int	eventPropertySize
	The size of eventProperties. More...

int	postTrigger
	Amount of time, from 0 to 300 seconds, to continue to consider the schedule trigger active when it becomes inactive (post-alarm). More...

int	preTrigger
	Amount of time, from 0 to 30 seconds, to consider the schedule trigger active prior to when it becomes active (pre-alarm). More...

int	recurMonthlySize
	The size of recurMonthly. More...

int	recurWeeklySize
	The size of recurWeekly. More...

int	recurYearlySize
	The size of recurYearly. More...

int	timeout
	Amount of time, from 1 to 300 seconds, to consider the schedule trigger active immediately after it becomes active (duration). More...

int *	recurMonthly
	Days of the month, from 1 to 31, that the schedule trigger shall only be active on. More...

int *	recurWeekly
	Days of the week, from 1 (Monday) to 7 (Sunday), that the schedule trigger shall only be active on. More...

int *	recurYearly
	Months of the year, from 1 (January) to 12 (December), that the schedule trigger shall only be active on. More...

VxKvObject **	eventProperties
	If set, the event only activates when it occurs with these IVxEvent::properties. Ignored if no event is set. More...

VxRecordingFramerate::Value	framerate
	The framerate level to record at. More...

VxRecurrenceType::Value	recurrence
	Interval at which the schedule trigger repeats. More...

VxSituationType::Value	event
	If set, the schedule trigger only activates when this type of VxSituationType occurs. The schedule trigger event state shall be considered active until the event becomes inactive. More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents a schedule trigger. A schedule trigger is a time range and an optional event that together act as a trigger to activate a schedule and cause it to perform its configured action.

Definition at line 13 of file IVxScheduleTrigger.h.

Member Function Documentation

void VxSdk::IVxScheduleTrigger::Clear ( )

inlineprotected

Clears this instance.

Definition at line 224 of file IVxScheduleTrigger.h.

                      {
             VxZeroArray(this->dailyEndTime);
             VxZeroArray(this->dailyStartTime);
             VxZeroArray(this->endDate);
             VxZeroArray(this->eventSourceDevice);
             VxZeroArray(this->id);
             VxZeroArray(this->startDate);
             this->postTrigger = 0;
             this->preTrigger = 0;
             this->recurMonthlySize = 0;
             this->recurWeeklySize = 0;
             this->recurYearlySize = 0;
             this->timeout = 0;
             this->recurMonthly = nullptr;
             this->recurWeekly = nullptr;
             this->recurYearly = nullptr;
             this->eventProperties = nullptr;
             this->framerate = VxRecordingFramerate::kUnknown;
             this->recurrence = VxRecurrenceType::kUnknown;
             this->event = VxSituationType::kUnknown;
         }

virtual VxResult::Value VxSdk::IVxScheduleTrigger::Delete ( ) const

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::DeleteScheduleTrigger ( ) const

pure virtual

Deletes this schedule trigger from the VideoXpert system.

Returns: The Result of deleting the schedule trigger.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns: The Result of refreshing the member values for this object.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetDailyEndTime ( char dailyEndTime[64] )

pure virtual

Sets the time at which the schedule trigger ends.

Parameters

dailyEndTime A time value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetDailyStartTime ( char dailyStartTime[64] )

pure virtual

Sets the time at which the schedule trigger starts.

Parameters

dailyStartTime A time value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetEndDate ( char endDate[64] )

pure virtual

Sets the date at which the schedule trigger ends.

Parameters

endDate A date value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetEventProperties	(	VxKvObject *	eventProperties,
		int	eventPropertySize
	)

pure virtual

Sets the event properties that must be present to activate the schedule trigger.

Parameters

eventProperties	The event properties.
eventPropertySize	The size of eventProperties.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetEventSourceDevice ( char eventSourceDevice[64] )

pure virtual

Sets the event source device. Events will activate the schedule trigger only when they occur on this device.

Parameters

eventSourceDevice The unique identifier of a device.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetEventType ( VxSituationType::Value eventType )

pure virtual

Sets the VxSituationType that will activate the schedule trigger.

Parameters

eventType The event type.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetFramerate ( VxRecordingFramerate::Value framerate )

pure virtual

Sets the framerate level to record at.

Parameters

framerate The framerate level.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetMonthlyRecurrence	(	int *	daysOfMonth,
		int	daysOfMonthSize
	)

pure virtual

Sets the days of the month that the schedule trigger shall only be active on.

Parameters

daysOfMonth	The days of the month, from 1 to 31.
daysOfMonthSize	The size of daysOfMonth.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetPostTrigger ( int postTrigger )

pure virtual

Sets the amount of time to continue to consider the schedule trigger active when it becomes inactive ("post alarm").

Parameters

postTrigger The post trigger time in seconds, from 0 to 300.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetPreTrigger ( int preTrigger )

pure virtual

Sets the amount of time to consider the schedule trigger active prior to when it becomes active ("pre alarm").

Parameters

preTrigger The pre trigger time in seconds, from 0 to 30.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetRecurrence ( VxRecurrenceType::Value recurrence )

pure virtual

Sets the interval at which the schedule trigger repeats.

Parameters

recurrence The recurrence interval.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetStartDate ( char startDate[64] )

pure virtual

Sets the date at which the schedule trigger starts.

Parameters

startDate A date value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetTimeout ( int timeout )

pure virtual

Sets the amount of time to consider the schedule trigger active immediately after it becomes active ("duration recording").

Parameters

timeout The timeout time in seconds, from 0 to 300.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetWeeklyRecurrence	(	int *	daysOfWeek,
		int	daysOfWeekSize
	)

pure virtual

Sets the days of the week that the schedule trigger shall only be active on.

Parameters

daysOfWeek	The days of the week, from 1 (Monday) to 7 (Sunday).
daysOfWeekSize	The size of daysOfWeek.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxScheduleTrigger::SetYearlyRecurrence	(	int *	monthsOfYear,
		int	monthsOfYearSize
	)

pure virtual

Sets the months of the year that the schedule trigger shall only be active on.

Parameters

monthsOfYear	The months of the year, from 1 (January) to 12 (December).
monthsOfYearSize	The size of monthsOfYear.

Returns: The Result of setting the property.

Member Data Documentation

char VxSdk::IVxScheduleTrigger::dailyEndTime[64]

The time at which the schedule trigger ends. A schedule trigger is active each day, only from dailyStartTime to dailyEndTime. If the dailyEndTime is less than the dailyStartTime, it is to be considered as occurring later (the following day). If these values are equal, the schedule trigger is not restricted by time.

Definition at line 135 of file IVxScheduleTrigger.h.

char VxSdk::IVxScheduleTrigger::dailyStartTime[64]

The time at which the schedule trigger begins. A schedule trigger is active each day, only from dailyStartTime to dailyEndTime. If these values are equal, the schedule trigger is not restricted by time.

Definition at line 140 of file IVxScheduleTrigger.h.

char VxSdk::IVxScheduleTrigger::endDate[64]

The date at which the schedule trigger ends. A schedule trigger is active, only from startDate to endDate. If the endDate is prior or equal to the startDate, the schedule trigger is not limited by date.

Definition at line 146 of file IVxScheduleTrigger.h.

VxSituationType::Value VxSdk::IVxScheduleTrigger::event

If set, the schedule trigger only activates when this type of VxSituationType occurs. The schedule trigger event state shall be considered active until the event becomes inactive.

Definition at line 218 of file IVxScheduleTrigger.h.

VxKvObject** VxSdk::IVxScheduleTrigger::eventProperties

If set, the event only activates when it occurs with these IVxEvent::properties. Ignored if no event is set.

Definition at line 205 of file IVxScheduleTrigger.h.

int VxSdk::IVxScheduleTrigger::eventPropertySize

The size of eventProperties.

Definition at line 165 of file IVxScheduleTrigger.h.

char VxSdk::IVxScheduleTrigger::eventSourceDevice[64]

The unique identifier of a device. If set, the event will activate the schedule trigger only when it occurs on this device.

Definition at line 151 of file IVxScheduleTrigger.h.

VxRecordingFramerate::Value VxSdk::IVxScheduleTrigger::framerate

The framerate level to record at.

Definition at line 209 of file IVxScheduleTrigger.h.

char VxSdk::IVxScheduleTrigger::id[64]

The unique identifier of the schedule trigger.

Definition at line 155 of file IVxScheduleTrigger.h.

int VxSdk::IVxScheduleTrigger::postTrigger

Amount of time, from 0 to 300 seconds, to continue to consider the schedule trigger active when it becomes inactive (post-alarm).

Definition at line 169 of file IVxScheduleTrigger.h.

int VxSdk::IVxScheduleTrigger::preTrigger

Amount of time, from 0 to 30 seconds, to consider the schedule trigger active prior to when it becomes active (pre-alarm).

Definition at line 173 of file IVxScheduleTrigger.h.

int* VxSdk::IVxScheduleTrigger::recurMonthly

Days of the month, from 1 to 31, that the schedule trigger shall only be active on.

Definition at line 193 of file IVxScheduleTrigger.h.

int VxSdk::IVxScheduleTrigger::recurMonthlySize

The size of recurMonthly.

Definition at line 177 of file IVxScheduleTrigger.h.

VxRecurrenceType::Value VxSdk::IVxScheduleTrigger::recurrence

Interval at which the schedule trigger repeats.

Definition at line 213 of file IVxScheduleTrigger.h.

int* VxSdk::IVxScheduleTrigger::recurWeekly

Days of the week, from 1 (Monday) to 7 (Sunday), that the schedule trigger shall only be active on.

Definition at line 197 of file IVxScheduleTrigger.h.

int VxSdk::IVxScheduleTrigger::recurWeeklySize

The size of recurWeekly.

Definition at line 181 of file IVxScheduleTrigger.h.

int* VxSdk::IVxScheduleTrigger::recurYearly

Months of the year, from 1 (January) to 12 (December), that the schedule trigger shall only be active on.

Definition at line 201 of file IVxScheduleTrigger.h.

int VxSdk::IVxScheduleTrigger::recurYearlySize

The size of recurYearly.

Definition at line 185 of file IVxScheduleTrigger.h.

char VxSdk::IVxScheduleTrigger::startDate[64]

The date at which the schedule trigger begins. A schedule trigger is active, only from startDate to endDate. If the endDate is prior or equal to the startDate, the schedule trigger is not limited by date.

Definition at line 161 of file IVxScheduleTrigger.h.

int VxSdk::IVxScheduleTrigger::timeout

Amount of time, from 1 to 300 seconds, to consider the schedule trigger active immediately after it becomes active (duration).

Definition at line 189 of file IVxScheduleTrigger.h.

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

C:/Git/VXSDK_M3/VxSdk/Include/IVxScheduleTrigger.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation