cppexpose::AbstractComponent Class Reference

Abstract base class for components. More...

#include <cppexpose/include/cppexpose/plugin/AbstractComponent.h>

Inheritance diagram for cppexpose::AbstractComponent:

Public Member Functions
	AbstractComponent ()
	Constructor. More...
virtual	~AbstractComponent ()
	Destructor. More...
const char *	name () const
	Get name. More...
const char *	description () const
	Get description. More...
const char *	type () const
	Get type. More...
const char *	tags () const
	Get sub-type. More...
const char *	icon () const
	Get icon. More...
const char *	annotations () const
	Get annotations. More...
const char *	vendor () const
	Get vendor. More...
const char *	version () const
	Get version. More...

Protected Attributes
std::string	m_name
	Component name. More...
std::string	m_description
	Component description. More...
std::string	m_type
	Component type. More...
std::string	m_tags
	Component tags (user-defined, space-separated) More...
std::string	m_icon
	Icon name or ID. More...
std::string	m_annotations
	Component annotations. More...
std::string	m_vendor
	Vendor name. More...
std::string	m_version
	Component version. More...

Detailed Description

Abstract base class for components.

Constructor & Destructor Documentation

cppexpose::AbstractComponent::AbstractComponent

(

)

Constructor.

virtual cppexpose::AbstractComponent::~AbstractComponent ( )

virtual

Destructor.

Member Function Documentation

const char* cppexpose::AbstractComponent::name

(

)

const

Get name.

Returns

Component name

const char* cppexpose::AbstractComponent::description

(

)

const

Get description.

Returns

Component description

const char* cppexpose::AbstractComponent::type

(

)

const

Get type.

Returns

Component type

const char* cppexpose::AbstractComponent::tags

(

)

const

Get sub-type.

Returns

Component tags (user-defined, space-separated)

Remarks

Tags can be chosen arbitrarily by the using application, for example to order plugins into additional categories. Tags are empty by default.

const char* cppexpose::AbstractComponent::icon

(

)

const

Get icon.

Returns

Icon name or ID

Remarks

The icon field can point to a file name or ID that is used to display an icon for the component. The actual content is application specific and not defined by cppexpose.

const char* cppexpose::AbstractComponent::annotations

(

)

const

Get annotations.

Returns

Component annotations

Remarks

Annotations can be used to provide additional machine-readable information about the component. The syntax and semantics for annotations are not defined by cppexpose and can be chosen freely by the systems that use cppexpose. By default, annotations are empty.

const char* cppexpose::AbstractComponent::vendor

(

)

const

Get vendor.

Returns

Vendor name

const char* cppexpose::AbstractComponent::version

(

)

const

Get version.

Returns

Component version

Member Data Documentation

std::string cppexpose::AbstractComponent::m_name

protected

Component name.

std::string cppexpose::AbstractComponent::m_description

protected

Component description.

std::string cppexpose::AbstractComponent::m_type

protected

Component type.

std::string cppexpose::AbstractComponent::m_tags

protected

Component tags (user-defined, space-separated)

std::string cppexpose::AbstractComponent::m_icon

protected

Icon name or ID.

std::string cppexpose::AbstractComponent::m_annotations

protected

Component annotations.

std::string cppexpose::AbstractComponent::m_vendor

protected

Vendor name.

std::string cppexpose::AbstractComponent::m_version

protected

Component version.

---

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

• AbstractComponent.h