peak::core::Module Class Reference

Represents an extended GenTL port. More...

#include <peak/common/peak_module.hpp>

Inheritance diagram for peak::core::Module:

Public Member Functions
	Module ()=default
virtual	~Module ()=default
	Module (const Module &other)=delete
Module &	operator= (const Module &other)=delete
	Module (Module &&other)=delete
Module &	operator= (Module &&other)=delete
std::vector< std::shared_ptr< NodeMap > >	NodeMaps () const
	Returns the module's node maps. More...
std::shared_ptr< class Port >	Port () const
	Returns the module's port. More...

Protected Member Functions
virtual PEAK_MODULE_HANDLE	ModuleHandle () const =0

Detailed Description

Represents an extended GenTL port.

This class extends the functionality of a GenTL port with the functionality of the GenAPI. Instead of separating the node map from the port, this class brings them together making it much easier to get things done.

Constructor & Destructor Documentation

Module() [1/3]

peak::core::Module::Module ( )

default

~Module()

virtual peak::core::Module::~Module ( )

virtualdefault

Module() [2/3]

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

delete

Module() [3/3]

peak::core::Module::Module ( Module &&  other )

delete

Member Function Documentation

ModuleHandle()

virtual PEAK_MODULE_HANDLE peak::core::Module::ModuleHandle ( ) const

protectedpure virtual

NodeMaps()

std::vector< std::shared_ptr< NodeMap > > peak::core::Module::NodeMaps ( ) const

inline

Returns the module's node maps.

Returns

Node maps

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

Port()

std::shared_ptr< class Port > peak::core::Module::Port ( ) const

inline

Returns the module's port.

Returns

Port

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

---

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

• peak/common/peak_module.hpp