peak::core::ModuleDescriptor Class Reference

The base class for all openable modules. More...

#include <peak/common/peak_module_descriptor.hpp>

Inheritance diagram for peak::core::ModuleDescriptor:

Public Member Functions
	ModuleDescriptor ()=default
virtual	~ModuleDescriptor ()=default
	ModuleDescriptor (const ModuleDescriptor &other)=delete
ModuleDescriptor &	operator= (const ModuleDescriptor &other)=delete
	ModuleDescriptor (ModuleDescriptor &&other)=delete
ModuleDescriptor &	operator= (ModuleDescriptor &&other)=delete
std::string	ID () const
	Returns the ID of the described module. More...

Protected Member Functions
virtual PEAK_MODULE_DESCRIPTOR_HANDLE	ModuleDescriptorHandle () const =0

Detailed Description

The base class for all openable modules.

Constructor & Destructor Documentation

ModuleDescriptor() [1/3]

peak::core::ModuleDescriptor::ModuleDescriptor ( )

default

~ModuleDescriptor()

virtual peak::core::ModuleDescriptor::~ModuleDescriptor ( )

virtualdefault

ModuleDescriptor() [2/3]

peak::core::ModuleDescriptor::ModuleDescriptor ( const ModuleDescriptor &  other )

delete

ModuleDescriptor() [3/3]

peak::core::ModuleDescriptor::ModuleDescriptor ( ModuleDescriptor &&  other )

delete

Member Function Documentation

ID()

std::string peak::core::ModuleDescriptor::ID ( ) const

inline

Returns the ID of the described module.

Returns

ID

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

ModuleDescriptorHandle()

virtual PEAK_MODULE_DESCRIPTOR_HANDLE peak::core::ModuleDescriptor::ModuleDescriptorHandle ( ) const

protectedpure virtual

operator=() [1/2]

ModuleDescriptor& peak::core::ModuleDescriptor::operator= ( const ModuleDescriptor &  other )

delete

operator=() [2/2]

ModuleDescriptor& peak::core::ModuleDescriptor::operator= ( ModuleDescriptor &&  other )

delete

---

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

• peak/common/peak_module_descriptor.hpp