Represents a new schedule trigger to be created. 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 <VxNewScheduleTrigger.h>

Public Member Functions
	VxNewScheduleTrigger ()
	Initializes a new instance of the VxNewScheduleTrigger struct. More...

	VxNewScheduleTrigger (const VxNewScheduleTrigger &ref)
	Initializes a new instance of the VxNewScheduleTrigger struct. More...

	~VxNewScheduleTrigger ()
	Finalizes an instance of the VxNewScheduleTrigger class. More...

void	Clear ()
	Clears this instance. 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. Defaults to 00:00:00. 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. Defaults to 00:00:00. 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. Defaults to the value of startDate. 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. Ignored if no event is set. More...

char	id [64]
	The unique identifier of the schedule trigger. If not supplied, the system will create the identifier. 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. Defaults to the current 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"). Defaults to 0. 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"). Defaults to 0. 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 recording"). Defaults to 0. More...

int *	recurMonthly
	Days of the month, from 1 to 31, that the schedule trigger shall only be active on. Defaults to every day of the month. Ignored if recurrence is not set to VxRecurrenceType::kMonthly. More...

int *	recurWeekly
	Days of the week, from 1 (Monday) to 7 (Sunday), that the schedule trigger shall only be active on. Defaults to every day of the week. Ignored if recurrence is not set to VxRecurrenceType::kWeekly. More...

int *	recurYearly
	Months of the year, from 1 (January) to 12 (December), that the schedule trigger shall only be active on. Defaults to every month of the year. Ignored if recurrence is not set to VxRecurrenceType::kYearly. More...

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

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

VxRecurrenceType::Value	recurrence
	Interval at which the schedule trigger repeats. Defaults to VxRecurrenceType::kDaily. 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...

Detailed Description

Represents a new schedule trigger to be created. 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 14 of file VxNewScheduleTrigger.h.

Constructor & Destructor Documentation

VxSdk::VxNewScheduleTrigger::VxNewScheduleTrigger ( )

inline

Initializes a new instance of the VxNewScheduleTrigger struct.

Definition at line 19 of file VxNewScheduleTrigger.h.

                                {
             Clear();
         }

VxSdk::VxNewScheduleTrigger::VxNewScheduleTrigger ( const VxNewScheduleTrigger & ref )

inline

Initializes a new instance of the VxNewScheduleTrigger struct.

Parameters

ref	The reference.

Definition at line 27 of file VxNewScheduleTrigger.h.

                                                               {
             Utilities::StrCopySafe(this->dailyEndTime, ref.dailyEndTime);
             Utilities::StrCopySafe(this->dailyStartTime, ref.dailyStartTime);
             Utilities::StrCopySafe(this->endDate, ref.endDate);
             Utilities::StrCopySafe(this->eventSourceDevice, ref.eventSourceDevice);
             Utilities::StrCopySafe(this->id, ref.id);
             Utilities::StrCopySafe(this->startDate, ref.startDate);
             this->eventPropertySize = ref.eventPropertySize;
             this->postTrigger = ref.postTrigger;
             this->preTrigger = ref.preTrigger;
             this->recurMonthlySize = ref.recurMonthlySize;
             this->recurWeeklySize = ref.recurWeeklySize;
             this->recurYearlySize = ref.recurYearlySize;
             this->timeout = ref.timeout;
             this->recurMonthly = ref.recurMonthly;
             this->recurWeekly = ref.recurWeekly;
             this->recurYearly = ref.recurYearly;
             this->eventProperties = ref.eventProperties;
             this->framerate = ref.framerate;
             this->recurrence = ref.recurrence;
             this->event = ref.event;
         }

VxSdk::VxNewScheduleTrigger::~VxNewScheduleTrigger ( )

inline

Finalizes an instance of the VxNewScheduleTrigger class.

Definition at line 53 of file VxNewScheduleTrigger.h.

                                 {
             Clear();
         }

Member Function Documentation

void VxSdk::VxNewScheduleTrigger::Clear ( )

inline

Clears this instance.

Definition at line 60 of file VxNewScheduleTrigger.h.

                      {
             VxZeroArray(this->dailyEndTime);
             VxZeroArray(this->dailyStartTime);
             VxZeroArray(this->endDate);
             VxZeroArray(this->eventSourceDevice);
             VxZeroArray(this->id);
             VxZeroArray(this->startDate);
             this->eventPropertySize = 0;
             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;
         }

Member Data Documentation

char VxSdk::VxNewScheduleTrigger::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. Defaults to 00:00:00.

Definition at line 90 of file VxNewScheduleTrigger.h.

char VxSdk::VxNewScheduleTrigger::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. Defaults to 00:00:00.

Definition at line 96 of file VxNewScheduleTrigger.h.

char VxSdk::VxNewScheduleTrigger::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. Defaults to the value of startDate.

Definition at line 102 of file VxNewScheduleTrigger.h.

VxSituationType::Value VxSdk::VxNewScheduleTrigger::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 180 of file VxNewScheduleTrigger.h.

VxKvObject* VxSdk::VxNewScheduleTrigger::eventProperties

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

Definition at line 167 of file VxNewScheduleTrigger.h.

int VxSdk::VxNewScheduleTrigger::eventPropertySize

The size of eventProperties.

Definition at line 121 of file VxNewScheduleTrigger.h.

char VxSdk::VxNewScheduleTrigger::eventSourceDevice[64]

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

Definition at line 107 of file VxNewScheduleTrigger.h.

VxRecordingFramerate::Value VxSdk::VxNewScheduleTrigger::framerate

The framerate level to record at. Defaults to VxRecordingFramerate::kNormal.

Definition at line 171 of file VxNewScheduleTrigger.h.

char VxSdk::VxNewScheduleTrigger::id[64]

The unique identifier of the schedule trigger. If not supplied, the system will create the identifier.

Definition at line 111 of file VxNewScheduleTrigger.h.

int VxSdk::VxNewScheduleTrigger::postTrigger

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

Definition at line 126 of file VxNewScheduleTrigger.h.

int VxSdk::VxNewScheduleTrigger::preTrigger

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

Definition at line 131 of file VxNewScheduleTrigger.h.

int* VxSdk::VxNewScheduleTrigger::recurMonthly

Days of the month, from 1 to 31, that the schedule trigger shall only be active on. Defaults to every day of the month. Ignored if recurrence is not set to VxRecurrenceType::kMonthly.

Definition at line 153 of file VxNewScheduleTrigger.h.

int VxSdk::VxNewScheduleTrigger::recurMonthlySize

The size of recurMonthly.

Definition at line 135 of file VxNewScheduleTrigger.h.

VxRecurrenceType::Value VxSdk::VxNewScheduleTrigger::recurrence

Interval at which the schedule trigger repeats. Defaults to VxRecurrenceType::kDaily.

Definition at line 175 of file VxNewScheduleTrigger.h.

int* VxSdk::VxNewScheduleTrigger::recurWeekly

Days of the week, from 1 (Monday) to 7 (Sunday), that the schedule trigger shall only be active on. Defaults to every day of the week. Ignored if recurrence is not set to VxRecurrenceType::kWeekly.

Definition at line 158 of file VxNewScheduleTrigger.h.

int VxSdk::VxNewScheduleTrigger::recurWeeklySize

The size of recurWeekly.

Definition at line 139 of file VxNewScheduleTrigger.h.

int* VxSdk::VxNewScheduleTrigger::recurYearly

Months of the year, from 1 (January) to 12 (December), that the schedule trigger shall only be active on. Defaults to every month of the year. Ignored if recurrence is not set to VxRecurrenceType::kYearly.

Definition at line 163 of file VxNewScheduleTrigger.h.

int VxSdk::VxNewScheduleTrigger::recurYearlySize

The size of recurYearly.

Definition at line 143 of file VxNewScheduleTrigger.h.

char VxSdk::VxNewScheduleTrigger::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. Defaults to the current date.

Definition at line 117 of file VxNewScheduleTrigger.h.

int VxSdk::VxNewScheduleTrigger::timeout

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

Definition at line 148 of file VxNewScheduleTrigger.h.

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

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation