Medical Imaging Interaction Toolkit  2018.04.99-3ec0dd08
Medical Imaging Interaction Toolkit
us::ServiceFindHook Struct Referenceabstract

#include <usServiceFindHook.h>

Public Member Functions

virtual ~ServiceFindHook ()
 
virtual void Find (const ModuleContext *context, const std::string &name, const std::string &filter, ShrinkableVector< ServiceReferenceBase > &references)=0
 

Detailed Description

Service Find Hook Service.

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

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

Definition at line 47 of file usServiceFindHook.h.

Constructor & Destructor Documentation

◆ ~ServiceFindHook()

virtual us::ServiceFindHook::~ServiceFindHook ( )
virtual

Member Function Documentation

◆ Find()

virtual void us::ServiceFindHook::Find ( const ModuleContext context,
const std::string &  name,
const std::string &  filter,
ShrinkableVector< ServiceReferenceBase > &  references 
)
pure virtual

Find hook method. This method is called during the service find operation (for example, ModuleContext::GetServiceReferences<S>()). This method can filter the result of the find operation.

Parameters
contextThe module context of the module performing the find operation.
nameThe class name of the services to find or an empty string to find all services.
filterThe filter criteria of the services to find or an empty string for no filter criteria.
referencesA list of Service References to be returned as a result of the find operation. The implementation of this method may remove service references from the list to prevent the references from being returned to the module performing the find operation.

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