Plegma API  v2
Yodiwo.API.Plegma.Thing Class Reference

Main representation of a Thing that can interact with the Yodiwo cloud service More...

Public Member Functions

 Thing (ThingKey key, List< Port > ports)
 
 Thing (string uid, List< Port > ports, NodeKey nodeKey)
 
 Thing (ThingKey key)
 
virtual Port GetPort (PortKey key)
 
virtual Port GetPort (int idx)
 
virtual void Update (Thing incomingThing, bool UpdatePortStates=true)
 
string GetConfigValue (string confName)
 
bool SetConfigValue (string confName, string value)
 
string GetReadOnlyValue (string roName)
 
override string ToString ()
 
bool HasSameConfig (Thing thing)
 
Thing DeepClone ()
 
bool IsSameType (Thing thing)
 

Static Public Member Functions

static bool IsSameType (string Thing1_Type, List< Port > Thing1_Ports, string Thing2_Type, List< Port > Thing2_Ports)
 

Public Attributes

string ThingKey
 Globally unique Key string of this Thing More...
 
string Name
 friendly name of this Thing More...
 
List< ConfigParameterConfig = new List<ConfigParameter>()
 list of vendor provided configuration parameters (changeable by the user) More...
 
List< ConfigParameterReadonlyInfo = new List<ConfigParameter>()
 list of vendor provided read-only information More...
 
List< PortPorts = new List<Port>()
 list of ports (inputs / outputs) that this Thing implements More...
 
string Type
 Specifies the Thing's type ThingModelType More...
 
string BlockType
 Specifies the Thing's block type if it's to be specially modeled in the Cyan UI It can be left null if this Thing is to be modeled by the default Cyan UI blocks In this case Output-type Ports are gathered and represented as a Cyan UI Input Thing (thing->cloud events) and Input-type Ports are gathered and represented as a Cyan UI Output Thing (cloud->thing events) Both event directions occur via the PortEventMsg messages More...
 
eThingConf ConfFlags
 Configuration flags for Thing More...
 
bool Removable
 Specifies whether the thing can be removed More...
 
string RESTUri
 Specifies a uri to which the cloud will post messages in case an RX-incapable node is connected. Can be used as a return path for REST api. May be left null or empty. More...
 
string Hierarchy
 Specifies the Thing's hierarchy within the node's modeled ecosystem. Specifies a hierarchical view (separated by '/') of the Thing's position in the User's ecosystem of devices. Must start with '/' May be left null or empty. More...
 
ThingUIHints UIHints
 Hints for the UI system More...
 
object Ything
 

Properties

bool IsInput [get]
 Signifies whether this is an input thing More...
 
bool IsInputOnly [get]
 Signifies whether this is an input thing More...
 
bool IsOutput [get]
 Signifies whether this is an output thing More...
 
bool IsOutputOnly [get]
 Signifies whether this is an output thing More...
 

Detailed Description

Main representation of a Thing that can interact with the Yodiwo cloud service

Member Data Documentation

string Yodiwo.API.Plegma.Thing.BlockType

Specifies the Thing's block type if it's to be specially modeled in the Cyan UI It can be left null if this Thing is to be modeled by the default Cyan UI blocks In this case Output-type Ports are gathered and represented as a Cyan UI Input Thing (thing->cloud events) and Input-type Ports are gathered and represented as a Cyan UI Output Thing (cloud->thing events) Both event directions occur via the PortEventMsg messages

eThingConf Yodiwo.API.Plegma.Thing.ConfFlags

Configuration flags for Thing

List<ConfigParameter> Yodiwo.API.Plegma.Thing.Config = new List<ConfigParameter>()

list of vendor provided configuration parameters (changeable by the user)

string Yodiwo.API.Plegma.Thing.Hierarchy

Specifies the Thing's hierarchy within the node's modeled ecosystem. Specifies a hierarchical view (separated by '/') of the Thing's position in the User's ecosystem of devices. Must start with '/' May be left null or empty.

string Yodiwo.API.Plegma.Thing.Name

friendly name of this Thing

List<Port> Yodiwo.API.Plegma.Thing.Ports = new List<Port>()

list of ports (inputs / outputs) that this Thing implements

List<ConfigParameter> Yodiwo.API.Plegma.Thing.ReadonlyInfo = new List<ConfigParameter>()

list of vendor provided read-only information

bool Yodiwo.API.Plegma.Thing.Removable

Specifies whether the thing can be removed

string Yodiwo.API.Plegma.Thing.RESTUri

Specifies a uri to which the cloud will post messages in case an RX-incapable node is connected. Can be used as a return path for REST api. May be left null or empty.

string Yodiwo.API.Plegma.Thing.ThingKey

Globally unique Key string of this Thing

string Yodiwo.API.Plegma.Thing.Type

Specifies the Thing's type ThingModelType

ThingUIHints Yodiwo.API.Plegma.Thing.UIHints

Hints for the UI system

Property Documentation

bool Yodiwo.API.Plegma.Thing.IsInput
get

Signifies whether this is an input thing

bool Yodiwo.API.Plegma.Thing.IsInputOnly
get

Signifies whether this is an input thing

bool Yodiwo.API.Plegma.Thing.IsOutput
get

Signifies whether this is an output thing

bool Yodiwo.API.Plegma.Thing.IsOutputOnly
get

Signifies whether this is an output thing


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