org.eclipse.scada.vi.ui.draw2d

Class SymbolData

java.lang.Object

org.eclipse.scada.vi.ui.draw2d.SymbolData

public class SymbolData
extends java.lang.Object

Holds the data of the registered items for one symbol

All items that are registered for one symbol will provide the data to the symbols SymbolData instance. The information can be accessed by calling methods like getPrimaryValue(String) or getValue(String).

If the item was registered using SymbolContext.registerItem(String, String, String, boolean, boolean) with ignoreSummary set to true then the value of this dataitem will not be considered for the summary state.

Since:

0.17.0

Constructor Summary

Constructors

Constructor and Description
SymbolData(SymbolController symbolController)

Method Summary

Methods

Modifier and Type	Method and Description
Variant	getAttributeValue(java.lang.String name, java.lang.String attributeName)
Variant	getPrimaryValue(java.lang.String name)
SummaryInformation	getSummary()
DataItemValue	getValue(java.lang.String name)
java.util.Map<java.lang.String,DataItemValue>	getValues()
boolean	isAckRequired(java.lang.String name)
boolean	isAlarm(java.lang.String name)
boolean	isAttributeWithDefault(java.lang.String name, java.lang.String attributeName, boolean defaultValue)
boolean	isBlocked(java.lang.String name)
boolean	isError(java.lang.String name)
boolean	isManual(java.lang.String name)
boolean	isValid(java.lang.String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SymbolData

public SymbolData(SymbolController symbolController)

Method Detail

getValues

public java.util.Map<java.lang.String,DataItemValue> getValues()

getValue

public DataItemValue getValue(java.lang.String name)

getPrimaryValue

public Variant getPrimaryValue(java.lang.String name)

isError

public boolean isError(java.lang.String name)

isAlarm

public boolean isAlarm(java.lang.String name)

isManual

public boolean isManual(java.lang.String name)

isBlocked

public boolean isBlocked(java.lang.String name)

isAckRequired

public boolean isAckRequired(java.lang.String name)

isValid

public boolean isValid(java.lang.String name)

isAttributeWithDefault

public boolean isAttributeWithDefault(java.lang.String name,
                             java.lang.String attributeName,
                             boolean defaultValue)

getAttributeValue

public Variant getAttributeValue(java.lang.String name,
                        java.lang.String attributeName)

getSummary

public SummaryInformation getSummary()