Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
Public Member Functions | Public Attributes | List of all members
berry::QualifiedName Struct Reference

#include <berryQualifiedName.h>

Collaboration diagram for berry::QualifiedName:
Collaboration graph
[legend]

Public Member Functions

 QualifiedName (std::string qualifier, std::string localName)
 
bool operator== (const QualifiedName &qName) const
 
bool operator< (const QualifiedName &qName) const
 
std::string GetLocalName () const
 
std::string GetQualifier () const
 
std::vcl_size_t HashCode () const
 
std::string ToString ()
 

Public Attributes

std::string qualifier
 
std::string localName
 

Detailed Description

Qualified names are two-part names: qualifier and local name. The qualifier must be in URI form (see RFC2396). Note however that the qualifier may be null if the default name space is being used. The empty string is not a valid local name.

This class can be used without OSGi running.

This class is not intended to be subclassed by clients.

This class is not intended to be subclassed by clients.ds

Definition at line 40 of file berryQualifiedName.h.

Constructor & Destructor Documentation

berry::QualifiedName::QualifiedName ( std::string  qualifier,
std::string  localName 
)

Creates and returns a new qualified name with the given qualifier and local name. The local name must not be the empty string. The qualifier may be null.

Clients may instantiate.

Parameters
qualifierthe qualifier string, or null
localNamethe local name string

Definition at line 30 of file berryQualifiedName.cpp.

References localName, and qualifier.

Member Function Documentation

std::string berry::QualifiedName::GetLocalName ( ) const

Returns the local part of this name.

Returns
the local name string

Definition at line 55 of file berryQualifiedName.cpp.

Referenced by operator<(), and operator==().

std::string berry::QualifiedName::GetQualifier ( ) const

Returns the qualifier part for this qualified name, or null if none.

Returns
the qualifier string, or null

Definition at line 62 of file berryQualifiedName.cpp.

Referenced by operator<(), and operator==().

std::vcl_size_t berry::QualifiedName::HashCode ( ) const

Definition at line 69 of file berryQualifiedName.cpp.

bool berry::QualifiedName::operator< ( const QualifiedName &  qName) const

Definition at line 48 of file berryQualifiedName.cpp.

References GetLocalName(), and GetQualifier().

bool berry::QualifiedName::operator== ( const QualifiedName &  qName) const

Returns whether this qualified name is equivalent to the given object.

Qualified names are equal if and only if they have the same qualified parts and local parts. Qualified names are not equal to objects other than qualified names.

Parameters
objthe object to compare to
Returns
true if these are equivalent qualified names, and false otherwise

Definition at line 39 of file berryQualifiedName.cpp.

References GetLocalName(), and GetQualifier().

std::string berry::QualifiedName::ToString ( )

Converts this qualified name into a string, suitable for debug purposes only.

Definition at line 76 of file berryQualifiedName.cpp.

Member Data Documentation

std::string berry::QualifiedName::localName

Local name part.

Definition at line 50 of file berryQualifiedName.h.

Referenced by QualifiedName().

std::string berry::QualifiedName::qualifier

Qualifier part (potentially null).

Definition at line 46 of file berryQualifiedName.h.

Referenced by QualifiedName().

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