CppSamples::Schedules::AddTriggerToSchedule Class Reference

This plugin sample creates a trigger and add it to a selected schedule in the current system. More...

#include <AddTriggerToSchedule.h>

Public Member Functions
	AddTriggerToSchedule (const std::string description)
	~AddTriggerToSchedule ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Creates a trigger and add it to a selected schedule in the current system. More...
Public Member Functions inherited from CppSamples::Common::Plugin
	Plugin (const std::string description)
virtual	~Plugin ()
std::string	GetDescription () const
	Gets the description of this plugin. More...
Plugin *	GetParent () const
	Gets the reference to the parent of this plugin. More...
void	SetParent (Plugin *parent)
	Sets the reference to the parent of this plugin. More...

Private Member Functions
VxSdk::VxCollection< VxSdk::IVxSchedule ** >	GetSchedules (VxSdk::IVxSystem *vxSystem)
	Get a collection of schedules from the given VideoExpert system. More...

Static Private Member Functions
static std::string	ReadTime (std::string message)
	Reads a time from user input More...
static std::string	ReadDate (std::string message)
	Reads a date from user input in DD-MM-YY format. More...

Detailed Description

This plugin sample creates a trigger and add it to a selected schedule in the current system.

Definition at line 12 of file AddTriggerToSchedule.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

CppSamples::Schedules::AddTriggerToSchedule::AddTriggerToSchedule ( const std::string  description )

inline

Definition at line 14 of file AddTriggerToSchedule.h.

: CppSamples::Common::Plugin(description) { }

CppSamples::Schedules::AddTriggerToSchedule::~AddTriggerToSchedule ( )

inline

Definition at line 15 of file AddTriggerToSchedule.h.

{}

Member Function Documentation

VxCollection< IVxSchedule ** > CppSamples::Schedules::AddTriggerToSchedule::GetSchedules ( VxSdk::IVxSystem *  vxSystem )

private

Get a collection of schedules from the given VideoExpert system.

Parameters

vxSystem

Pointer to the VideoExpert system.

Returns

A collection of schedules.

Definition at line 110 of file AddTriggerToSchedule.cpp.

                                                                                                     {
    VxCollection<IVxSchedule**> schedules;
    VxResult::Value result = vxSystem->GetSchedules(schedules);
    if (result == VxResult::kInsufficientSize) {
        schedules.collection = new IVxSchedule*[schedules.collectionSize];
        vxSystem->GetSchedules(schedules);
    }
    return schedules;
}

string CppSamples::Schedules::AddTriggerToSchedule::ReadDate ( std::string  message )

staticprivate

Reads a date from user input in DD-MM-YY format.

Parameters

message

Message to be printed while before reading date

Definition at line 147 of file AddTriggerToSchedule.cpp.

                                                                       {
    cout << message << "(dd-mm-yy) : ";
    string utcFormat = Utility::ReadString();

    std::stringstream dateStream(utcFormat);
    struct tm parseDate;
    //Here parse date string value to date structure
    dateStream >> std::get_time(&parseDate, "%d-%m-%Y");

    parseDate.tm_hour = 0;
    parseDate.tm_min = 0;
    parseDate.tm_sec = 0;

    char buffer[9];
    strftime(buffer, 9, "%x", &parseDate);

    return string(buffer);
}

string CppSamples::Schedules::AddTriggerToSchedule::ReadTime ( std::string  message )

staticprivate

Reads a time from user input

Parameters

message

Message to be printed while before reading time

Definition at line 124 of file AddTriggerToSchedule.cpp.

                                                                       {
    cout << message << "(HH:MM:SS) : ";
    string utcFormat = Utility::ReadString();

    std::stringstream dateStream(utcFormat);
    struct tm parseTime;
    //Here parse time string value to time structure
    dateStream >> std::get_time(&parseTime, "%H:%M:%S");

    parseTime.tm_mday = 1;
    parseTime.tm_mon = 0;
    parseTime.tm_year = 0;

    char buffer[9];
    strftime(buffer, 9, "%X", &parseTime);

    return string(buffer);
}

Plugin * CppSamples::Schedules::AddTriggerToSchedule::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Creates a trigger and add it to a selected schedule in the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 15 of file AddTriggerToSchedule.cpp.

                                                                         {
    cout << "\n";
    VxCollection<IVxSchedule**> schedules = GetSchedules(dataModel->VxSystem);
    OptionSelector<IVxSchedule*> optionSelector;
    optionSelector.Heading = "Select a schedule to add trigger";
    for (int i = 0; i < schedules.collectionSize; i++) {
        IVxSchedule* schedule = schedules.collection[i];
        string name = schedule->id + string("\t") + schedule->name;
        optionSelector.AddItem(name, schedule);
    }

    IVxSchedule* selectedSchedule = nullptr;
    if (optionSelector.SelectOption(&selectedSchedule)) {

        // Create a new schedule trigger
        VxNewScheduleTrigger scheduleTrigger;
        string newGuid = Utility::GetNewGuid();
        Utilities::StrCopySafe(scheduleTrigger.id, newGuid.c_str());

        cout << "\n";

        // Start Time
        VxSdk::Utilities::StrCopySafe(scheduleTrigger.dailyStartTime, ReadTime("Enter Start Time ").c_str());

        // End Time
        VxSdk::Utilities::StrCopySafe(scheduleTrigger.dailyEndTime, ReadTime("Enter End Time   ").c_str());

        // Start Date
        VxSdk::Utilities::StrCopySafe(scheduleTrigger.startDate, ReadDate("Enter Start Date ").c_str());

        // End Date
        VxSdk::Utilities::StrCopySafe(scheduleTrigger.endDate, ReadDate("Enter End Date   ").c_str());

        // Framerate
        OptionSelector<VxRecordingFramerate::Value> framerateSelector;
        framerateSelector.Heading = "Select a type of frame rate";
        framerateSelector.AddItem("Log", VxRecordingFramerate::kLow);
        framerateSelector.AddItem("Normal", VxRecordingFramerate::kNormal);
        if (!framerateSelector.SelectOption(&scheduleTrigger.framerate))
            scheduleTrigger.framerate = VxRecordingFramerate::kUnknown;

        // Event 
        cout << "\n";
        OptionSelector<VxSituationType::Value> eventSelector;
        eventSelector.Heading = "\nSelect a type of event";
        eventSelector.AddItem("AlarmActive", VxSituationType::kAlarmActive);
        eventSelector.AddItem("AlarmInactive", VxSituationType::kAlarmInactive);
        eventSelector.AddItem("Motion", VxSituationType::kMotion);
        eventSelector.AddItem("NoMotion", VxSituationType::kNoMotion);
        if (!eventSelector.SelectOption(&scheduleTrigger.event))
            scheduleTrigger.event = VxSituationType::kUnknown;

        // Recurrence
        cout << "\n";
        OptionSelector<VxRecurrenceType::Value> recurrenceSelector;
        recurrenceSelector.Heading = "\nSelect a type of recurrence";
        recurrenceSelector.AddItem("Daily", VxRecurrenceType::kDaily);
        recurrenceSelector.AddItem("Monthly", VxRecurrenceType::kMonthly);
        recurrenceSelector.AddItem("Weekly", VxRecurrenceType::kWeekly);
        recurrenceSelector.AddItem("Yearly", VxRecurrenceType::kYearly);
        if (!recurrenceSelector.SelectOption(&scheduleTrigger.recurrence))
            scheduleTrigger.recurrence = VxRecurrenceType::kUnknown;

        // PreTrigger
        cout << "\n" << "Enter PreTrigger value      : ";
        scheduleTrigger.preTrigger = Utility::ReadInt();

        // PostTrigger
        cout << "Enter PostTrigger value     : ";
        scheduleTrigger.postTrigger = Utility::ReadInt();

        // Timeout
        cout << "Enter Timeout Duration      : ";
        scheduleTrigger.timeout = Utility::ReadInt();

        // Make the call to add the schedule into VideoXpert
        VxResult::Value result = selectedSchedule->AddScheduleTrigger(scheduleTrigger);
        if (result == VxResult::kOK)
            cout << "\n" << "Schedule added succesfully.\n";
        else
            cout << "\n" << "Failed to add schedule.\n";
    }

    // Wait for user response before going back to parent menu.
    Utility::Pause();

    // Return reference of parent plugin to move back to parent menu.
    return GetParent();
}

---

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

• C:/Git/VxSDK-Samples/CppSamples/Source/Schedules/AddTriggerToSchedule.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Schedules/AddTriggerToSchedule.cpp