ON Semiconductor / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

features/unsupported/rpc/RPCVariable.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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