As discussed, renamed Cookie to CookieIF.
Also added documentation on the purpose of this class
This commit is contained in:
parent
05c1330b68
commit
81ab5a6914
devicehandlers
@ -1,10 +0,0 @@
|
||||
#ifndef COOKIE_H_
|
||||
#define COOKIE_H_
|
||||
|
||||
class Cookie{
|
||||
public:
|
||||
virtual ~Cookie(){}
|
||||
};
|
||||
|
||||
|
||||
#endif /* COOKIE_H_ */
|
34
devicehandlers/CookieIF.h
Normal file
34
devicehandlers/CookieIF.h
Normal file
@ -0,0 +1,34 @@
|
||||
#ifndef COOKIE_H_
|
||||
#define COOKIE_H_
|
||||
#include <framework/devicehandlers/CookieIF.h>
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* @brief Physical address type
|
||||
*/
|
||||
typedef uint32_t address_t;
|
||||
|
||||
/**
|
||||
* @brief This datatype is used to identify different connection over a
|
||||
* single interface (like RMAP or I2C)
|
||||
* @details
|
||||
* To use this class, implement a communication specific child cookie which
|
||||
* inherits Cookie. Cookie instances are created in config/Factory.cpp by
|
||||
* calling @code{.cpp} CookieIF* childCookie = new ChildCookie(...)
|
||||
* @endcode .
|
||||
*
|
||||
* This cookie is then passed to the child device handlers, which stores the
|
||||
* pointer and passes it to the communication interface functions.
|
||||
*
|
||||
* The cookie can be used to store all kinds of information
|
||||
* about the communication, like slave addresses, communication status,
|
||||
* communication parameters etc.
|
||||
*
|
||||
* @ingroup comm
|
||||
*/
|
||||
class CookieIF {
|
||||
public:
|
||||
virtual ~CookieIF() {};
|
||||
};
|
||||
|
||||
#endif /* COOKIE_H_ */
|
Loading…
Reference in New Issue
Block a user