Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
us Namespace Reference

Namespaces

 ServiceConstants
 

Classes

class  Any
 An Any class represents a general type and is capable of storing any type, supporting type-safe extraction of the internally stored data. More...
 
class  BadAnyCastException
 Exception thrown when an any_cast fails due to a type mismatch. More...
 
class  LDAPFilter
 An RFC 1960-based Filter. More...
 
class  LDAPProp
 A fluent API for creating LDAP filter strings. More...
 
class  ServiceReference
 
class  Module
 Represents a CppMicroServices module. More...
 
struct  ModuleActivator
 Customizes the starting and stopping of a CppMicroServices module. More...
 
class  ServiceObjects
 Allows multiple service objects for a service to be obtained. More...
 
class  ModuleContext
 
class  ModuleEvent
 An event from the Micro Services framework describing a module lifecycle change. More...
 
struct  ModuleEventHook
 Module Event Hook Service. More...
 
struct  ModuleFindHook
 Module Context Hook Service. More...
 
struct  ModuleInfo
 This class is not intended to be used directly. It is exported to support the CppMicroServices module system. More...
 
class  ModuleRegistry
 Here we handle all the modules that are loaded in the framework. More...
 
class  ModuleResource
 Represents a resource (text file, image, etc.) embedded in a CppMicroServices module. More...
 
class  ModuleResourceStream
 An input stream class for ModuleResource objects. More...
 
class  ModuleSettings
 Query and set certain properties of the CppMicroServices library. More...
 
class  ModuleVersion
 Version identifier for CppMicroServices modules. More...
 
struct  PrototypeServiceFactory
 A factory for prototype scope services. The factory can provide multiple, unique service objects. More...
 
class  ServiceEvent
 
struct  ServiceEventListenerHook
 Service Event Listener Hook Service. More...
 
class  ServiceException
 
class  ServiceFactory
 
struct  ServiceFindHook
 Service Find Hook Service. More...
 
struct  InterfaceType
 A helper type used in several methods to get proper method overload resolutions. More...
 
struct  MakeInterfaceMap
 Helper class for constructing InterfaceMap instances based on service implementations or service factories. More...
 
struct  ServiceListenerHook
 Service Listener Hook Service. More...
 
class  ServiceObjectsBase
 Base class for ServiceObjects providing type-erased service object management. More...
 
class  ServiceObjects< void >
 Allows multiple service objects for a service to be obtained. More...
 
class  ServiceReferenceBase
 
class  ServiceRegistration
 
class  ServiceRegistrationBase
 
class  TrackedService
 
class  ServiceTrackerPrivate
 
struct  TrackedTypeTraitsBase
 
struct  TrackedTypeTraits< S, T * >
 
class  ServiceTracker
 
struct  ServiceTrackerCustomizer
 
class  SharedData
 Base class for implicitly shared data with reference counting. More...
 
class  SharedDataPointer
 A pointer to implicitly shared data with automatic copy-on-write semantics. More...
 
class  ExplicitlySharedDataPointer
 A pointer to explicitly shared data requiring manual detach for copy-on-write. More...
 
class  SharedLibrary
 The SharedLibrary class loads shared libraries at runtime. More...
 
class  ShrinkableMap
 A std::map style associative container allowing query and removal operations only. More...
 
class  ShrinkableVector
 A std::vector style container allowing query and removal operations only. More...
 

Typedefs

typedef ServiceReference< void > ServiceReferenceU
 
typedef US_SERVICE_LISTENER_FUNCTOR ServiceListener
 
typedef US_MODULE_LISTENER_FUNCTOR ModuleListener
 
typedef std::map< std::string, void * > InterfaceMap
 A map containing interfaces ids and their corresponding service object pointers. More...
 
typedef std::unordered_map< std::string, Any > ServiceProperties
 
typedef ServiceRegistration< void > ServiceRegistrationU
 

Functions

MITKCPPMICROSERVICES_EXPORT std::string any_value_to_string (const Any &any)
 
MITKCPPMICROSERVICES_EXPORT std::string any_value_to_json (const Any &val)
 
MITKCPPMICROSERVICES_EXPORT std::string any_value_to_json (const std::string &val)
 
MITKCPPMICROSERVICES_EXPORT std::string any_value_to_json (bool val)
 
template<class T >
std::string any_value_to_string (const T &val)
 
template<class T >
std::string any_value_to_json (const T &val)
 
template<typename Iterator >
std::string container_to_string (Iterator i1, Iterator i2)
 
template<typename Iterator >
std::string container_to_json (Iterator i1, Iterator i2)
 
template<class E >
std::string any_value_to_string (const std::vector< E > &vec)
 
template<class E >
std::string any_value_to_json (const std::vector< E > &vec)
 
template<class E >
std::string any_value_to_string (const std::list< E > &l)
 
template<class E >
std::string any_value_to_json (const std::list< E > &l)
 
template<class E >
std::string any_value_to_string (const std::set< E > &s)
 
template<class E >
std::string any_value_to_json (const std::set< E > &s)
 
template<class M >
std::string any_value_to_string (const std::map< M, Any > &m)
 
template<class K , class V >
std::string any_value_to_string (const std::map< K, V > &m)
 
template<class M >
std::string any_value_to_json (const std::map< M, Any > &m)
 
template<class K , class V >
std::string any_value_to_json (const std::map< K, V > &m)
 
template<typename ValueType >
ValueType * any_cast (Any *operand)
 any_cast operator used to extract the ValueType from an Any*. Will return a pointer to the stored value. More...
 
template<typename ValueType >
const ValueType * any_cast (const Any *operand)
 any_cast operator used to extract a const ValueType pointer from an const Any*. Will return a const pointer to the stored value. More...
 
template<typename ValueType >
ValueType any_cast (const Any &operand)
 any_cast operator used to extract a copy of the ValueType from an const Any&. More...
 
template<typename ValueType >
ValueType any_cast (Any &operand)
 any_cast operator used to extract a copy of the ValueType from an Any&. More...
 
template<typename ValueType >
const ValueType & ref_any_cast (const Any &operand)
 ref_any_cast operator used to return a const reference to the internal data. More...
 
template<typename ValueType >
ValueType & ref_any_cast (Any &operand)
 ref_any_cast operator used to return a reference to the internal data. More...
 
template<typename ValueType >
ValueType * unsafe_any_cast (Any *operand)
 
template<typename ValueType >
const ValueType * unsafe_any_cast (const Any *operand)
 
template<class K >
std::string any_value_to_string (const std::map< K, Any > &m)
 
template<class K >
std::string any_value_to_json (const std::map< K, Any > &m)
 
static ModuleContext * GetModuleContext ()
 Returns the module context of the calling module. More...
 
std::string GetDemangledName (const std::type_info &typeInfo)
 Returns the demangled name for the given type_info. More...
 
template<class I >
bool InsertInterfaceType (InterfaceMap &im, I *i)
 
template<>
bool InsertInterfaceType< void > (InterfaceMap &, void *)
 
template<class I1 >
I1 * ExtractInterface (const InterfaceMap &map)
 Extract a service interface pointer from a given InterfaceMap instance. More...
 
template<class T >
void swap (us::SharedDataPointer< T > &p1, us::SharedDataPointer< T > &p2)
 
template<class T >
void swap (us::ExplicitlySharedDataPointer< T > &p1, us::ExplicitlySharedDataPointer< T > &p2)
 
MITKCPPMICROSERVICES_EXPORT std::ostream & operator<< (std::ostream &os, ModuleEvent::Type eventType)
 Stream output operator for ModuleEvent::Type. More...
 
MITKCPPMICROSERVICES_EXPORT std::ostream & operator<< (std::ostream &os, const ModuleEvent &event)
 Stream output operator for ModuleEvent. More...
 
MITKCPPMICROSERVICES_EXPORT std::ostream & operator<< (std::ostream &os, const ServiceEvent::Type &type)
 Stream output operator for ServiceEvent::Type. More...
 
MITKCPPMICROSERVICES_EXPORT std::ostream & operator<< (std::ostream &os, const ServiceEvent &event)
 Stream output operator for ServiceEvent. More...
 

Typedef Documentation

◆ ModuleListener

typedef US_MODULE_LISTENER_FUNCTOR us::ModuleListener

Definition at line 28 of file usModuleContext.h.

◆ ServiceListener

typedef US_SERVICE_LISTENER_FUNCTOR us::ServiceListener

Definition at line 27 of file usModuleContext.h.

Function Documentation

◆ any_cast() [1/4]

template<typename ValueType >
ValueType us::any_cast ( Any &  operand)

any_cast operator used to extract a copy of the ValueType from an Any&.

Example Usage:

MyType tmp = any_cast<MyType>(anAny)

Will throw a BadCastException if the cast fails. Dont use an any_cast in combination with references, i.e. MyType& tmp = ... or const MyType& tmp = ... Some compilers will accept this code although a copy is returned. Use the ref_any_cast in these cases.

Definition at line 423 of file usAny.h.

◆ any_cast() [2/4]

template<typename ValueType >
ValueType* us::any_cast ( Any *  operand)

any_cast operator used to extract the ValueType from an Any*. Will return a pointer to the stored value.

Example Usage:

MyType* pTmp = any_cast<MyType*>(pAny)

Will return nullptr if the cast fails, i.e. types don't match.

Definition at line 367 of file usAny.h.

◆ any_cast() [3/4]

template<typename ValueType >
ValueType us::any_cast ( const Any &  operand)

any_cast operator used to extract a copy of the ValueType from an const Any&.

Example Usage:

MyType tmp = any_cast<MyType>(anAny)

Will throw a BadCastException if the cast fails. Dont use an any_cast in combination with references, i.e. MyType& tmp = ... or const MyType& = ... Some compilers will accept this code although a copy is returned. Use the ref_any_cast in these cases.

Definition at line 403 of file usAny.h.

◆ any_cast() [4/4]

template<typename ValueType >
const ValueType* us::any_cast ( const Any *  operand)

any_cast operator used to extract a const ValueType pointer from an const Any*. Will return a const pointer to the stored value.

Example Usage:

const MyType* pTmp = any_cast<MyType*>(pAny)

Will return nullptr if the cast fails, i.e. types don't match.

Definition at line 385 of file usAny.h.

◆ any_value_to_json() [1/10]

MITKCPPMICROSERVICES_EXPORT std::string us::any_value_to_json ( bool  val)

◆ any_value_to_json() [2/10]

MITKCPPMICROSERVICES_EXPORT std::string us::any_value_to_json ( const Any &  val)

Referenced by container_to_json().

◆ any_value_to_json() [3/10]

template<class E >
std::string us::any_value_to_json ( const std::list< E > &  l)

Definition at line 106 of file usAny.h.

References container_to_json().

◆ any_value_to_json() [4/10]

template<class K >
std::string us::any_value_to_json ( const std::map< K, Any > &  m)

Definition at line 530 of file usAny.h.

◆ any_value_to_json() [5/10]

template<class K , class V >
std::string us::any_value_to_json ( const std::map< K, V > &  m)

Definition at line 548 of file usAny.h.

◆ any_value_to_json() [6/10]

template<class M >
std::string us::any_value_to_json ( const std::map< M, Any > &  m)

◆ any_value_to_json() [7/10]

template<class E >
std::string us::any_value_to_json ( const std::set< E > &  s)

Definition at line 118 of file usAny.h.

References container_to_json().

◆ any_value_to_json() [8/10]

MITKCPPMICROSERVICES_EXPORT std::string us::any_value_to_json ( const std::string &  val)

◆ any_value_to_json() [9/10]

template<class E >
std::string us::any_value_to_json ( const std::vector< E > &  vec)

Definition at line 94 of file usAny.h.

References container_to_json().

◆ any_value_to_json() [10/10]

template<class T >
std::string us::any_value_to_json ( const T &  val)

Definition at line 46 of file usAny.h.

References any_value_to_string().

◆ any_value_to_string() [1/8]

MITKCPPMICROSERVICES_EXPORT std::string us::any_value_to_string ( const Any &  any)

◆ any_value_to_string() [2/8]

template<class E >
std::string us::any_value_to_string ( const std::list< E > &  l)

Definition at line 100 of file usAny.h.

References container_to_string().

◆ any_value_to_string() [3/8]

template<class K >
std::string us::any_value_to_string ( const std::map< K, Any > &  m)

Definition at line 494 of file usAny.h.

◆ any_value_to_string() [4/8]

template<class K , class V >
std::string us::any_value_to_string ( const std::map< K, V > &  m)

Definition at line 512 of file usAny.h.

◆ any_value_to_string() [5/8]

template<class M >
std::string us::any_value_to_string ( const std::map< M, Any > &  m)

◆ any_value_to_string() [6/8]

template<class E >
std::string us::any_value_to_string ( const std::set< E > &  s)

Definition at line 112 of file usAny.h.

References container_to_string().

◆ any_value_to_string() [7/8]

template<class E >
std::string us::any_value_to_string ( const std::vector< E > &  vec)

Definition at line 88 of file usAny.h.

References container_to_string().

◆ any_value_to_string() [8/8]

template<class T >
std::string us::any_value_to_string ( const T &  val)

Definition at line 38 of file usAny.h.

◆ container_to_json()

template<typename Iterator >
std::string us::container_to_json ( Iterator  i1,
Iterator  i2 
)

Definition at line 73 of file usAny.h.

References any_value_to_json().

Referenced by any_value_to_json().

◆ container_to_string()

template<typename Iterator >
std::string us::container_to_string ( Iterator  i1,
Iterator  i2 
)

Definition at line 55 of file usAny.h.

References any_value_to_string().

Referenced by any_value_to_string().

◆ InsertInterfaceType()

template<class I >
bool us::InsertInterfaceType ( InterfaceMap &  im,
I *  i 
)

◆ InsertInterfaceType< void >()

template<>
bool us::InsertInterfaceType< void > ( InterfaceMap &  ,
void *   
)
inline

Definition at line 156 of file usServiceInterface.h.

◆ ref_any_cast() [1/2]

template<typename ValueType >
ValueType& us::ref_any_cast ( Any &  operand)

ref_any_cast operator used to return a reference to the internal data.

Example Usage:

MyType& tmp = ref_any_cast<MyType>(anAny);

Definition at line 455 of file usAny.h.

◆ ref_any_cast() [2/2]

template<typename ValueType >
const ValueType& us::ref_any_cast ( const Any &  operand)

ref_any_cast operator used to return a const reference to the internal data.

Example Usage:

const MyType& tmp = ref_any_cast<MyType>(anAny);

Definition at line 439 of file usAny.h.

◆ swap() [1/2]

◆ swap() [2/2]

template<class T >
void us::swap ( us::SharedDataPointer< T > &  p1,
us::SharedDataPointer< T > &  p2 
)

◆ unsafe_any_cast() [1/2]

template<typename ValueType >
ValueType* us::unsafe_any_cast ( Any *  operand)

Definition at line 472 of file usAny.h.

◆ unsafe_any_cast() [2/2]

template<typename ValueType >
const ValueType* us::unsafe_any_cast ( const Any *  operand)

Definition at line 487 of file usAny.h.