NDEVR
API Documentation
ManualManager

Manages all available manuals in the software. More...

Inheritance diagram for ManualManager:
[legend]
Collaboration diagram for ManualManager:
[legend]

Public Member Functions

void addManual (const Manual &manual)
 Registers a manual entry with this manager.
const Buffer< Manual > & manuals () const
 Returns a read-only reference to all registered manuals.

Static Public Member Functions

static ManualManager & DefaultManager ()
 Returns the singleton default ManualManager instance.

Protected Attributes

Buffer< Manual > m_manuals
 The collection of registered manuals.

Detailed Description

Manages all available manuals in the software.

Definition at line 30 of file ManualManager.h.

Member Function Documentation

◆ addManual()

void ManualManager::addManual ( const Manual & manual)

Registers a manual entry with this manager.

Parameters
[in]manualThe Manual to add.

◆ DefaultManager()

ManualManager & ManualManager::DefaultManager ( )
static

Returns the singleton default ManualManager instance.

Returns
A reference to the default ManualManager.

◆ manuals()

const Buffer< Manual > & ManualManager::manuals ( ) const

Returns a read-only reference to all registered manuals.

Returns
The buffer of Manual entries.
The documentation for this class was generated from the following file: