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.
Fork of mbed by
BusOut Class Reference
A digital output bus, used for setting the state of a collection of pins. More...
#include <BusOut.h>
Inherits mbed::Base.
Public Member Functions | |
BusOut (PinName p0, PinName p1=NC, PinName p2=NC, PinName p3=NC, PinName p4=NC, PinName p5=NC, PinName p6=NC, PinName p7=NC, PinName p8=NC, PinName p9=NC, PinName p10=NC, PinName p11=NC, PinName p12=NC, PinName p13=NC, PinName p14=NC, PinName p15=NC, const char *name=NULL) | |
Create an BusOut, connected to the specified pins. | |
void | write (int value) |
Write the value to the output bus. | |
int | read () |
Read the value currently output on the bus. | |
BusOut & | operator= (int v) |
A shorthand for write() | |
operator int () | |
A shorthand for read() | |
virtual struct rpc_method * | get_rpc_methods () |
Returns a pointer to an array describing the rpc methods supported by this object, terminated by either RPC_METHOD_END or RPC_METHOD_SUPER(Superclass). | |
void | register_object (const char *name) |
Registers this object with the given name, so that it can be looked up with lookup. | |
const char * | name () |
Returns the name of the object. | |
virtual bool | rpc (const char *method, const char *arguments, char *result) |
Call the given method with the given arguments, and write the result into the string pointed to by result. | |
Static Public Member Functions | |
static bool | rpc (const char *name, const char *method, const char *arguments, char *result) |
Use the lookup function to lookup an object and, if successful, call its rpc method. | |
static Base * | lookup (const char *name, unsigned int len) |
Lookup and return the object that has the given name. | |
template<class C > | |
static void | add_rpc_class () |
Add the class to the list of classes which can have static methods called via rpc (the static methods which can be called are defined by that class' get_rpc_class() static method). |
Detailed Description
A digital output bus, used for setting the state of a collection of pins.
Definition at line 18 of file BusOut.h.
Constructor & Destructor Documentation
BusOut | ( | PinName | p0, |
PinName | p1 = NC , |
||
PinName | p2 = NC , |
||
PinName | p3 = NC , |
||
PinName | p4 = NC , |
||
PinName | p5 = NC , |
||
PinName | p6 = NC , |
||
PinName | p7 = NC , |
||
PinName | p8 = NC , |
||
PinName | p9 = NC , |
||
PinName | p10 = NC , |
||
PinName | p11 = NC , |
||
PinName | p12 = NC , |
||
PinName | p13 = NC , |
||
PinName | p14 = NC , |
||
PinName | p15 = NC , |
||
const char * | name = NULL |
||
) |
Create an BusOut, connected to the specified pins.
- Parameters:
-
p<n> DigitalOut pin to connect to bus bit <n> (p5-p30, NC)
- Note:
- It is only required to specify as many pin variables as is required for the bus; the rest will default to NC (not connected)
Member Function Documentation
static void add_rpc_class | ( | ) | [static, inherited] |
virtual struct rpc_method* get_rpc_methods | ( | ) | [read, virtual] |
Returns a pointer to an array describing the rpc methods supported by this object, terminated by either RPC_METHOD_END or RPC_METHOD_SUPER(Superclass).
Example
class Example : public Base { int foo(int a, int b) { return a + b; } virtual const struct rpc_method *get_rpc_methods() { static const rpc_method rpc_methods[] = { { "foo", generic_caller<int, Example, int, int, &Example::foo> }, RPC_METHOD_SUPER(Base) }; return rpc_methods; } };
Reimplemented from Base.
static Base* lookup | ( | const char * | name, |
unsigned int | len | ||
) | [static, inherited] |
Lookup and return the object that has the given name.
- Parameters:
-
name the name to lookup. len the length of name.
const char* name | ( | ) | [inherited] |
Returns the name of the object.
- Returns:
- The name of the object, or NULL if it has no name.
operator int | ( | ) |
A shorthand for read()
int read | ( | ) |
Read the value currently output on the bus.
- Returns:
- An integer with each bit corresponding to associated DigitalOut pin setting
void register_object | ( | const char * | name ) | [inherited] |
Registers this object with the given name, so that it can be looked up with lookup.
If this object has already been registered, then this just changes the name.
- Parameters:
-
name The name to give the object. If NULL we do nothing.
static bool rpc | ( | const char * | name, |
const char * | method, | ||
const char * | arguments, | ||
char * | result | ||
) | [static, inherited] |
Use the lookup function to lookup an object and, if successful, call its rpc method.
- Returns:
- false if name does not correspond to an object, otherwise the return value of the call to the object's rpc method.
virtual bool rpc | ( | const char * | method, |
const char * | arguments, | ||
char * | result | ||
) | [virtual, inherited] |
Call the given method with the given arguments, and write the result into the string pointed to by result.
The default implementation calls rpc_methods to determine the supported methods.
- Parameters:
-
method The name of the method to call. arguments A list of arguments separated by spaces. result A pointer to a string to write the result into. May be NULL, in which case nothing is written.
- Returns:
- true if method corresponds to a valid rpc method, or false otherwise.
void write | ( | int | value ) |
Write the value to the output bus.
- Parameters:
-
value An integer specifying a bit to write for every corresponding DigitalOut pin
Generated on Tue Jul 12 2022 20:12:26 by
