Inheritance diagram for stmg::AllPreferencesLoader:
Public Member Functions | |
| virtual | ~AllPreferencesLoader () noexcept=default |
| virtual shared_ptr< AllPreferences > | getPreferences () const noexcept=0 |
| Load or create a new (or recycled) AllPreferences instance. More... | |
| virtual shared_ptr< AllPreferences > | getPreferencesCopy (const shared_ptr< AllPreferences > &refAllPreferences) const noexcept=0 |
| Create a copy of an AllPreferences instance. More... | |
| virtual bool | updatePreferences (const shared_ptr< AllPreferences > &refAllPreferences) noexcept=0 |
| Persist an AllPreferences instance. More... | |
Constructor & Destructor Documentation
◆ ~AllPreferencesLoader()
|
virtualdefaultnoexcept |
Member Function Documentation
◆ getPreferences()
|
pure virtualnoexcept |
Load or create a new (or recycled) AllPreferences instance.
If there is a persisted instance it is loaded, otherwise it is created with default values.
- Returns
- The instance. Is not null.
Implemented in stmg::XmlPreferencesLoader.
◆ getPreferencesCopy()
|
pure virtualnoexcept |
Create a copy of an AllPreferences instance.
This function should be preferred over just using the copy constructor of the instance because it allows the loader to possibly recycle another instance.
- Parameters
-
refAllPreferences The instance to copy from. Cannot be null.
- Returns
- The copy. Is not null.
Implemented in stmg::XmlPreferencesLoader.
◆ updatePreferences()
|
pure virtualnoexcept |
Persist an AllPreferences instance.
- Parameters
-
refAllPreferences The instance to persist. Cannot be null.
- Returns
- Whether the instance could be persisted.
Implemented in stmg::XmlPreferencesLoader.
