Medical Imaging Interaction Toolkit  2021.10.00
Medical Imaging Interaction Toolkit
us::ModuleFindHook Struct Referenceabstract

#include <usModuleFindHook.h>

Public Member Functions

virtual ~ModuleFindHook ()
virtual void Find (const ModuleContext *context, ShrinkableVector< Module *> &modules)=0

Detailed Description

Module Context Hook Service.

Modules registering this service will be called during module find (get modules) operations.

Implementations of this interface are required to be thread-safe.

Definition at line 44 of file usModuleFindHook.h.

Constructor & Destructor Documentation

◆ ~ModuleFindHook()

virtual us::ModuleFindHook::~ModuleFindHook ( )

Member Function Documentation

◆ Find()

virtual void us::ModuleFindHook::Find ( const ModuleContext context,
ShrinkableVector< Module *> &  modules 
pure virtual

Find hook method. This method is called for module find operations using ModuleContext::GetBundle(long) and ModuleContext::GetModules() methods. The find method can filter the result of the find operation.

A find operation using the ModuleContext::GetModule(const std::string&) method does not cause the find method to be called, neither does any call to the static methods of the ModuleRegistry class.
contextThe module context of the module performing the find operation.
modulesA list of Modules to be returned as a result of the find operation. The implementation of this method may remove modules from the list to prevent the modules from being returned to the module performing the find operation.

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