tuwien.auto.calimero.knxnetip.util.DIB Maven / Gradle / Ivy
Show all versions of calimero-core Show documentation
/*
Calimero 2 - A library for KNX network access
Copyright (c) 2006, 2015 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.knxnetip.util;
import tuwien.auto.calimero.exception.KNXFormatException;
/**
* Description Information Block (DIB).
*
* A DIB is used to return device-specific information.
* This DIB is a common base for more detailed description formats contained in DIBs. For
* usage of the different description information available, refer to the DIB subtypes.
*
* The currently known valid descriptor type codes (KNXnet/IP core specification v1.2) are
* defined as available DIB constants.
*
* @author B. Malinowsky
*/
public abstract class DIB
{
/**
* Description type code for device information e.g. KNX medium.
*
*/
public static final int DEVICE_INFO = 0x01;
/**
* Description type code for further data defined by device manufacturer.
*
*/
public static final int MFR_DATA = 0xFE;
/**
* Description type code for service families supported by the device.
*
*/
public static final int SUPP_SVC_FAMILIES = 0x02;
/**
* Description type code for the IP configuration device information.
*
*/
public static final int IP_CONFIG = 0x03;
/**
* Description type code for the current IP configuration device information.
*
*/
public static final int IP_CURRENT_CONFIG = 0x04;
/**
* Description type code for the KNX addresses device information.
*
*/
public static final int KNX_ADDRESSES = 0x05;
final int size;
final int type;
/**
* Creates a new DIB out of a byte array.
*
*
* @param data byte array containing DIB structure
* @param offset start offset of DIB in data
* @throws KNXFormatException if no DIB found or invalid structure
*/
protected DIB(final byte[] data, final int offset) throws KNXFormatException
{
if (data.length - offset < 2)
throw new KNXFormatException("buffer too short for DIB header");
size = data[offset] & 0xFF;
type = data[offset + 1] & 0xFF;
if (size > data.length - offset)
throw new KNXFormatException("DIB size bigger than actual data length", size);
}
/**
* Creates a new DIB and initializes basic fields.
*
*
* @param dibSize total size of DIB in bytes, dibSize > 0
* @param descriptionType one of the description type code constants of this class
*/
protected DIB(final int dibSize, final int descriptionType)
{
size = dibSize;
type = descriptionType;
}
/**
* Returns the description type code of this DIB.
*
* The type code specifies which kind of description information is contained in the
* DIB.
*
* @return description type code as unsigned byte
*/
public final int getDescTypeCode()
{
return type;
}
/**
* Returns the structure length of this DIB in bytes.
*
*
* @return structure length as unsigned byte
*/
public final int getStructLength()
{
return size;
}
/**
* Returns the byte representation of the whole DIB structure.
*
*
* @return byte array containing structure
*/
public byte[] toByteArray()
{
final byte[] buf = new byte[size];
buf[0] = (byte) size;
buf[1] = (byte) type;
return buf;
}
}