Nino Der Kinderen / Mbed 2 deprecated nRF24L01P_ProjectSensor

se

Dependencies:   mbed nRF24L01P

Fork of nRF24L01P_Project by Michiel Van Endert

RPCInterface/RPCVariable.h@5:87f98ed1ee9a, 2015-05-19 (annotated)

Committer:
ninoderkinderen
Date:
Tue May 19 17:25:21 2015 +0000
Revision:
5:87f98ed1ee9a
sens

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ninoderkinderen 5:87f98ed1ee9a 1 /**
ninoderkinderen 5:87f98ed1ee9a 2 * @section LICENSE
ninoderkinderen 5:87f98ed1ee9a 3 *Copyright (c) 2010 ARM Ltd.
ninoderkinderen 5:87f98ed1ee9a 4 *
ninoderkinderen 5:87f98ed1ee9a 5 *Permission is hereby granted, free of charge, to any person obtaining a copy
ninoderkinderen 5:87f98ed1ee9a 6 *of this software and associated documentation files (the "Software"), to deal
ninoderkinderen 5:87f98ed1ee9a 7 *in the Software without restriction, including without limitation the rights
ninoderkinderen 5:87f98ed1ee9a 8 *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
ninoderkinderen 5:87f98ed1ee9a 9 *copies of the Software, and to permit persons to whom the Software is
ninoderkinderen 5:87f98ed1ee9a 10 *furnished to do so, subject to the following conditions:
ninoderkinderen 5:87f98ed1ee9a 11 *
ninoderkinderen 5:87f98ed1ee9a 12 *The above copyright notice and this permission notice shall be included in
ninoderkinderen 5:87f98ed1ee9a 13 *all copies or substantial portions of the Software.
ninoderkinderen 5:87f98ed1ee9a 14 *
ninoderkinderen 5:87f98ed1ee9a 15 *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
ninoderkinderen 5:87f98ed1ee9a 16 *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
ninoderkinderen 5:87f98ed1ee9a 17 *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
ninoderkinderen 5:87f98ed1ee9a 18 *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
ninoderkinderen 5:87f98ed1ee9a 19 *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ninoderkinderen 5:87f98ed1ee9a 20 *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
ninoderkinderen 5:87f98ed1ee9a 21 *THE SOFTWARE.
ninoderkinderen 5:87f98ed1ee9a 22 *
ninoderkinderen 5:87f98ed1ee9a 23 * @section Description
ninoderkinderen 5:87f98ed1ee9a 24 *This class provides an object to which a variable can be attached. Any type
ninoderkinderen 5:87f98ed1ee9a 25 *for which a parse_args function specilisation exists can be attached. This includes
ninoderkinderen 5:87f98ed1ee9a 26 *all of the standard types.
ninoderkinderen 5:87f98ed1ee9a 27 *
ninoderkinderen 5:87f98ed1ee9a 28 */
ninoderkinderen 5:87f98ed1ee9a 29 #ifndef RPCVARIABLE_H_
ninoderkinderen 5:87f98ed1ee9a 30 #define RPCVARIABLE_H_
ninoderkinderen 5:87f98ed1ee9a 31
ninoderkinderen 5:87f98ed1ee9a 32 #include "mbed.h"
ninoderkinderen 5:87f98ed1ee9a 33 #include "platform.h"
ninoderkinderen 5:87f98ed1ee9a 34 #include "rpc.h"
ninoderkinderen 5:87f98ed1ee9a 35 /**
ninoderkinderen 5:87f98ed1ee9a 36 *Class to read and set an attached variable using the RPC
ninoderkinderen 5:87f98ed1ee9a 37 *
ninoderkinderen 5:87f98ed1ee9a 38 */
ninoderkinderen 5:87f98ed1ee9a 39 template<class T>
ninoderkinderen 5:87f98ed1ee9a 40 class RPCVariable : public Base{
ninoderkinderen 5:87f98ed1ee9a 41 public:
ninoderkinderen 5:87f98ed1ee9a 42 /**
ninoderkinderen 5:87f98ed1ee9a 43 * Constructor
ninoderkinderen 5:87f98ed1ee9a 44 *
ninoderkinderen 5:87f98ed1ee9a 45 *@param ptr Pointer to the variable to make accessible over RPC. Any type of
ninoderkinderen 5:87f98ed1ee9a 46 *variable can be connected
ninoderkinderen 5:87f98ed1ee9a 47 *@param name The name of that this object will be over RPC
ninoderkinderen 5:87f98ed1ee9a 48 */
ninoderkinderen 5:87f98ed1ee9a 49 template<class A>
ninoderkinderen 5:87f98ed1ee9a 50 RPCVariable(A * ptr, const char * name) : Base(name){
ninoderkinderen 5:87f98ed1ee9a 51 _ptr = ptr;
ninoderkinderen 5:87f98ed1ee9a 52 }
ninoderkinderen 5:87f98ed1ee9a 53 /**
ninoderkinderen 5:87f98ed1ee9a 54 *Read the variable over RPC.
ninoderkinderen 5:87f98ed1ee9a 55 *
ninoderkinderen 5:87f98ed1ee9a 56 *@return The value of the variable
ninoderkinderen 5:87f98ed1ee9a 57 */
ninoderkinderen 5:87f98ed1ee9a 58 T read(){
ninoderkinderen 5:87f98ed1ee9a 59 return(*_ptr);
ninoderkinderen 5:87f98ed1ee9a 60 }
ninoderkinderen 5:87f98ed1ee9a 61 /**
ninoderkinderen 5:87f98ed1ee9a 62 *Write a value to the variable over RPC
ninoderkinderen 5:87f98ed1ee9a 63 *
ninoderkinderen 5:87f98ed1ee9a 64 *@param The value to be written to the attached variable.
ninoderkinderen 5:87f98ed1ee9a 65 */
ninoderkinderen 5:87f98ed1ee9a 66 void write(T value){
ninoderkinderen 5:87f98ed1ee9a 67 *_ptr = value;
ninoderkinderen 5:87f98ed1ee9a 68 }
ninoderkinderen 5:87f98ed1ee9a 69
ninoderkinderen 5:87f98ed1ee9a 70 #ifdef MBED_RPC
ninoderkinderen 5:87f98ed1ee9a 71 virtual const struct rpc_method *get_rpc_methods();
ninoderkinderen 5:87f98ed1ee9a 72 static struct rpc_class *get_rpc_class();
ninoderkinderen 5:87f98ed1ee9a 73 #endif
ninoderkinderen 5:87f98ed1ee9a 74
ninoderkinderen 5:87f98ed1ee9a 75 private:
ninoderkinderen 5:87f98ed1ee9a 76 T * _ptr;
ninoderkinderen 5:87f98ed1ee9a 77
ninoderkinderen 5:87f98ed1ee9a 78 };
ninoderkinderen 5:87f98ed1ee9a 79
ninoderkinderen 5:87f98ed1ee9a 80 //Set up RPC methods
ninoderkinderen 5:87f98ed1ee9a 81 #ifdef MBED_RPC
ninoderkinderen 5:87f98ed1ee9a 82 template <class T>
ninoderkinderen 5:87f98ed1ee9a 83 const rpc_method *RPCVariable<T>::get_rpc_methods() {
ninoderkinderen 5:87f98ed1ee9a 84 static const rpc_method rpc_methods[] = {
ninoderkinderen 5:87f98ed1ee9a 85 { "read", rpc_method_caller<T, RPCVariable, &RPCVariable::read> },
ninoderkinderen 5:87f98ed1ee9a 86 { "write", rpc_method_caller<RPCVariable, T, &RPCVariable::write> },
ninoderkinderen 5:87f98ed1ee9a 87 RPC_METHOD_SUPER(Base)
ninoderkinderen 5:87f98ed1ee9a 88 };
ninoderkinderen 5:87f98ed1ee9a 89 return rpc_methods;
ninoderkinderen 5:87f98ed1ee9a 90 }
ninoderkinderen 5:87f98ed1ee9a 91 template <class T>
ninoderkinderen 5:87f98ed1ee9a 92 rpc_class *RPCVariable<T>::get_rpc_class() {
ninoderkinderen 5:87f98ed1ee9a 93 static const rpc_function funcs[] = {"new", rpc_function_caller<const char*, T,const char* , &Base::construct<RemoteVar, T ,const char*> >,RPC_METHOD_END};
ninoderkinderen 5:87f98ed1ee9a 94 static rpc_class c = { "RPCVariable", funcs, NULL };
ninoderkinderen 5:87f98ed1ee9a 95 return &c;
ninoderkinderen 5:87f98ed1ee9a 96 }
ninoderkinderen 5:87f98ed1ee9a 97 #endif
ninoderkinderen 5:87f98ed1ee9a 98
ninoderkinderen 5:87f98ed1ee9a 99 //There could be specialisation for integer, to also give increment and decrements
ninoderkinderen 5:87f98ed1ee9a 100
ninoderkinderen 5:87f98ed1ee9a 101
ninoderkinderen 5:87f98ed1ee9a 102 #endif //RPCVARIABLE_H_