The NewScheduleTrigger class represents a new schedule trigger configuration that specifies a time range and an optional event that together act as a trigger to activate a schedule. More...

#include <NewScheduleTrigger.h>

Public Member Functions
	NewScheduleTrigger ()
	Default constructor. More...

	NewScheduleTrigger (VxSdk::VxNewScheduleTrigger *vxNewScheduleTrigger)
	Constructor. More...

Package Attributes
VxSdk::VxNewScheduleTrigger *	_newScheduleTrigger

Properties
System::DateTime	DailyEndTime `[get, set]`
	Gets or sets 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...

System::DateTime	DailyStartTime `[get, set]`
	Gets or sets 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...

System::DateTime	EndDate `[get, set]`
	Gets or sets 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...

ScheduleTrigger::SituationTypes	Event `[get, set]`
	Gets or sets the event situation type. If set, the schedule trigger only activates when this type of SituationType occurs. The schedule trigger event state shall be considered active until the event becomes inactive. More...

System::Collections::Generic::List< System::Collections::Generic::KeyValuePair< System::String^ , System::String^ >>^	EventProperties `[get, set]`
	Gets or sets the event properties that will activate the schedule. More...

System::String^	EventSource `[get, set]`
	Gets or sets the unique identifier of a device. If set, the Event will activate the schedule trigger only when it occurs on this device. More...

Clip::RecordingFramerates	Framerate `[get, set]`
	Gets or sets the recording framerate level. More...

System::String^	Id `[get, set]`
	Gets or sets the unique identifier of the schedule trigger. More...

int	PostTrigger `[get, set]`
	Gets or sets the 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 `[get, set]`
	Gets or sets the amount of time, from 0 to 30 seconds, to consider the schedule trigger active prior to when it becomes active ("pre alarm"). More...

ScheduleTrigger::RecurrenceTypes	RecurrenceType `[get, set]`
	Gets or sets the interval at which the schedule trigger repeats. More...

System::Collections::Generic::List< int >^	RecurMonthly `[get, set]`
	Gets or sets the days of the month, from 1 to 31, that the schedule trigger shall only be active on. More...

System::Collections::Generic::List< int >^	RecurWeekly `[get, set]`
	Gets or sets the days of the week, from 1 (Monday) to 7 (Sunday), that the schedule trigger shall only be active on. More...

System::Collections::Generic::List< int >^	RecurYearly `[get, set]`
	Gets or sets the months of the year, from 1 (January) to 12 (December), that the schedule trigger shall only be active on. More...

System::DateTime	StartDate `[get, set]`
	Gets or sets 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	Timeout `[get, set]`
	Gets or sets the amount of time, from 1 to 300 seconds, to consider the schedule trigger active immediately after it becomes active ("duration recording"). More...

Detailed Description

The NewScheduleTrigger class represents a new schedule trigger configuration that specifies a time range and an optional event that together act as a trigger to activate a schedule.

Definition at line 15 of file NewScheduleTrigger.h.

Constructor & Destructor Documentation

CPPCli::NewScheduleTrigger::NewScheduleTrigger ( )

inline

Default constructor.

Definition at line 21 of file NewScheduleTrigger.h.

                              {
             _newScheduleTrigger = new VxSdk::VxNewScheduleTrigger();
         }

CPPCli::NewScheduleTrigger::NewScheduleTrigger ( VxSdk::VxNewScheduleTrigger * vxNewScheduleTrigger )

inline

Constructor.

Parameters

vxNewScheduleTrigger The new schedule trigger.

Definition at line 29 of file NewScheduleTrigger.h.

                                                                             {
             _newScheduleTrigger = vxNewScheduleTrigger;
         }

Member Data Documentation

VxSdk::VxNewScheduleTrigger* CPPCli::NewScheduleTrigger::_newScheduleTrigger

package

Definition at line 278 of file NewScheduleTrigger.h.

Property Documentation

System:: DateTime CPPCli::NewScheduleTrigger::DailyEndTime

getset

Gets or sets 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.

The daily end time.

Definition at line 40 of file NewScheduleTrigger.h.

System:: DateTime CPPCli::NewScheduleTrigger::DailyStartTime

getset

Gets or sets 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.

The daily start time.

Definition at line 52 of file NewScheduleTrigger.h.

System:: DateTime CPPCli::NewScheduleTrigger::EndDate

getset

Gets or sets 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.

The end date.

Definition at line 64 of file NewScheduleTrigger.h.

ScheduleTrigger:: SituationTypes CPPCli::NewScheduleTrigger::Event

getset

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

The event situation type.

Definition at line 76 of file NewScheduleTrigger.h.

System:: Collections:: Generic:: List< System:: Collections:: Generic:: KeyValuePair< System:: String^, System:: String^>>^ CPPCli::NewScheduleTrigger::EventProperties

getset

Gets or sets the event properties that will activate the schedule.

A List containing the event properties.

Definition at line 86 of file NewScheduleTrigger.h.

System:: String^ CPPCli::NewScheduleTrigger::EventSource

getset

Gets or sets the unique identifier of a device. If set, the Event will activate the schedule trigger only when it occurs on this device.

The unique device identifier.

Definition at line 121 of file NewScheduleTrigger.h.

Clip:: RecordingFramerates CPPCli::NewScheduleTrigger::Framerate

getset

Gets or sets the recording framerate level.

The framerate level.

Definition at line 131 of file NewScheduleTrigger.h.

System:: String^ CPPCli::NewScheduleTrigger::Id

getset

Gets or sets the unique identifier of the schedule trigger.

The unique identifier.

Definition at line 141 of file NewScheduleTrigger.h.

int CPPCli::NewScheduleTrigger::PostTrigger

getset

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

The post trigger time in seconds.

Definition at line 152 of file NewScheduleTrigger.h.

int CPPCli::NewScheduleTrigger::PreTrigger

getset

Gets or sets the amount of time, from 0 to 30 seconds, to consider the schedule trigger active prior to when it becomes active ("pre alarm").

The pre trigger time in seconds.

Definition at line 163 of file NewScheduleTrigger.h.

System:: Collections:: Generic:: List< int>^ CPPCli::NewScheduleTrigger::RecurMonthly

getset

Gets or sets the days of the month, from 1 to 31, that the schedule trigger shall only be active on.

A List of the active days.

Definition at line 183 of file NewScheduleTrigger.h.

ScheduleTrigger:: RecurrenceTypes CPPCli::NewScheduleTrigger::RecurrenceType

getset

Gets or sets the interval at which the schedule trigger repeats.

The trigger interval.

Definition at line 173 of file NewScheduleTrigger.h.

System:: Collections:: Generic:: List< int>^ CPPCli::NewScheduleTrigger::RecurWeekly

getset

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

A List of the active days.

Definition at line 208 of file NewScheduleTrigger.h.

System:: Collections:: Generic:: List< int>^ CPPCli::NewScheduleTrigger::RecurYearly

getset

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

A List of the active months.

Definition at line 233 of file NewScheduleTrigger.h.

System:: DateTime CPPCli::NewScheduleTrigger::StartDate

getset

Gets or sets 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.

The start date.

Definition at line 260 of file NewScheduleTrigger.h.

int CPPCli::NewScheduleTrigger::Timeout

getset

Gets or sets the amount of time, from 1 to 300 seconds, to consider the schedule trigger active immediately after it becomes active ("duration recording").

The timeout in seconds.

Definition at line 271 of file NewScheduleTrigger.h.

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

C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/NewScheduleTrigger.h

Public Member Functions

Package Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation

Property Documentation