Класс com::sys::UserPlugin

Интерфейс пользовательского плагина Подробнее...

#include <user_plugin.h>

Граф наследования:com::sys::UserPlugin:

Граф связей класса com::sys::UserPlugin:

Открытые члены
virtual std::string	getInterfaceName () const
virtual bool	isInstanceOf (const std::string &p_interfaceName) const
virtual std::string	getPluginAuthor () const =0
virtual std::string	getPluginVersion () const =0
virtual std::string	getPluginCopyright () const =0
virtual std::string	getPluginDescription () const =0
virtual std::string	getShortText () const =0
virtual std::string	getMiddleText () const =0
virtual std::string	getLongText () const =0
Открытые члены inherited from com::sys::BasePlugin
virtual void	destroyPlugin ()=0

Additional Inherited Members
Открытые типы inherited from com::sys::BasePlugin
typedef MAC_DLLEXPORT BasePlugin *	RegisterPluginFunction (void *p_inputParam)

Подробное описание

Интерфейс пользовательского плагина

Данный интерфейс позволяет создавать пользовательские плагины, которые можно будет вручную импортировать в систему.

Методы

virtual std::string com::sys::UserPlugin::getInterfaceName ( ) const

inlinevirtual

Возвращает имя интерфейса. При создании новых интерфейсов, наследующихся от данного, эта функция должна быть переопределена

Возвращает

Имя интерфейса

Переопределяет метод предка com::sys::BasePlugin.

virtual std::string com::sys::UserPlugin::getLongText ( ) const

pure virtual

Возвращает длинное название плагина (до 20 символов)

Возвращает

Название плагина

virtual std::string com::sys::UserPlugin::getMiddleText ( ) const

pure virtual

Возвращает среднее название плагина (до 12 символов)

Возвращает

Название плагина

virtual std::string com::sys::UserPlugin::getPluginAuthor ( ) const

pure virtual

Возвращает имя автора плагина

Возвращает

Имя автора

virtual std::string com::sys::UserPlugin::getPluginCopyright ( ) const

pure virtual

Возвращает copyright плагина

Возвращает

Сopyright плагина

virtual std::string com::sys::UserPlugin::getPluginDescription ( ) const

pure virtual

Возвращает описание плагина (до 300 символов)

Возвращает

Описание плагина

virtual std::string com::sys::UserPlugin::getPluginVersion ( ) const

pure virtual

Возвращает версию плагина в виде строки

Возвращает

Версия плагина

virtual std::string com::sys::UserPlugin::getShortText ( ) const

pure virtual

Возвращает короткое название плагина (до 6 символов)

Возвращает

Название плагина

virtual bool com::sys::UserPlugin::isInstanceOf ( const std::string &  p_interfaceName ) const

inlinevirtual

Проверяет, совпадает ли переданное имя интерфейса с текущим

Аргументы

[in]

p_interfaceName

Проверяемое имя интерфейса

Возвращает

true, если совпадает

Переопределяет метод предка com::sys::BasePlugin.

---

Объявления и описания членов класса находятся в файле:

• dev/user_plugin.h