Maggie Mei / mbedConnectorInterfaceWithDM

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 mbedConnectorInterfaceWithDM by Doug Anson

Embed: (wiki syntax)

« Back to documentation index

Resource< InnerType > Class Template Reference
Public Member Functions

Resource< InnerType > Class Template Reference

Resource class. More...

#include <Resource.h>

Public Member Functions

 Resource (const Logger *logger, const string obj_name, const string res_name, InnerType value)
 Default constructor.
 Resource (const Resource< InnerType > &resource)
 Copy constructor.
virtual ~Resource ()
 Destructor.
string getObjName ()
 Get the Object name.
string getResName ()
 Get the Resource name.
string getFullName ()
 Get the Full name.
InnerType getValue ()
 Get the resource value.
void setName (const string name)
 Set the resource name.
void setValue (const InnerType value)
 Set the resource value.
virtual void bind (void *ep)=0
 Bind resource to endpoint.
void setOptions (const void *options)
 set the options
void setEndpoint (const void *endpoint)
 set the endpoint
int getInstanceNumber ()
 Get our Instance Number.
void setInstanceNumber (int instance_number)
 Set our Instance Number.

Detailed Description

template<typename InnerType>
class Resource< InnerType >

Resource class.

Definition at line 43 of file Resource.h.

Constructor & Destructor Documentation

Resource ( const Logger *  logger,
const string  obj_name,
const string  res_name,
InnerType  value 
)

Default constructor.

Parameters:
loggerinput the Logger instance this Resource is a part of
obj_nameinput the Object Name
res_nameinput the Resource URI/Name
valueinput the Resource value

Definition at line 64 of file Resource.h.

Resource ( const Resource< InnerType > &  resource )

Copy constructor.

Parameters:
resourceinput the Resource that is to be deep copied

Definition at line 77 of file Resource.h.

virtual ~Resource (  ) [virtual]

Destructor.

Definition at line 90 of file Resource.h.

Member Function Documentation

virtual void bind ( void *  ep ) [pure virtual]

Bind resource to endpoint.

Parameters:
epinput pointer to the Endpoint instance

Implemented in DynamicResource, and StaticResource.

string getFullName (  )

Get the Full name.

Returns:
the name of the object

Definition at line 113 of file Resource.h.

int getInstanceNumber (  )

Get our Instance Number.

Returns:
our instance number

Definition at line 176 of file Resource.h.

string getObjName (  )

Get the Object name.

Returns:
the name of the object

Definition at line 97 of file Resource.h.

string getResName (  )

Get the Resource name.

Returns:
the name of the resource

Definition at line 105 of file Resource.h.

InnerType getValue (  )

Get the resource value.

Returns:
the value of the resource

Definition at line 124 of file Resource.h.

void setEndpoint ( const void *  endpoint )

set the endpoint

Definition at line 165 of file Resource.h.

void setInstanceNumber ( int  instance_number )

Set our Instance Number.

Parameters:
instance_numberinput our designated instance number

Definition at line 182 of file Resource.h.

void setName ( const string  name )

Set the resource name.

Parameters:
nameinput the resource name

Definition at line 132 of file Resource.h.

void setOptions ( const void *  options )

set the options

Definition at line 158 of file Resource.h.

void setValue ( const InnerType  value )

Set the resource value.

Parameters:
valueinput the resource value

Definition at line 140 of file Resource.h.

Generated on Wed Jul 13 2022 01:24:03 by  doxygen 1.7.2