com.langner.factoryxml.sdk
Interface Datapoint

public interface Datapoint

Über dieses Interface haben Sie Zugriff auf einen einzelnen Datenpunkt.
Erzeugen können Sie eine Instanz nur über die Klasse Connection, indem Sie die Funktion getDatapoint() verwenden.

Nested Class Summary

static interface	Datapoint.HistoryValue Über dieses Interface können Sie auf Verlaufsdaten zugreifen.
static interface	Datapoint.Listener Über dieses Interface können Sie die Aktualisierung der Datenpunkte verfolgen.

Field Summary

static int	VALUE_TYPE_BINARY Der Wert repräsentiert einen Byte[]- Wert und muss somit vor der Benutzung umgewandelt werden.
static int	VALUE_TYPE_BOOL Der Wert repräsentiert einen Boolean- Wert und muss somit vor der Benutzung umgewandelt werden.
static int	VALUE_TYPE_FLOAT Der Wert repräsentiert einen Float- Wert und muss somit vor der Benutzung umgewandelt werden.
static int	VALUE_TYPE_INTEGER Der Wert repräsentiert einen Interger- Wert und muss somit vor der Benutzung umgewandelt werden.
static int	VALUE_TYPE_NOMINAL Der Wert repräsentiert einen Aufzählungstypen.
static int	VALUE_TYPE_STRING Der Wert repräsentiert einen String und kann somit direkt verwendet werden.
static int	VALUE_TYPE_UNKNOWN Der Wertetyp ist unbekannt.

Method Summary

boolean	addListener(Datapoint.Listener fListener) Fügt einen neuen Listener ein, der bei entsprechenden Ereignissen aufgerufen wird.
java.lang.String	getAddress() Ermittelt die Adresse des Datenpunktes.
java.lang.String[]	getEnums() Ermittelt die gültigen Werte bei einem Aufzählungstyp (VALUE_TYPE_NOMINAL).
java.net.URL	getHistoryResource(java.util.Date fStartDate, java.util.Date fEndDate, java.lang.Integer fCount, java.lang.String fFormat, int fWidth, int fHeight) Mit dieser Funktion können Sie grafisch aufbereitete Verlaufsdaten abfragen.
Datapoint.HistoryValue[]	getHistoryValues(int fTimeout, java.util.Date fStartDate, java.util.Date fEndDate, java.lang.Integer fCount) Mit dieser Funktion können Sie Verlaufsdaten zu diesem Datenpunkt abfragen.
java.lang.String	getInfo() Ermittelt allgemeine Informationen zu diesem Datenpunkt.
java.lang.String	getInfo(java.lang.String fContent) Ermittelt einen speziellen Informationseintrag zu diesem Datenpunkt.
java.lang.String[]	getInfoContents() Ermittelt die verfügbaren speziellen Informationskategorien zu diesem Datenpunkt.
java.lang.String	getMaxValue() Ermittelt dem maximalen Wertebereich.
java.lang.String	getMinValue() Ermittelt dem minimalen Wertebereich.
java.lang.String	getName() Ermittelt den Namen des Datenpunktes.
java.util.Properties	getProperties() Ermittelt Eigenschaften zu dieser Instanz.
java.lang.String	getResource(java.lang.String fContent) Ermittelt einen speziellen Ressourceeintrag zu diesem Datenpunkt.
java.lang.String[]	getResourceContents() Ermittelt die verfügbaren Ressourcekategorien zu diesem Datenpunkt.
int	getType() Ermittelt den Typ des Wertes.
java.lang.String	getUnit() Ermittelt die Einheit des Wertes.
java.lang.Object	getUserData() Mit dieser Funktion können Sie das Object ermitteln, welches zuvor mit der Funktion setUserData() gesetzt wurde.
java.lang.String	getValue(java.lang.Integer fTimeout) Ermittelt den aktuellen Wert des Datenpunktes.
boolean	hasSubscription() Ermittelt, ob eine Benachrichtigung aktiv ist.
boolean	isReadable() Ermittelt, ob ein Aufruf von getValue() oder die Anmeldung einer Benachrichtigung erlaubt ist.
boolean	isWriteable() Ermittelt, ob ein Aufruf von setValue() erlaubt ist.
boolean	removeListener(Datapoint.Listener fListener) Entfernt den angegebenen Listener.
void	setUserData(java.lang.Object fUserData) Mit dieser Funktion können Sie zusätzliche Daten zu diesem Datenpunkt ablegen.
boolean	setValue(java.lang.String fValue) Ändern den Wert des Datenpunktes.
boolean	subscribeCyclic(java.lang.Integer fInverval) Diese Funktion ermöglicht es Ihnen, die Werte für diesen Datenpunkt periodisch zu ermitteln.
boolean	subscribeDelta(java.lang.Integer fTolerance) Diese Funktion ermöglicht es Ihnen, die Werte für diesen Datenpunkt bei jeder Änderung zu ermitteln.
boolean	unsubscribe() Beendet eine aktive Benachrichtigung.

Field Detail

VALUE_TYPE_UNKNOWN

public static final int VALUE_TYPE_UNKNOWN

Der Wertetyp ist unbekannt.
Eine Datapoint- Instanz muss nicht immer einen Wert repräsentieren.
So kann z.B. auch eine Teiladressierung Informationen und Ressourcen für einen ganzen Zweig bereitstellen.
Z.B. gibt es zwei Datenpunkte fabrik.datenpunkt1 und fabrik.datenpunkt2, die Werte zur Verfügung stellen.
Die Adresse fabrik könnte dann allgemeine Informationen und Ressourcen bereitstellen.

See Also:

Constant Field Values

VALUE_TYPE_STRING

public static final int VALUE_TYPE_STRING

Der Wert repräsentiert einen String und kann somit direkt verwendet werden.
getMinValue() liefert die minimale und getMaxValue() die maximale Zeichenlänge.

See Also:

Constant Field Values

VALUE_TYPE_INTEGER

public static final int VALUE_TYPE_INTEGER

Der Wert repräsentiert einen Interger- Wert und muss somit vor der Benutzung umgewandelt werden.
Hierzu dienen die Funktionen Integer.valueOf() und Integer.toString().
Die Funktionen getMinValue() und getMaxValue() liefern den gültigen Wertebereich.

See Also:

Constant Field Values

VALUE_TYPE_FLOAT

public static final int VALUE_TYPE_FLOAT

Der Wert repräsentiert einen Float- Wert und muss somit vor der Benutzung umgewandelt werden.
Hierzu dienen die Funktionen Float.valueOf() und Float.toString().
Die Funktionen getMinValue() und getMaxValue() liefern den gültigen Wertebereich.

See Also:

Constant Field Values

VALUE_TYPE_BINARY

public static final int VALUE_TYPE_BINARY

Der Wert repräsentiert einen Byte[]- Wert und muss somit vor der Benutzung umgewandelt werden.
In dem String stehen für jedes Byte zwei hexadezimale Ziffern.
getMinValue() liefert die minimale und getMaxValue() die maximale Größe.

See Also:

Constant Field Values

VALUE_TYPE_BOOL

public static final int VALUE_TYPE_BOOL

Der Wert repräsentiert einen Boolean- Wert und muss somit vor der Benutzung umgewandelt werden.
Hierzu dienen die Funktionen Boolean.valueOf() und Boolean.toString()

See Also:

Constant Field Values

VALUE_TYPE_NOMINAL

public static final int VALUE_TYPE_NOMINAL

Der Wert repräsentiert einen Aufzählungstypen. Der Wert enthält einen String und kann somit direkt verwendet werden.
Bei diesem Typ können Sie die Liste der möglichen Werte mit der Funktion getEnums() ermitteln.

See Also:

Constant Field Values

Method Detail

addListener

public boolean addListener(Datapoint.Listener fListener)

Fügt einen neuen Listener ein, der bei entsprechenden Ereignissen aufgerufen wird.

Parameters:

fListener - Der hinzuzufügende Listener

Returns:

true wenn der Listener erfolgreich hinzugefügt wurde. Ansonsten false.

removeListener

public boolean removeListener(Datapoint.Listener fListener)

Entfernt den angegebenen Listener.
Ereignisse werden dann nicht mehr an diese Instanz gemeldet.

Parameters:

fListener - Der zu entfernende Listener

Returns:

true wenn der Listener erfolgreich entfernt wurde. Ansonsten false.

getValue

public java.lang.String getValue(java.lang.Integer fTimeout)

Ermittelt den aktuellen Wert des Datenpunktes.

Parameters:

fTimeout - Zeitraum in Millisekunden, in dem auf ein Ergebnis gewartet wird.
null, wenn nicht auf das Ergebnis gewartet werden soll.
Den ermittelten Wert erhalten Sie auf jeden Fall aber auch über die angemeldeten Listener.

Returns:

Der neue Wert, bzw. null, falls dieser in der angegebenen Zeit nicht ermittelt werden konnte.

setValue

public boolean setValue(java.lang.String fValue)

Ändern den Wert des Datenpunktes.
Ob der Dienst diesen Wert übernommen hat, können Sie über die angemeldeten Listener feststellen oder mit einem Aufruf der Funktion getValue() überprüfen.

Parameters:

fValue - Der neue Wert.

Returns:

true wenn die Anforderung erfolgreich übertragen wurde. Ansonsten false.

isWriteable

public boolean isWriteable()

Ermittelt, ob ein Aufruf von setValue() erlaubt ist.

Returns:

true wenn das Ändern des Wertes erlaubt ist. Ansonsten false.

isReadable

public boolean isReadable()

Ermittelt, ob ein Aufruf von getValue() oder die Anmeldung einer Benachrichtigung erlaubt ist.

Returns:

true wenn das Auslesen des Wertes erlaubt ist. Ansonsten false.

getInfo

public java.lang.String getInfo()

Ermittelt allgemeine Informationen zu diesem Datenpunkt.
Dieser Informationseintrag ist eine textuelle Beschreibung des Datenpunktes.

Returns:

Informationen zu diesem Datenpunkt.

getInfo

public java.lang.String getInfo(java.lang.String fContent)

Ermittelt einen speziellen Informationseintrag zu diesem Datenpunkt.
Diese Informationseinträge dienen der Beschreibung des Datenpunktes und beschreiben eine URL.

Parameters:

fContent - Beschreibt die Kategorie der Information.

Returns:

Informationen der Kategorie zu diesem Datenpunkt.

getInfoContents

public java.lang.String[] getInfoContents()

Ermittelt die verfügbaren speziellen Informationskategorien zu diesem Datenpunkt.

Returns:

Verfügbare spezielle Informationskategorien zu diesem Datenpunkt.

getName

public java.lang.String getName()

Ermittelt den Namen des Datenpunktes.

Returns:

Name des Datenpunktes.

getAddress

public java.lang.String getAddress()

Ermittelt die Adresse des Datenpunktes.

Returns:

Adresse des Datenpunktes.

getEnums

public java.lang.String[] getEnums()

Ermittelt die gültigen Werte bei einem Aufzählungstyp (VALUE_TYPE_NOMINAL).

Returns:

Gültige Werte für ein Aufzählungstypen.

getMinValue

public java.lang.String getMinValue()

Ermittelt dem minimalen Wertebereich.

Returns:

Minimaler Wertebereich.

getMaxValue

public java.lang.String getMaxValue()

Ermittelt dem maximalen Wertebereich.

Returns:

Maximaler Wertebereich.

getUnit

public java.lang.String getUnit()

Ermittelt die Einheit des Wertes.

Returns:

Einheit des Wertes.

getResource

public java.lang.String getResource(java.lang.String fContent)

Ermittelt einen speziellen Ressourceeintrag zu diesem Datenpunkt.
Resourcen sind grafische Visualisierungen des Datenpunktes und beschreiben eine URL.

Parameters:

fContent - Beschreibt die Kategorie der Ressource.

Returns:

Resource der Kategorie zu diesem Datenpunkt.

getResourceContents

public java.lang.String[] getResourceContents()

Ermittelt die verfügbaren Ressourcekategorien zu diesem Datenpunkt.

Returns:

Verfügbare Ressourcekategorien zu diesem Datenpunkt.

getType

public int getType()

Ermittelt den Typ des Wertes.

Returns:

Typ des Wertes.

Mögliche Werte sind :
• VALUE_TYPE_UNKNOWN
• VALUE_TYPE_STRING
• VALUE_TYPE_INTEGER
• VALUE_TYPE_FLOAT
• VALUE_TYPE_BINARY
• VALUE_TYPE_BOOL
• VALUE_TYPE_NOMINAL

getUserData

public java.lang.Object getUserData()

Mit dieser Funktion können Sie das Object ermitteln, welches zuvor mit der Funktion setUserData() gesetzt wurde.

Returns:

Benutzerdaten.

setUserData

public void setUserData(java.lang.Object fUserData)

Mit dieser Funktion können Sie zusätzliche Daten zu diesem Datenpunkt ablegen.
Sie können diese Daten dann mit der Funktion getUserData() abgefagen.
Die Daten werden nur in dieser Instanz abgelegt und nicht zum Dienst übertragen.

Parameters:

fUserData - Benutzerdaten.

getHistoryValues

public Datapoint.HistoryValue[] getHistoryValues(int fTimeout,
                                                 java.util.Date fStartDate,
                                                 java.util.Date fEndDate,
                                                 java.lang.Integer fCount)

Mit dieser Funktion können Sie Verlaufsdaten zu diesem Datenpunkt abfragen.
Diese Funktionalität steht nur zur Verfügung, wenn ein DEVICE_TYPE_HISTORIAN- Dienst über das Directory Werte für diesen Datenpunkt bereitstellt.

Parameters:

fTimeout - Zeitraum in Millisekunden, in dem auf ein Ergebnis gewartet wird.

fStartDate - Startzeitpunkt.
null, wenn der früheste Zeitpunkt verwendet werden soll.

fEndDate - Endzeitpunkt.
null, wenn der späteste Zeitpunkt verwendet werden soll.

fCount - Maximale Anzahl an Werten.
null, wenn alle Werte innerhalb des Zeitraumes geliefert werden sollen.

Returns:

Verlaufsdaten zu diesem Datenpunkt.

getHistoryResource

public java.net.URL getHistoryResource(java.util.Date fStartDate,
                                       java.util.Date fEndDate,
                                       java.lang.Integer fCount,
                                       java.lang.String fFormat,
                                       int fWidth,
                                       int fHeight)

Mit dieser Funktion können Sie grafisch aufbereitete Verlaufsdaten abfragen.
Diese Funktionalität steht nur zur Verfügung, wenn ein DEVICE_TYPE_HISTORIAN- Dienst über das Directory Werte für diesen Datenpunkt bereitstellt.
Zudem muss noch ein DEVICE_TYPE_RESOURCE- Dienst über das Directory erreichbar sein.

Parameters:

fStartDate - Startzeitpunkt.
null, wenn der früheste Zeitpunkt verwendet werden soll.

fEndDate - Endzeitpunkt.
null, wenn der späteste Zeitpunkt verwendet werden soll.

fCount - Maximale Anzahl an Werten.
null, wenn alle Werte innerhalb des Zeitraumes geliefert werden sollen.

fFormat - Format der Grafik.

Mögliche Werte sind:
• JPG
• PNG

fWidth - Breite der Grafik.

fHeight - Höhe der Grafik.

Returns:

URL der Grafik.

subscribeCyclic

public boolean subscribeCyclic(java.lang.Integer fInverval)

Diese Funktion ermöglicht es Ihnen, die Werte für diesen Datenpunkt periodisch zu ermitteln.
Die neuen Werte bekommen Sie dann über die angemeldeten Listener signalisiert.
Ist bereits eine Benachrichtigung aktiv, wird diese zuvor beendet.

Parameters:

fInverval - Zeitintervall im Millisekunden.
Bzw. null, wenn der voreingestellte Wert des Dienstes verwendet werden soll.

Returns:

true wenn die Anmeldung erfolgreich war. Ansonsten false.

subscribeDelta

public boolean subscribeDelta(java.lang.Integer fTolerance)

Diese Funktion ermöglicht es Ihnen, die Werte für diesen Datenpunkt bei jeder Änderung zu ermitteln.
Die neuen Werte bekommen Sie dann über die angemeldeten Listener signalisiert.
Ist bereits eine Benachrichtigung aktiv, wird diese zuvor beendet.

Parameters:

fTolerance - Prozentwert in Bezug auf den Wertebereich.
Gültige Werte für fTolerance: 0..100.
null, wenn jede Änderung signalisiert werden soll.

Returns:

true wenn die Anmeldung erfolgreich war. Ansonsten false.

hasSubscription

public boolean hasSubscription()

Ermittelt, ob eine Benachrichtigung aktiv ist.

Returns:

true wenn eine Benachrichtigung aktiv ist. Ansonsten false.

unsubscribe

public boolean unsubscribe()

Beendet eine aktive Benachrichtigung.

Returns:

true wenn die Abmeldung erfolgreich war. Ansonsten false.

getProperties

public java.util.Properties getProperties()

Ermittelt Eigenschaften zu dieser Instanz.

Returns:

Liefert die Eigenschaften.