Something specific; a base class for identifying things.
More...
#include <Something.hpp>
|
| boost::uuids::uuid | someId |
| | A unique identifier that is valid across all peers. More...
|
| |
Something specific; a base class for identifying things.
- Note
- All instances of Something must have their memory handled by a std::shared_prt<Something> object.
- Author
- Jeff Jackowski
Definition at line 26 of file Something.hpp.
◆ Something() [1/2]
| duds::Something::Something |
( |
| ) |
|
|
protecteddefault |
Simple constructor.
- Postcondition
- The object's UUID, someId, is uninitialized.
◆ Something() [2/2]
| duds::Something::Something |
( |
const boost::uuids::uuid & |
id | ) |
|
|
inlineprotected |
Creates Something with the given UUID.
- Parameters
-
| id | The initial UUID to identify this object. |
Definition at line 47 of file Something.hpp.
◆ ~Something()
| duds::Something::~Something |
( |
| ) |
|
|
pure virtual |
◆ getName()
| std::string duds::Something::getName |
( |
| ) |
const |
Returns the name for the current locale.
- Todo:
- Implement properly.
Referenced by names().
◆ names()
Returns the set of names for all locales and languages.
Definition at line 78 of file Something.hpp.
◆ operator!=()
| bool duds::Something::operator!= |
( |
const Something & |
s | ) |
const |
|
inline |
◆ operator<()
| bool duds::Something::operator< |
( |
const Something & |
s | ) |
const |
|
inline |
◆ operator<=()
| bool duds::Something::operator<= |
( |
const Something & |
s | ) |
const |
|
inline |
◆ operator==()
| bool duds::Something::operator== |
( |
const Something & |
s | ) |
const |
|
inline |
◆ operator>()
| bool duds::Something::operator> |
( |
const Something & |
s | ) |
const |
|
inline |
◆ operator>=()
| bool duds::Something::operator>= |
( |
const Something & |
s | ) |
const |
|
inline |
◆ setUuid()
| void duds::Something::setUuid |
( |
const boost::uuids::uuid & |
id | ) |
|
|
inlineprotected |
Sets the UUID that is associated with this object.
- Precondition
- The object is still being prepared for use. The UUID must not be changed once the object is in use.
- Parameters
-
Definition at line 54 of file Something.hpp.
◆ sharedPtr()
template<class DerivedClass >
| std::shared_ptr<DerivedClass> duds::Something::sharedPtr |
( |
| ) |
const |
|
inline |
Returns a shared pointer to this object for a derived class.
- Template Parameters
-
| DerivedClass | The class derived from this class. |
- Returns
- A shared pointer containing this object with the type of the derived class.
Definition at line 66 of file Something.hpp.
◆ uuid()
| const boost::uuids::uuid& duds::Something::uuid |
( |
| ) |
const |
|
inline |
Returns the object's unique identifier.
Definition at line 72 of file Something.hpp.
◆ ltnames
A name for this item intended for user presentation.
Definition at line 37 of file Something.hpp.
Referenced by names().
◆ someId
| boost::uuids::uuid duds::Something::someId |
|
private |
The documentation for this class was generated from the following files: