some more docs
This commit is contained in:
parent
18cc870c8e
commit
35be7da353
@ -41,14 +41,6 @@ class FreshDeviceHandlerBase : public SystemObject,
|
||||
*/
|
||||
virtual void performDeviceOperation(uint8_t opCode) = 0;
|
||||
|
||||
/**
|
||||
* Implemented by child class. Handle all command messages which are
|
||||
* not health, mode, action or housekeeping messages.
|
||||
* @param message
|
||||
* @return
|
||||
*/
|
||||
virtual ReturnValue_t handleCommandMessage(CommandMessage* message) = 0;
|
||||
|
||||
[[nodiscard]] object_id_t getObjectId() const override;
|
||||
|
||||
[[nodiscard]] MessageQueueId_t getCommandQueue() const override;
|
||||
@ -90,6 +82,12 @@ class FreshDeviceHandlerBase : public SystemObject,
|
||||
|
||||
// Mode Helpers.
|
||||
virtual void modeChanged(Mode_t mode, Submode_t submode);
|
||||
/**
|
||||
* The default implementation sets the new mode immediately. If this is not applicable for
|
||||
* certain modes, the user should provide a custom implementation, which performs rougly
|
||||
* the same functionality of this function, when all the steps have been taken to reach the
|
||||
* new mode.
|
||||
*/
|
||||
void startTransition(Mode_t mode, Submode_t submode) override;
|
||||
void getMode(Mode_t* mode, Submode_t* submode) override;
|
||||
void setToExternalControl() override;
|
||||
@ -97,6 +95,14 @@ class FreshDeviceHandlerBase : public SystemObject,
|
||||
// System Object overrides.
|
||||
ReturnValue_t initialize() override;
|
||||
|
||||
/**
|
||||
* Implemented by child class. Handle all command messages which are
|
||||
* not health, mode, action or housekeeping messages.
|
||||
* @param message
|
||||
* @return
|
||||
*/
|
||||
virtual ReturnValue_t handleCommandMessage(CommandMessage* message) = 0;
|
||||
|
||||
// HK manager abstract functions.
|
||||
LocalPoolDataSetBase* getDataSetHandle(sid_t sid) override = 0;
|
||||
ReturnValue_t initializeLocalDataPool(localpool::DataPool& localDataPoolMap,
|
||||
|
Loading…
Reference in New Issue
Block a user