some doc change proposals while

writing hk service.
Added Type.h in PoolRawAccess.h, compiler error
when not doing that
This commit is contained in:
2019-12-03 19:30:37 +01:00
parent 37a70df244
commit 9c3a9323b7
5 changed files with 38 additions and 42 deletions

View File

@ -3,6 +3,7 @@
#include <framework/datapool/DataSetIF.h>
#include <framework/datapool/PoolVariableIF.h>
#include <framework/globalfunctions/Type.h>
/**
* This class allows accessing Data Pool variables as raw bytes.
@ -79,9 +80,8 @@ public:
~PoolRawAccess();
/**
* \brief This operation returns a pointer to the entry fetched.
* \details This means, it does not return a pointer to byte "index", but to the start byte of
* array entry "index". Example: If the original data pool array consists of an double
* array of size four, getEntry(1) returns &(this->value[8]).
* \details Return pointer to the buffer containing the raw data
* Size and number of data can be retrieved by other means.
*/
uint8_t* getEntry();
/**

View File

@ -112,8 +112,7 @@ public:
* corresponds to.
* \param dataSet The data set in which the variable shall register itself. If NULL,
* the variable is not registered.
* \param setWritable If this flag is set to true, changes in the value attribute can be
* written back to the data pool, otherwise not.
* \param setReadWriteMode
*/
PoolVariable(uint32_t set_id, DataSetIF* dataSet,
ReadWriteMode_t setReadWriteMode) :