CppSamples::Drawings::DeleteDrawing Class Reference

This plugin sample delete a selected drawing from the current system. More...

#include <DeleteDrawing.h>

Public Member Functions
	DeleteDrawing (const std::string description)
	~DeleteDrawing ()
CppSamples::Common::Plugin *	Run (CppSamples::Common::DataModel *dataModel) override
	Delete a selected drawing from 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...

Protected Member Functions
int	SelectDrawingIndex (VxSdk::VxCollection< VxSdk::IVxDrawing ** > &drawings)
	Select a drawing from the given collection by user input. More...

Static Protected Member Functions
static VxSdk::VxCollection< VxSdk::IVxDrawing ** >	GetDrawings (VxSdk::IVxSystem *vxSystem)
	Get a collection of drawings from the given VideoExpert system. More...
static void	PrintDrawings (VxSdk::VxCollection< VxSdk::IVxDrawing ** > drawingCollection)
	Prints the given collection of drawings to the screen. More...

Detailed Description

This plugin sample delete a selected drawing from the current system.

Definition at line 12 of file DeleteDrawing.h.

Inherits CppSamples::Common::Plugin.

Constructor & Destructor Documentation

CppSamples::Drawings::DeleteDrawing::DeleteDrawing ( const std::string  description )

inline

Definition at line 14 of file DeleteDrawing.h.

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

CppSamples::Drawings::DeleteDrawing::~DeleteDrawing ( )

inline

Definition at line 15 of file DeleteDrawing.h.

{ }

Member Function Documentation

VxCollection< IVxDrawing ** > CppSamples::Drawings::DeleteDrawing::GetDrawings ( VxSdk::IVxSystem *  vxSystem )

staticprotected

Get a collection of drawings from the given VideoExpert system.

Parameters

vxSystem

Pointer to the VideoExpert system.

Returns

A collection of drawings.

Definition at line 45 of file DeleteDrawing.cpp.

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

void CppSamples::Drawings::DeleteDrawing::PrintDrawings ( VxSdk::VxCollection< VxSdk::IVxDrawing ** >  drawingCollection )

staticprotected

Prints the given collection of drawings to the screen.

Parameters

drawingCollection

Collection of drawings.

Definition at line 59 of file DeleteDrawing.cpp.

                                                                                                {

    cout << drawingCollection.collectionSize << " drawings found." << "\n";
    if (drawingCollection.collectionSize == 0)
        return;

    cout << "---------------------------------------------------------------------------------------------";
    for (int i = 0; i < drawingCollection.collectionSize; i++) {
        IVxDrawing* drawing = drawingCollection.collection[i];

        cout << "\n" << (i + 1);
        cout << "\t" << drawing->id;
        cout << "\t" << drawing->name;
    }
    cout << "\n---------------------------------------------------------------------------------------------\n";
}

Plugin * CppSamples::Drawings::DeleteDrawing::Run ( CppSamples::Common::DataModel *  dataModel )

overridevirtual

Delete a selected drawing from the current system.

Parameters

dataModel

Instance of data model.

Implements CppSamples::Common::Plugin.

Definition at line 13 of file DeleteDrawing.cpp.

                                                                 {
    Utility::ClearScreen();

    VxCollection<IVxDrawing**> drawings = GetDrawings(dataModel->VxSystem);
    PrintDrawings(drawings);

    if (drawings.collectionSize > 0) {
        int index = SelectDrawingIndex(drawings);
        if (index >= 0) {
            IVxDrawing* drawing = drawings.collection[index];
            VxResult::Value result = drawing->DeleteDrawing();
            if (result == VxResult::kOK)
                cout << "\n" << "Drawing deleted succesfully.\n";
            else
                cout << "\n" << "Failed to delete drawing!!\n";
        }
    }

    // Remove the memory allocated to the collection.
    delete[] drawings.collection;
    // 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();
}

int CppSamples::Drawings::DeleteDrawing::SelectDrawingIndex ( VxSdk::VxCollection< VxSdk::IVxDrawing ** > &  drawings )

protected

Select a drawing from the given collection by user input.

Parameters

drawings

Collection of drawing.

Returns

Index of the selected drawing in the given collection.

Definition at line 81 of file DeleteDrawing.cpp.

                                                                                            {
    while (true) {
        cout << "\n" << "Enter drawing number [1-" << drawings.collectionSize << "] : ";
        int index = Utility::ReadInt();
        if (index == 0)
            break;
        if (index > 0 && index <= drawings.collectionSize)
            return index - 1;
        else
            cout << "\n" << "Invalid Option !!!";

        cout << "\n" << "Enter 0 to go back.";
    }

    return -1;
}

---

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

• C:/Git/VxSDK-Samples/CppSamples/Source/Drawings/DeleteDrawing.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Drawings/DeleteDrawing.cpp