The Situation class 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 <ScheduleTrigger.h>

Public Types
enum	RecurrenceTypes { RecurrenceTypes::Unknown, RecurrenceTypes::Daily, RecurrenceTypes::Weekly, RecurrenceTypes::Monthly, RecurrenceTypes::Yearly }
	Values that represent the interval at which triggers repeat. More...

enum	SituationTypes { SituationTypes::Unknown, SituationTypes::AlarmActive, SituationTypes::AlarmInactive, SituationTypes::Motion, SituationTypes::NoMotion }
	Values that represent the available situation types for triggering a schedule. More...

Public Member Functions
	ScheduleTrigger (VxSdk::IVxScheduleTrigger *vxScheduleTrigger)
	Constructor. More...

virtual	~ScheduleTrigger ()
	Destructor. More...

	!ScheduleTrigger ()
	Finaliser. More...

Results::Value	Refresh ()
	Update this instances properties. More...

Package Attributes
VxSdk::IVxScheduleTrigger *	_scheduleTrigger

Properties
System::DateTime	DailyEndTime `[get, set]`
	Gets or sets the time at which the schedule trigger ends. More...

System::DateTime	DailyStartTime `[get, set]`
	Gets or sets the time at which the schedule trigger begins. More...

System::DateTime	EndDate `[get, set]`
	Gets or sets the date at which the schedule trigger ends. More...

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]`
	Gets 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...

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. 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 Situation class 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 14 of file ScheduleTrigger.h.

Member Enumeration Documentation

enum CPPCli::ScheduleTrigger::RecurrenceTypes

strong

Values that represent the interval at which triggers repeat.

Enumerator
Unknown	An error or unknown value was returned.
Daily	Repeat daily.
Weekly	Repeat weekly.
Monthly	Repeat monthly.
Yearly	Repeat yearly.

Definition at line 20 of file ScheduleTrigger.h.

                                    {
             Unknown,
 
             Daily,
 
             Weekly,
 
             Monthly,
 
             Yearly
         };

enum CPPCli::ScheduleTrigger::SituationTypes

strong

Values that represent the available situation types for triggering a schedule.

Enumerator
Unknown	An error or unknown value was returned.
AlarmActive	Hardware or software alarm active (system/alarm_active).
AlarmInactive	Hardware or software alarm inactive (system/alarm_inactive).
Motion	Motion anayltic alarm active (analytic/motion).
NoMotion	Motion anayltic alarm inactive (analytic/no_motion).

Definition at line 40 of file ScheduleTrigger.h.

                                    {
             Unknown,
 
             AlarmActive,
 
             AlarmInactive,
 
             Motion,
 
             NoMotion
         };

Constructor & Destructor Documentation

CPPCli::ScheduleTrigger::ScheduleTrigger ( VxSdk::IVxScheduleTrigger * vxScheduleTrigger )

Constructor.

Parameters

vxScheduleTrigger The schedule trigger.

Definition at line 9 of file ScheduleTrigger.cpp.

                                                                                  {
     _scheduleTrigger = vxScheduleTrigger;
 }

virtual CPPCli::ScheduleTrigger::~ScheduleTrigger ( )

inlinevirtual

Destructor.

Definition at line 66 of file ScheduleTrigger.h.

                                    {
             this->!ScheduleTrigger();
         }

CPPCli::ScheduleTrigger::!ScheduleTrigger ( )

Finaliser.

Definition at line 13 of file ScheduleTrigger.cpp.

                                         {
     _scheduleTrigger->Delete();
     _scheduleTrigger = nullptr;
 }

Member Function Documentation

CPPCli::Results::Value CPPCli::ScheduleTrigger::Refresh ( )

Update this instances properties.

Returns: The Result of updating the properties.

Definition at line 18 of file ScheduleTrigger.cpp.

                                                   {
     return (CPPCli::Results::Value)_scheduleTrigger->Refresh();
 }

Member Data Documentation

VxSdk::IVxScheduleTrigger* CPPCli::ScheduleTrigger::_scheduleTrigger

package

Definition at line 316 of file ScheduleTrigger.h.

Property Documentation

System:: DateTime CPPCli::ScheduleTrigger::DailyEndTime

getset

Gets or sets the time at which the schedule trigger ends.

The time at which the schedule trigger ends.

Definition at line 85 of file ScheduleTrigger.h.

System:: DateTime CPPCli::ScheduleTrigger::DailyStartTime

getset

Gets or sets the time at which the schedule trigger begins.

The time at which the schedule trigger begins.

Definition at line 95 of file ScheduleTrigger.h.

System:: DateTime CPPCli::ScheduleTrigger::EndDate

getset

Gets or sets the date at which the schedule trigger ends.

The date at which the schedule trigger ends.

Definition at line 105 of file ScheduleTrigger.h.

SituationTypes CPPCli::ScheduleTrigger::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 117 of file ScheduleTrigger.h.

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

getset

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

A List containing the event properties.

Definition at line 127 of file ScheduleTrigger.h.

System:: String^ CPPCli::ScheduleTrigger::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 161 of file ScheduleTrigger.h.

Clip:: RecordingFramerates CPPCli::ScheduleTrigger::Framerate

getset

Gets or sets the recording framerate level.

The framerate level.

Definition at line 175 of file ScheduleTrigger.h.

System:: String^ CPPCli::ScheduleTrigger::Id

get

Gets the unique identifier of the schedule trigger.

The unique identifier.

Definition at line 185 of file ScheduleTrigger.h.

int CPPCli::ScheduleTrigger::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 195 of file ScheduleTrigger.h.

int CPPCli::ScheduleTrigger::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 206 of file ScheduleTrigger.h.

System:: Collections:: Generic:: List< int>^ CPPCli::ScheduleTrigger::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 226 of file ScheduleTrigger.h.

RecurrenceTypes CPPCli::ScheduleTrigger::RecurrenceType

getset

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

The trigger interval.

Definition at line 216 of file ScheduleTrigger.h.

System:: Collections:: Generic:: List< int>^ CPPCli::ScheduleTrigger::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 250 of file ScheduleTrigger.h.

System:: Collections:: Generic:: List< int>^ CPPCli::ScheduleTrigger::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 274 of file ScheduleTrigger.h.

System:: DateTime CPPCli::ScheduleTrigger::StartDate

getset

Gets or sets the date at which the schedule trigger begins.

The date at which the schedule trigger begins.

Definition at line 298 of file ScheduleTrigger.h.

int CPPCli::ScheduleTrigger::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 309 of file ScheduleTrigger.h.

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

C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/ScheduleTrigger.h
C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/ScheduleTrigger.cpp

Public Types

Public Member Functions

Package Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation