Plegma API  v2
Yodiwo.API.Plegma.Port Class Reference

Basic Input/Output entity of a Thing Creates and sends messages towards the Yodiwo cloud service, or receives and handles messages from the cloud. Both events occur via the PortEventMsg message More...

Public Member Functions

string PortState (string epkey=null)
 
uint PortRevNum (string epkey=null)
 
ulong PortTimestamp (string epkey=null)
 
 Port (PortKey portKey, ePortType type, ioPortDirection ioDirection, string portmodelid=null)
 
void Update_Except_States (Port otherPort)
 
void Update (Port otherPort)
 
Port DeepClone ()
 
override string ToString ()
 
object GetStateObject ()
 
bool IsNumeric ()
 
void SetState (string newState, DateTime?timestamp=null, string epkey=null)
 
void IncRevNum (string epkey)
 

Static Public Member Functions

static Type ePortType2Type (ePortType PortType)
 
static object State2Value (ePortType portType, string state)
 
static string Value2State (object value)
 

Public Attributes

string PortKey
 Globally unique string identifying this port; Construct it using the PortKey constructor More...
 
string Name
 Friendly name of this Port (as it will appear in the Cyan UI and blocks) More...
 
string Description
 Description of Port to show in Cyan (tooltip, etc) More...
 
ioPortDirection ioDirection
 Direction (ioPortDirection) of Port More...
 
ePortType Type
 type (ePortType) of values that each Port sends / receives More...
 
string Semantics
 semantics of values that Port sends / receives More...
 
string PortModelId
 id of Port that can Match to a ThingModelType More...
 
DictionaryTS< string, StateTripletStates
 
ePortConf ConfFlags
 Configuration flags for port More...
 
string Color
 Color of port value More...
 
int Size
 Size of port value More...
 
object Yport
 
Action< PortKeyTouch
 
const uint RevNum_NoTracking = 0
 Revnum indicating no tracking of revision numbers More...
 
const uint RevNum_Initialize = 1
 Revnum indicating initialization of port (as if portstate was followed by thing addition) More...
 

Properties

string State [get, set]
 
uint RevNum [get, set]
 
ulong LastUpdatedTimestamp [get, set]
 
StateTriplet this[string epkey] [get]
 
bool IsOutputPort [get]
 
bool IsInputPort [get]
 

Detailed Description

Basic Input/Output entity of a Thing Creates and sends messages towards the Yodiwo cloud service, or receives and handles messages from the cloud. Both events occur via the PortEventMsg message

Member Data Documentation

string Yodiwo.API.Plegma.Port.Color

Color of port value

ePortConf Yodiwo.API.Plegma.Port.ConfFlags

Configuration flags for port

string Yodiwo.API.Plegma.Port.Description

Description of Port to show in Cyan (tooltip, etc)

ioPortDirection Yodiwo.API.Plegma.Port.ioDirection

Direction (ioPortDirection) of Port

string Yodiwo.API.Plegma.Port.Name

Friendly name of this Port (as it will appear in the Cyan UI and blocks)

string Yodiwo.API.Plegma.Port.PortKey

Globally unique string identifying this port; Construct it using the PortKey constructor

string Yodiwo.API.Plegma.Port.PortModelId

id of Port that can Match to a ThingModelType

const uint Yodiwo.API.Plegma.Port.RevNum_Initialize = 1

Revnum indicating initialization of port (as if portstate was followed by thing addition)

const uint Yodiwo.API.Plegma.Port.RevNum_NoTracking = 0

Revnum indicating no tracking of revision numbers

string Yodiwo.API.Plegma.Port.Semantics

semantics of values that Port sends / receives

int Yodiwo.API.Plegma.Port.Size

Size of port value

DictionaryTS<string, StateTriplet> Yodiwo.API.Plegma.Port.States

ePortType Yodiwo.API.Plegma.Port.Type

type (ePortType) of values that each Port sends / receives


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