KSat/fsfw
15
4
Fork 0
forked from fsfw/fsfw
Code Issues Pull Requests 1 Releases Wiki Activity

has parametersIF doc improved

Browse Source
This commit is contained in:
Robin Müller 2020-11-10 11:00:13 +01:00
parent 71382032a1
commit 0304f61bde
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
parameters/HasParametersIF.h
View File

@ -1,8 +1,8 @@
#ifndef FSFW_PARAMETERS_HASPARAMETERSIF_H_ #ifndef FSFW_PARAMETERS_HASPARAMETERSIF_H_
#define FSFW_PARAMETERS_HASPARAMETERSIF_H_ #define FSFW_PARAMETERS_HASPARAMETERSIF_H_
#include "../returnvalues/HasReturnvaluesIF.h"
#include "ParameterWrapper.h" #include "ParameterWrapper.h"
#include "../returnvalues/HasReturnvaluesIF.h"
#include <cstdint> #include <cstdint>
/** /**
@ -20,11 +20,10 @@ using ParameterId_t = uint32_t;
* ID is the domain ID which can be used to identify unqiue spacecraft domains * ID is the domain ID which can be used to identify unqiue spacecraft domains
* (e.g. control and sensor domain in the AOCS controller). * (e.g. control and sensor domain in the AOCS controller).
* *
* The second and third byte represent the matrix ID, which can represent * The second byte is a unique identfier ID.
* a 8-bit row and column number and the last byte...
* *
* Yeah, is it matrix ID or parameter ID now and is index a 16 bit number * The third and fourth byte can be used as a linear index for matrix or array
* of a 8 bit number now? * parameter entries.
*/ */
class HasParametersIF { class HasParametersIF {
public: public:
@ -61,6 +60,10 @@ public:
virtual ~HasParametersIF() {} virtual ~HasParametersIF() {}
/** /**
* This is the generic function overriden by child classes to set
* parameters. To set a parameter, the parameter wrapper is used with
* a variety of set functions. The provided values can be checked with
* newValues.
* Always set parameter before checking newValues! * Always set parameter before checking newValues!
* *
* @param domainId * @param domainId