CppSamples::Events::AddSituation Class Reference

This plugin sample adds a situation to the current system. More...

#include <AddSituation.h>

Public Member Functions
	AddSituation (const std::string description)
	~AddSituation ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Adds a situation to 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
void	AddNewSituation (VxSdk::IVxSystem *vxSystem)
	Add a new situation to server. More...

Detailed Description

This plugin sample adds a situation to the current system.

Definition at line 12 of file AddSituation.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

CppSamples::Events::AddSituation::AddSituation ( const std::string  description )

inline

Definition at line 14 of file AddSituation.h.

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

CppSamples::Events::AddSituation::~AddSituation ( )

inline

Definition at line 15 of file AddSituation.h.

{}

Member Function Documentation

void CppSamples::Events::AddSituation::AddNewSituation ( VxSdk::IVxSystem *  vxSystem )

private

Add a new situation to server.

Parameters

vxSystem

Pointer to the VideoExpert system.

Definition at line 26 of file AddSituation.cpp.

                                                                      {

    cout << "\n\n" << "Enter name for situation: ";
    string sitName = Utility::ReadString();

    cout << "\n" << "Enter type for situation (in format: 'external/{company_name}/{situation_type}'): ";
    string sitType = Utility::ReadString();

    VxNewSituation situation;
    situation.Default();
#ifndef WIN32
    strncpy(situation.name, sitName.c_str(), sizeof situation.name);
    strncpy(situation.type, sitType.c_str(), sizeof situation.type);
#else
    strncpy_s(situation.name, sitName.c_str(), sizeof situation.name);
    strncpy_s(situation.type, sitType.c_str(), sizeof situation.type);
#endif

    VxResult::Value result = vxSystem->AddSituation(situation);
    if (result == VxResult::kOK)
        cout << "\n" << "Situation added succesfully.\n";
    else
        cout << "\n" << "Failed to add situation.\n";

    // Remove the memory allocated to the collection.
    delete[] situation.snoozeIntervals;

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

Plugin * CppSamples::Events::AddSituation::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Adds a situation to the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 14 of file AddSituation.cpp.

                                                              {

    AddNewSituation(dataModel->VxSystem);

    // 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/Events/AddSituation.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Events/AddSituation.cpp