Doug Anson / mbedConnectorInterface

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:   IoT_LED_demo ServoTest uWater_Project hackathon ... more

Embed: (wiki syntax)

« Back to documentation index

StaticResource Class Reference
Public Member Functions

StaticResource Class Reference

StaticResource is a static (GET only) resource with a value type pinned as a string type. More...

#include <StaticResource.h>

Inherits Resource< string >.

Public Member Functions

 StaticResource (const Logger *logger, const char *name, const char *value)
 Default constructor.
 StaticResource (const Logger *logger, const char *name, const string value)
 string value constructor
 StaticResource (const Logger *logger, const string name, const string value)
 constructor with buffer lengths
 StaticResource (const StaticResource &resource)
 Copy constructor.
virtual ~StaticResource ()
 Destructor.
virtual void bind (void *p)
 Bind resource to endpoint.
void setDataWrapper (DataWrapper *data_wrapper)
 Set the data wrapper.
string getName ()
 Get the resource name.
string getValue ()
 Get the resource value.
void setName (const string name)
 Set the resource name.
void setValue (const stringvalue)
 Set the resource value.
void setOptions (const void *options)
 set the options

Detailed Description

StaticResource is a static (GET only) resource with a value type pinned as a string type.

Definition at line 37 of file StaticResource.h.

Constructor & Destructor Documentation

StaticResource ( const Logger *  logger,
const char *  name,
const char *  value 
)

Default constructor.

Parameters:
loggerinput logger instance for this resource
nameinput the Resource URI/Name
valueinput the Resource value (a string)

Definition at line 29 of file StaticResource.cpp.

StaticResource ( const Logger *  logger,
const char *  name,
const string  value 
)

string value constructor

Parameters:
loggerinput logger instance for this resource
nameinput the Resource URI/Name
valueinput the Resource value (a string)

Definition at line 34 of file StaticResource.cpp.

StaticResource ( const Logger *  logger,
const string  name,
const string  value 
)

constructor with buffer lengths

Parameters:
loggerinput logger instance for this resource
nameinput the Resource URI/Name param name_length input the length of the Resource URI/Name
valueinput the Resource value (or NULL)

Definition at line 40 of file StaticResource.cpp.

StaticResource ( const StaticResource &  resource )

Copy constructor.

Parameters:
resourceinput the StaticResource that is to be deep copied

Definition at line 46 of file StaticResource.cpp.

~StaticResource (  ) [virtual]

Destructor.

Definition at line 52 of file StaticResource.cpp.

Member Function Documentation

void bind ( void *  p ) [virtual]

Bind resource to endpoint.

Parameters:
pinput pointer to the endpoint resources necessary for binding

Implements Resource< string >.

Definition at line 57 of file StaticResource.cpp.

string getName (  ) [inherited]

Get the resource name.

Returns:
the name of the resource

Definition at line 72 of file Resource.h.

string getValue (  ) [inherited]

Get the resource value.

Returns:
the value of the resource

Definition at line 80 of file Resource.h.

void setDataWrapper ( DataWrapper *  data_wrapper )

Set the data wrapper.

Parameters:
data_wrapperinput the data wrapper instance

Definition at line 86 of file StaticResource.h.

void setName ( const string  name ) [inherited]

Set the resource name.

Parameters:
nameinput the resource name

Definition at line 88 of file Resource.h.

void setOptions ( const void *  options ) [inherited]

set the options

Definition at line 113 of file Resource.h.

void setValue ( const string  value ) [inherited]

Set the resource value.

Parameters:
valueinput the resource value

Definition at line 96 of file Resource.h.

Generated on Tue Jul 12 2022 15:15:35 by  doxygen 1.7.2