MetaWear C# SDK  1.0.0
C# API for MbientLab's sensor platform
Public Member Functions | Properties | List of all members
MbientLab.MetaWear.IRoute Interface Reference

Defines how data flows from a data producer to an endpoint More...

Public Member Functions

ISubscriber LookupSubscriber (string name)
 Retrieve the subscriber associated with the user defined name. More...
 
void Remove ()
 Removes the route and marks the object as invalid More...
 

Properties

uint ID [get]
 Unique value identifying the route.
More...
 
bool Valid [get]
 True if this object is still useable, discard if false More...
 
ISubscriber [] Subscribers [get]
 Array data subscribers associated with the IRouteComponent.Stream(System.Action<IData>) and IRouteComponent.Log() components. More...
 

Detailed Description

Defines how data flows from a data producer to an endpoint

Member Function Documentation

◆ LookupSubscriber()

ISubscriber MbientLab.MetaWear.IRoute.LookupSubscriber ( string  name)

Retrieve the subscriber associated with the user defined name.

Parameters
nameValue that matches the parameter given to IRouteComponent.Name(string) component
Returns
Object corresponding to the name, null if no subscriber can be found

◆ Remove()

void MbientLab.MetaWear.IRoute.Remove ( )

Removes the route and marks the object as invalid

Property Documentation

◆ ID

uint MbientLab.MetaWear.IRoute.ID
get

Unique value identifying the route.

Use with IMetaWearBoard.LookupRoute(uint) to retrive an existing route

◆ Subscribers

ISubscriber [] MbientLab.MetaWear.IRoute.Subscribers
get

Array data subscribers associated with the IRouteComponent.Stream(System.Action<IData>) and IRouteComponent.Log() components.

The array is ordered to match the order in which the Stream and Log components are added in the route builder

◆ Valid

bool MbientLab.MetaWear.IRoute.Valid
get

True if this object is still useable, discard if false


The documentation for this interface was generated from the following file: