CppSamples::Common::Plugin Class Reference

Plugin is the abstract class which can be a menu item and/or a sample. Every sample and menu item must be a Plugin. More...

#include <Plugin.h>

Public Member Functions
	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...
virtual Plugin *	Run (DataModel *dataModel)=0
	This abstract method must be overridden by derived classes. More...
void	SetParent (Plugin *parent)
	Sets the reference to the parent of this plugin. More...

Private Attributes
std::string	_description
Plugin *	_parent

Detailed Description

Plugin is the abstract class which can be a menu item and/or a sample. Every sample and menu item must be a Plugin.

Definition at line 33 of file Plugin.h.

Inherited by CppSamples::Bookmarks::AddBookmark, CppSamples::Bookmarks::DeleteBookmark, CppSamples::Bookmarks::ViewAllBookmarks, CppSamples::Common::BackMenu, CppSamples::Common::ExitMenu, CppSamples::Common::MenuItem, CppSamples::DataObjects::AddDataObject, CppSamples::DataObjects::DeleteDataObject, CppSamples::DataObjects::ViewAllDataObjects, CppSamples::DataSource::ViewAllDataSource, CppSamples::DataSource::ViewDataSourceByPage, CppSamples::DataSource::ViewDataSourceDetails, CppSamples::Devices::ViewAllDevices, CppSamples::Drawings::AddDrawing, CppSamples::Drawings::DeleteDrawing, CppSamples::Drawings::ViewAllDrawings, CppSamples::Events::AddSituation, CppSamples::Events::DeleteSituation, CppSamples::Events::DisplaySituations, CppSamples::Events::InjectEvents, CppSamples::Events::MonitorEvents, CppSamples::Events::SearchEvents, CppSamples::Exports::CreateExport, CppSamples::Exports::DeleteExport, CppSamples::Exports::DownloadExport, CppSamples::Exports::ViewExport, CppSamples::LiveStreaming::DataSourceLiveStreaming, CppSamples::Notifications::AddNotification, CppSamples::Notifications::DeleteNotification, CppSamples::Notifications::ViewAllNotifications, CppSamples::Reports::ViewQuickReport, CppSamples::Roles::AddRole, CppSamples::Roles::DeleteRole, CppSamples::Roles::ViewAllRoles, CppSamples::Schedules::AddSchedule, CppSamples::Schedules::AddTriggerToSchedule, CppSamples::Schedules::DeleteSchedule, CppSamples::Schedules::ViewAllSchedules, CppSamples::Tags::AddTag, CppSamples::Tags::DeleteTag, CppSamples::Tags::MergeTag, CppSamples::Tags::ViewAllTags, CppSamples::Users::AddUser, CppSamples::Users::DeleteUser, and CppSamples::Users::ViewAllUsers.

Constructor & Destructor Documentation

CppSamples::Common::Plugin::Plugin ( const std::string  description )

inline

Definition at line 35 of file Plugin.h.

: _description(description), _parent(nullptr) { }

virtual CppSamples::Common::Plugin::~Plugin ( )

inlinevirtual

Definition at line 36 of file Plugin.h.

{ }

Member Function Documentation

std::string CppSamples::Common::Plugin::GetDescription ( ) const

inline

Gets the description of this plugin.

Definition at line 41 of file Plugin.h.

{ return _description; }

Plugin* CppSamples::Common::Plugin::GetParent ( ) const

inline

Gets the reference to the parent of this plugin.

Definition at line 46 of file Plugin.h.

{ return _parent; }

virtual Plugin* CppSamples::Common::Plugin::Run ( DataModel *  dataModel )

pure virtual

This abstract method must be overridden by derived classes.

Parameters

dataModel

Instance of data model.

Implemented in CppSamples::Common::ExitMenu, CppSamples::Common::BackMenu, CppSamples::LiveStreaming::DataSourceLiveStreaming, CppSamples::Bookmarks::AddBookmark, CppSamples::Notifications::AddNotification, CppSamples::Bookmarks::DeleteBookmark, CppSamples::Bookmarks::ViewAllBookmarks, CppSamples::Common::MenuItem, CppSamples::DataObjects::AddDataObject, CppSamples::DataObjects::DeleteDataObject, CppSamples::DataObjects::ViewAllDataObjects, CppSamples::DataSource::ViewAllDataSource, CppSamples::DataSource::ViewDataSourceByPage, CppSamples::Devices::ViewAllDevices, CppSamples::Drawings::AddDrawing, CppSamples::Drawings::DeleteDrawing, CppSamples::Drawings::ViewAllDrawings, CppSamples::Events::AddSituation, CppSamples::Events::DeleteSituation, CppSamples::Events::DisplaySituations, CppSamples::Events::InjectEvents, CppSamples::Events::MonitorEvents, CppSamples::Events::SearchEvents, CppSamples::Exports::CreateExport, CppSamples::Exports::DeleteExport, CppSamples::Exports::DownloadExport, CppSamples::Exports::ViewExport, CppSamples::Notifications::DeleteNotification, CppSamples::Notifications::ViewAllNotifications, CppSamples::Reports::ViewQuickReport, CppSamples::Roles::AddRole, CppSamples::Roles::DeleteRole, CppSamples::Roles::ViewAllRoles, CppSamples::Schedules::AddSchedule, CppSamples::Schedules::AddTriggerToSchedule, CppSamples::Schedules::DeleteSchedule, CppSamples::Schedules::ViewAllSchedules, CppSamples::Tags::AddTag, CppSamples::Tags::DeleteTag, CppSamples::Tags::MergeTag, CppSamples::Tags::ViewAllTags, CppSamples::Users::AddUser, CppSamples::Users::DeleteUser, CppSamples::Users::ViewAllUsers, and CppSamples::DataSource::ViewDataSourceDetails.

void CppSamples::Common::Plugin::SetParent ( Plugin *  parent )

inline

Sets the reference to the parent of this plugin.

Parameters

parent

Parent of this plugin

Definition at line 58 of file Plugin.h.

{ _parent = parent; }

Member Data Documentation

std::string CppSamples::Common::Plugin::_description

private

Definition at line 61 of file Plugin.h.

Plugin* CppSamples::Common::Plugin::_parent

private

Definition at line 62 of file Plugin.h.

---

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

• C:/Git/VxSDK-Samples/CppSamples/Source/Common/Plugin.h