tuwien.auto.eibpoints

Class Point


public class Point
extends java.lang.Object

This class is an abstraction of a EIB/KNX point. In this implementation the group address is used for point identification. To allow further processing the point is given a human readable name as well as a major and minor type (DPT types). Major and minor types are used to interpret message contents sent to this group address. The interpretation itself is handled by a variety of classes in the eibxlator package. To enhance configuration reuse, save and restore facilities are provided.
See Also:
PointList, PDUXlatorList

Field Summary

static String
XML_DEVICE
Document element

Constructor Summary

Point(Node _XMLNode)
This constructor is used to restore a point configuration from a XML_Node.
Point(String _PointName, EIB_Address _Address, String _PointTypeMajor, String _PointTypeMinor)
This constructor is used to create a new point object.

Method Summary

EIB_Address[]
getDeviceAddress()
Returns the bounded EIB/KNX group addresses.
String
getDeviceName()
Returns the device name
String
getMajorType()
Returns the major type.
String
getMinorType()
Get the minor type.
String
getPointString()
Returns a string composed of the device name and address string
void
setDeviceAddress(EIB_Address _Address)
Sets the device address
void
setDeviceName(String _DeviceName)
Sets the device name.
Node
toXML(Document doc)
This method is used for store the object values in XML format.

Field Details

XML_DEVICE

public static final String XML_DEVICE
Document element

Constructor Details

Point

public Point(Node _XMLNode)
            throws EICLException
This constructor is used to restore a point configuration from a XML_Node. If the structure is not the expected an exception is thrown.
Parameters:
_XMLNode - The document node with label "point"
Throws:
EICLException - This exception is thrown if the XML node has not the expected structure, or if the major/minor DPT type can't be found.

Point

public Point(String _PointName,
             EIB_Address _Address,
             String _PointTypeMajor,
             String _PointTypeMinor)
            throws EICLException
This constructor is used to create a new point object. All needed information are specified by respective options.
Parameters:
_PointName - the device name
_Address - the device address
_PointTypeMajor - the major DPT point type key
_PointTypeMinor - the minor DPT point type key
Throws:
EICLException - This Exception is thrown if major or minor type can't be found.

Method Details

getDeviceAddress

public EIB_Address[] getDeviceAddress()
Returns the bounded EIB/KNX group addresses. In this class the returned array contains only 1 element. Nevertheless this structure will be needed in further versions.
Returns:
the group addresses

getDeviceName

public final String getDeviceName()
Returns the device name
Returns:
the device name

getMajorType

public final String getMajorType()
Returns the major type.
Returns:
the major type.

getMinorType

public final String getMinorType()
Get the minor type.
Returns:
the minor type.

getPointString

public String getPointString()
Returns a string composed of the device name and address string
Returns:
A point description string

setDeviceAddress

public void setDeviceAddress(EIB_Address _Address)
Sets the device address
Parameters:
_Address - The device addresses

setDeviceName

public final void setDeviceName(String _DeviceName)
Sets the device name.
Parameters:
_DeviceName - the new device name.

toXML

public Node toXML(Document doc)
This method is used for store the object values in XML format.
Parameters:
doc - the XML document object
Returns:
the XML document node with label "point"