C# Класс Yodiwo.API.Plegma.Port

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
Color string
ConfFlags ePortConf
Description string
LastUpdatedTimestamp ulong
Name string
PortKey string
PortModelId string
RevNum uint
Semantics string
Size int
State string
Type ePortType
ioDirection ioPortDirection

Открытые методы

Метод Описание
DeepClone ( ) : Port
GetStateObject ( ) : object
IncRevNum ( ) : void
IsNumeric ( ) : bool
Port ( ) : System
Port ( PortKey portKey, ePortType type, ioPortDirection ioDirection, string portmodelid = null ) : System
SetState ( string newState, System.DateTime timestamp = null ) : void
State2Value ( ePortType portType, string state ) : object
ToString ( ) : string
Update ( Port otherPort ) : void
Update_Except_States ( Port otherPort ) : void
Value2State ( object value ) : string
ePortType2Type ( ePortType PortType ) : Type

Описание методов

DeepClone() публичный Метод

public DeepClone ( ) : Port
Результат Port

GetStateObject() публичный Метод

public GetStateObject ( ) : object
Результат object

IncRevNum() публичный Метод

public IncRevNum ( ) : void
Результат void

IsNumeric() публичный Метод

public IsNumeric ( ) : bool
Результат bool

Port() публичный Метод

public Port ( ) : System
Результат System

Port() публичный Метод

public Port ( PortKey portKey, ePortType type, ioPortDirection ioDirection, string portmodelid = null ) : System
portKey PortKey
type ePortType
ioDirection ioPortDirection
portmodelid string
Результат System

SetState() публичный Метод

public SetState ( string newState, System.DateTime timestamp = null ) : void
newState string
timestamp System.DateTime
Результат void

State2Value() публичный статический Метод

public static State2Value ( ePortType portType, string state ) : object
portType ePortType
state string
Результат object

ToString() публичный Метод

public ToString ( ) : string
Результат string

Update() публичный Метод

public Update ( Port otherPort ) : void
otherPort Port
Результат void

Update_Except_States() публичный Метод

public Update_Except_States ( Port otherPort ) : void
otherPort Port
Результат void

Value2State() публичный статический Метод

public static Value2State ( object value ) : string
value object
Результат string

ePortType2Type() публичный статический Метод

public static ePortType2Type ( ePortType PortType ) : Type
PortType ePortType
Результат System.Type

Описание свойств

Color публичное свойство

Color of port value
public string Color
Результат string

ConfFlags публичное свойство

Configuration flags for port
public ePortConf ConfFlags
Результат ePortConf

Description публичное свойство

Description of Port to show in Cyan (tooltip, etc)
public string Description
Результат string

LastUpdatedTimestamp публичное свойство

Timestamp of the last action that updated the port value and/or revision number
public ulong LastUpdatedTimestamp
Результат ulong

Name публичное свойство

Friendly name of this Port (as it will appear in the Cyan UI and blocks)
public string Name
Результат string

PortKey публичное свойство

Globally unique string identifying this port; Construct it using the PortKey constructor
public string PortKey
Результат string

PortModelId публичное свойство

id of Port that can Match to a ThingModelType
public string PortModelId
Результат string

RevNum публичное свойство

Port state sequence number: incremented by the Cloud server at every state update, so that Node and servers stay in sync
public uint RevNum
Результат uint

Semantics публичное свойство

semantics of values that Port sends / receives
public string Semantics
Результат string

Size публичное свойство

Size of port value
public int Size
Результат int

State публичное свойство

Current (at latest update/sampling/trigger/etc) value of Port as String. Contains a string representation of the port's state, encoded according to the port's ePortType On receiving events the Cloud Server will attempt to parse the State based on its ePortType When sending events the Cloud Server will encode the new state into a string, again according to the Port's ePortType
public string State
Результат string

Type публичное свойство

type (ePortType) of values that each Port sends / receives
public ePortType Type
Результат ePortType

ioDirection публичное свойство

Direction (ioPortDirection) of Port
public ioPortDirection ioDirection
Результат ioPortDirection