Plegma API  v2
Yodiwo.API.Plegma.PortState Class Reference

internal state of a referenced Port More...

Public Member Functions

 PortState ()
 parameterless constructor for Port States More...
 
 PortState (string pkey, string state, uint revNum, bool isDeployed)
 constructor of PortEvent classes More...
 

Public Attributes

string PortKey
 PortKey of the Port this message refers to (either generating the event, or receiving the event) More...
 
string State
 Contents of port in string form. See Port.State More...
 
uint RevNum
 Revision number of this update; matches the Port State's internal sequence numbering. See Port.State More...
 
bool IsDeployed
 Specifies whether this port is connected in currently deployed graphs More...
 

Detailed Description

internal state of a referenced Port

Constructor & Destructor Documentation

Yodiwo.API.Plegma.PortState.PortState ( )

parameterless constructor for Port States

Yodiwo.API.Plegma.PortState.PortState ( string  pkey,
string  state,
uint  revNum,
bool  isDeployed 
)

constructor of PortEvent classes

Parameters
pkeyPortKey of Port this event refers to
stateState of Port (i.e. contents of message, Port.State
revNumRevision number of this event
isDeployedSpecifies whether this Port is currently active

Member Data Documentation

bool Yodiwo.API.Plegma.PortState.IsDeployed

Specifies whether this port is connected in currently deployed graphs

string Yodiwo.API.Plegma.PortState.PortKey

PortKey of the Port this message refers to (either generating the event, or receiving the event)

uint Yodiwo.API.Plegma.PortState.RevNum

Revision number of this update; matches the Port State's internal sequence numbering. See Port.State

string Yodiwo.API.Plegma.PortState.State

Contents of port in string form. See Port.State


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