NAP
Public Member Functions | List of all members
Module Class Referencefinal

#include <nap/modulemanager.h>

Public Member Functions

 Module ()=default
 
 Module (Module &)=delete
 
Moduleoperator= (const Module &)=delete
 
 Module (Module &&)=delete
 
Moduleoperator= (Module &&)=delete
 
const std::string & getName () const
 
const ModuleDescriptorgetDescriptor () const
 
const ModuleInfogetInformation () const
 
std::string findAsset (const std::string &name) const
 
const rtti::TypeInfo getServiceType () const
 

Description

Contains all data associated with a module, including handle and description. Created and managed by the nap::ModuleManager.

Constructor & Destructor Documentation

◆ Module() [1/3]

Module ( )
default

◆ Module() [2/3]

Module ( Module )
delete

◆ Module() [3/3]

Module ( Module &&  )
delete

Member Function Documentation

◆ findAsset()

std::string findAsset ( const std::string &  name) const

Attempts to find a (module specific) asset with the given name and extension. The asset must reside in one of the locations declared by the 'nap::ModuleInfo::DataSearchPaths' property.

Returns
full path to the asset, empty string if not found

◆ getDescriptor()

const ModuleDescriptor& getDescriptor ( ) const
Returns
module descriptor

◆ getInformation()

const ModuleInfo& getInformation ( ) const
Returns
module information

◆ getName()

const std::string& getName ( ) const
Returns
module name

◆ getServiceType()

const rtti::TypeInfo getServiceType ( ) const

Returns type of service associated with this module,

Returns
type of service associated with this module, empty if module has no service.

◆ operator=() [1/2]

Module& operator= ( const Module )
delete

◆ operator=() [2/2]

Module& operator= ( Module &&  )
delete