Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

libraries/rpc/RPCVariable.h@1:d96dbedaebdb, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:54:50 2016 +0000
Revision:
1:d96dbedaebdb
Parent:
0:6c56fb4bc5f0 
Removed extra directories for other platforms

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nexpaq 0:6c56fb4bc5f0 1 /* mbed Microcontroller Library
nexpaq 0:6c56fb4bc5f0 2 * Copyright (c) 2006-2013 ARM Limited
nexpaq 0:6c56fb4bc5f0 3 *
nexpaq 0:6c56fb4bc5f0 4 * Licensed under the Apache License, Version 2.0 (the "License");
nexpaq 0:6c56fb4bc5f0 5 * you may not use this file except in compliance with the License.
nexpaq 0:6c56fb4bc5f0 6 * You may obtain a copy of the License at
nexpaq 0:6c56fb4bc5f0 7 *
nexpaq 0:6c56fb4bc5f0 8 * http://www.apache.org/licenses/LICENSE-2.0
nexpaq 0:6c56fb4bc5f0 9 *
nexpaq 0:6c56fb4bc5f0 10 * Unless required by applicable law or agreed to in writing, software
nexpaq 0:6c56fb4bc5f0 11 * distributed under the License is distributed on an "AS IS" BASIS,
nexpaq 0:6c56fb4bc5f0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
nexpaq 0:6c56fb4bc5f0 13 * See the License for the specific language governing permissions and
nexpaq 0:6c56fb4bc5f0 14 * limitations under the License.
nexpaq 0:6c56fb4bc5f0 15 */
nexpaq 0:6c56fb4bc5f0 16 #ifndef RPCVARIABLE_H_
nexpaq 0:6c56fb4bc5f0 17 #define RPCVARIABLE_H_
nexpaq 0:6c56fb4bc5f0 18
nexpaq 0:6c56fb4bc5f0 19 #include "rpc.h"
nexpaq 0:6c56fb4bc5f0 20
nexpaq 0:6c56fb4bc5f0 21 namespace mbed {
nexpaq 0:6c56fb4bc5f0 22
nexpaq 0:6c56fb4bc5f0 23 /**
nexpaq 0:6c56fb4bc5f0 24 *Class to read and set an attached variable using the RPC
nexpaq 0:6c56fb4bc5f0 25 *
nexpaq 0:6c56fb4bc5f0 26 */
nexpaq 0:6c56fb4bc5f0 27 template<class T>
nexpaq 0:6c56fb4bc5f0 28 class RPCVariable: public RPC {
nexpaq 0:6c56fb4bc5f0 29 public:
nexpaq 0:6c56fb4bc5f0 30 /**
nexpaq 0:6c56fb4bc5f0 31 * Constructor
nexpaq 0:6c56fb4bc5f0 32 *
nexpaq 0:6c56fb4bc5f0 33 *@param ptr Pointer to the variable to make accessible over RPC. Any type of
nexpaq 0:6c56fb4bc5f0 34 *variable can be connected
nexpaq 0:6c56fb4bc5f0 35 *@param name The name of that this object will be over RPC
nexpaq 0:6c56fb4bc5f0 36 */
nexpaq 0:6c56fb4bc5f0 37 template<class A>
nexpaq 0:6c56fb4bc5f0 38 RPCVariable(A * ptr, const char * name) : RPC(name) {
nexpaq 0:6c56fb4bc5f0 39 _ptr = ptr;
nexpaq 0:6c56fb4bc5f0 40 }
nexpaq 0:6c56fb4bc5f0 41 /**
nexpaq 0:6c56fb4bc5f0 42 *Read the variable over RPC.
nexpaq 0:6c56fb4bc5f0 43 *
nexpaq 0:6c56fb4bc5f0 44 *@return The value of the variable
nexpaq 0:6c56fb4bc5f0 45 */
nexpaq 0:6c56fb4bc5f0 46 T read() {
nexpaq 0:6c56fb4bc5f0 47 return (*_ptr);
nexpaq 0:6c56fb4bc5f0 48 }
nexpaq 0:6c56fb4bc5f0 49 /**
nexpaq 0:6c56fb4bc5f0 50 *Write a value to the variable over RPC
nexpaq 0:6c56fb4bc5f0 51 *
nexpaq 0:6c56fb4bc5f0 52 *@param The value to be written to the attached variable.
nexpaq 0:6c56fb4bc5f0 53 */
nexpaq 0:6c56fb4bc5f0 54 void write(T value) {
nexpaq 0:6c56fb4bc5f0 55 *_ptr = value;
nexpaq 0:6c56fb4bc5f0 56 }
nexpaq 0:6c56fb4bc5f0 57
nexpaq 0:6c56fb4bc5f0 58 virtual const struct rpc_method *get_rpc_methods();
nexpaq 0:6c56fb4bc5f0 59 static struct rpc_class *get_rpc_class();
nexpaq 0:6c56fb4bc5f0 60
nexpaq 0:6c56fb4bc5f0 61 private:
nexpaq 0:6c56fb4bc5f0 62 T * _ptr;
nexpaq 0:6c56fb4bc5f0 63 };
nexpaq 0:6c56fb4bc5f0 64
nexpaq 0:6c56fb4bc5f0 65 template<class T>
nexpaq 0:6c56fb4bc5f0 66 const rpc_method *RPCVariable<T>::get_rpc_methods() {
nexpaq 0:6c56fb4bc5f0 67 static const rpc_method rpc_methods[] = {
nexpaq 0:6c56fb4bc5f0 68 {"read" , rpc_method_caller<T, RPCVariable, &RPCVariable::read> },
nexpaq 0:6c56fb4bc5f0 69 {"write", rpc_method_caller<RPCVariable, T, &RPCVariable::write> },
nexpaq 0:6c56fb4bc5f0 70 RPC_METHOD_SUPER(RPC)
nexpaq 0:6c56fb4bc5f0 71 };
nexpaq 0:6c56fb4bc5f0 72 return rpc_methods;
nexpaq 0:6c56fb4bc5f0 73 }
nexpaq 0:6c56fb4bc5f0 74
nexpaq 0:6c56fb4bc5f0 75 template<class T>
nexpaq 0:6c56fb4bc5f0 76 rpc_class *RPCVariable<T>::get_rpc_class() {
nexpaq 0:6c56fb4bc5f0 77 static const rpc_function funcs[] = {
nexpaq 0:6c56fb4bc5f0 78 "new", rpc_function_caller<const char*, T, const char*, &RPC::construct<RPCVariable, T, const char*> > ,
nexpaq 0:6c56fb4bc5f0 79 RPC_METHOD_END
nexpaq 0:6c56fb4bc5f0 80 };
nexpaq 0:6c56fb4bc5f0 81 static rpc_class c = {"RPCVariable", funcs, NULL};
nexpaq 0:6c56fb4bc5f0 82 return &c;
nexpaq 0:6c56fb4bc5f0 83 }
nexpaq 0:6c56fb4bc5f0 84
nexpaq 0:6c56fb4bc5f0 85 }
nexpaq 0:6c56fb4bc5f0 86
nexpaq 0:6c56fb4bc5f0 87 #endif //RPCVARIABLE_H_