tuwien.auto.calimero.dptxlator.DPT Maven / Gradle / Ivy
Show all versions of calimero-core Show documentation
/*
Calimero 2 - A library for KNX network access
Copyright (c) 2006, 2018 B. Malinowsky
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under terms
of your choice, provided that you also meet, for each linked independent
module, the terms and conditions of the license of that module. An
independent module is a module which is not derived from or based on
this library. If you modify this library, you may extend this exception
to your version of the library, but you are not obligated to do so. If
you do not wish to do so, delete this exception statement from your
version.
*/
package tuwien.auto.calimero.dptxlator;
/**
* Stores information about a datapoint type.
*
* Besides the subtype ID of the DPT, a general description, and the unit of measure (if
* any), there are two additional informational values. They contain string
* representations of translator values. The first one should contain the string
* representation of a low value, if possible the lower bound of the supported value
* range, and the second contains a corresponding upper bound string value representation.
*
* Even though not enforced, the preferred way for identifying a DPT is to use a datapoint
* type ID (dptID) value in the format "[main number].[sub number]".
* Instances of this type are immutable.
*
* @author B. Malinowsky
*/
public class DPT
{
private final String id;
private final String desc;
private final String v1;
private final String v2;
private final String unit;
/**
* Creates a new datapoint type information structure.
*
* @param typeID datapoint type identifier
* @param description short textual description
* @param lower lower value information
* @param upper upper value information
* @param unit unit of measure, use "" or null for no unit
*/
public DPT(final String typeID, final String description, final String lower,
final String upper, final String unit)
{
id = typeID;
desc = description;
v1 = lower;
v2 = upper;
this.unit = unit == null ? "" : unit;
}
/**
* Creates a new datapoint type information structure for a DPT without a unit.
*
* @param typeID datapoint type identifier
* @param description short textual description
* @param lower lower value information
* @param upper upper value information
*/
public DPT(final String typeID, final String description, final String lower, final String upper)
{
this(typeID, description, lower, upper, "");
}
/**
* Returns the DPT identifier.
*
* @return ID as string
*/
public final String getID()
{
return id;
}
/**
* Returns the DPT description.
*
* @return description as string
*/
public final String getDescription()
{
return desc;
}
/**
* Returns the unit of measure for this DPT.
*
* @return unit as string, the empty string for no unit
*/
public final String getUnit()
{
return unit;
}
/**
* Returns a lower value information.
*
* The value either contains a string value representation of some lower bound in the
* value range of this DPT, or a more general DPT encoding range information if
* practicable.
*
* @return lower value as string
*/
public final String getLowerValue()
{
return v1;
}
/**
* Returns an upper value information.
*
* It contains an upper value representation in the value range for this DPT. The
* corresponding method {@link #getLowerValue()} should contain the lower bound value
* then.
* If no information about an upper value can be given, a DPT might set this
* information optional, and the empty string is returned.
*
* @return value as string, or the empty string
*/
public final String getUpperValue()
{
return v2;
}
/**
* Returns the DPT's information in concise textual format.
*
* @return a string representation of the DPT
*/
@Override
public String toString()
{
final StringBuilder sb = new StringBuilder(50);
sb.append(id).append(": ").append(desc).append(", values ").append(v1);
if (v2.length() > 0)
sb.append("..").append(v2);
if (unit.length() > 0)
sb.append(' ').append(unit);
return sb.toString();
}
@Override
public boolean equals(final Object obj)
{
return obj == this || obj instanceof DPT && ((DPT) obj).id.equals(id);
}
@Override
public int hashCode()
{
return id.hashCode();
}
}