Medical Imaging Interaction Toolkit
2016.11.0
Medical Imaging Interaction Toolkit
|
#include <usServiceReferenceBase.h>
Public Member Functions | |
ServiceReferenceBase (const ServiceReferenceBase &ref) | |
operator bool_type () const | |
ServiceReferenceBase & | operator= (int null) |
~ServiceReferenceBase () | |
Any | GetProperty (const std::string &key) const |
void | GetPropertyKeys (std::vector< std::string > &keys) const |
Module * | GetModule () const |
void | GetUsingModules (std::vector< Module * > &modules) const |
std::string | GetInterfaceId () const |
bool | IsConvertibleTo (const std::string &interfaceid) const |
bool | operator< (const ServiceReferenceBase &reference) const |
bool | operator== (const ServiceReferenceBase &reference) const |
ServiceReferenceBase & | operator= (const ServiceReferenceBase &reference) |
A reference to a service.
Definition at line 43 of file usServiceReferenceBase.h.
us::ServiceReferenceBase::ServiceReferenceBase | ( | const ServiceReferenceBase & | ref | ) |
Definition at line 39 of file usServiceReferenceBase.cpp.
us::ServiceReferenceBase::~ServiceReferenceBase | ( | ) |
Definition at line 77 of file usServiceReferenceBase.cpp.
std::string us::ServiceReferenceBase::GetInterfaceId | ( | ) | const |
Returns the interface identifier this ServiceReferenceBase object is bound to.
A default constructed ServiceReferenceBase object is not bound to any interface identifier and calling this method will return an empty string.
Definition at line 181 of file usServiceReferenceBase.cpp.
Module * us::ServiceReferenceBase::GetModule | ( | ) | const |
Returns the module that registered the service referenced by this ServiceReferenceBase
object.
This method must return 0
when the service has been unregistered. This can be used to determine if the service has been unregistered.
ServiceReferenceBase
object; 0
if that service has already been unregistered. Definition at line 98 of file usServiceReferenceBase.cpp.
Any us::ServiceReferenceBase::GetProperty | ( | const std::string & | key | ) | const |
Returns the property value to which the specified property key is mapped in the properties ServiceProperties
object of the service referenced by this ServiceReferenceBase
object.
Property keys are case-insensitive.
This method continues to return property values after the service has been unregistered. This is so references to unregistered services can still be interrogated.
key | The property key. |
Definition at line 83 of file usServiceReferenceBase.cpp.
Referenced by operator<().
void us::ServiceReferenceBase::GetPropertyKeys | ( | std::vector< std::string > & | keys | ) | const |
Returns a list of the keys in the ServiceProperties
object of the service referenced by this ServiceReferenceBase
object.
This method will continue to return the keys after the service has been unregistered. This is so references to unregistered services can still be interrogated.
keys | A vector being filled with the property keys. |
Definition at line 90 of file usServiceReferenceBase.cpp.
void us::ServiceReferenceBase::GetUsingModules | ( | std::vector< Module * > & | modules | ) | const |
Returns the modules that are using the service referenced by this ServiceReferenceBase
object. Specifically, this method returns the modules whose usage count for that service is greater than zero.
modules | A list of modules whose usage count for the service referenced by this ServiceReferenceBase object is greater than zero. |
Definition at line 108 of file usServiceReferenceBase.cpp.
bool us::ServiceReferenceBase::IsConvertibleTo | ( | const std::string & | interfaceid | ) | const |
Checks wether this ServiceReferenceBase object can be converted to another ServiceReferenceBase object, which will be bound to the given interface identifier.
ServiceReferenceBase objects can be converted if the underlying service implementation was registered under multiple service interfaces.
interfaceid |
true
if this ServiceReferenceBase object can be converted, false
otherwise. Definition at line 176 of file usServiceReferenceBase.cpp.
us::ServiceReferenceBase::operator bool_type | ( | ) | const |
Converts this ServiceReferenceBase instance into a boolean expression. If this instance was default constructed or the service it references has been unregistered, the conversion returns false
, otherwise it returns true
.
Definition at line 61 of file usServiceReferenceBase.cpp.
bool us::ServiceReferenceBase::operator< | ( | const ServiceReferenceBase & | reference | ) | const |
Compares this ServiceReferenceBase
with the specified ServiceReferenceBase
for order.
If this ServiceReferenceBase
and the specified ServiceReferenceBase
have the same service id they are equal. This ServiceReferenceBase
is less than the specified ServiceReferenceBase
if it has a lower service ranking and greater if it has a higher service ranking. Otherwise, if this ServiceReferenceBase
and the specified ServiceReferenceBase
have the same service ranking, this ServiceReferenceBase
is less than the specified ServiceReferenceBase
if it has a higher service id and greater if it has a lower service id.
reference | The ServiceReferenceBase to be compared. |
ServiceReferenceBase
is less than or greater than the specified ServiceReferenceBase
. Definition at line 120 of file usServiceReferenceBase.cpp.
References us::any_cast(), us::Any::Empty(), GetProperty(), us::ServiceConstants::SERVICE_ID(), us::ServiceConstants::SERVICE_RANKING(), and us::Any::Type().
ServiceReferenceBase & us::ServiceReferenceBase::operator= | ( | int | null | ) |
Releases any resources held or locked by this ServiceReferenceBase
and renders it invalid.
Definition at line 66 of file usServiceReferenceBase.cpp.
ServiceReferenceBase & us::ServiceReferenceBase::operator= | ( | const ServiceReferenceBase & | reference | ) |
Definition at line 164 of file usServiceReferenceBase.cpp.
bool us::ServiceReferenceBase::operator== | ( | const ServiceReferenceBase & | reference | ) | const |
Definition at line 159 of file usServiceReferenceBase.cpp.