tuwien.auto.calimero.link.MonitorFrameEvent Maven / Gradle / Ivy
Show all versions of calimero-core Show documentation
/*
Calimero 2 - A library for KNX network access
Copyright (c) 2006, 2011 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.link;
import tuwien.auto.calimero.FrameEvent;
import tuwien.auto.calimero.KNXFormatException;
import tuwien.auto.calimero.cemi.CEMI;
import tuwien.auto.calimero.link.medium.RawFrame;
/**
* Informs about a new monitor indication received from the KNX network and contains the
* received indication frame.
*
* The source of the event is a {@link KNXNetworkMonitor}.
*
* @author B. Malinowsky
*/
public class MonitorFrameEvent extends FrameEvent
{
private static final long serialVersionUID = 1L;
private final RawFrame raw;
private final KNXFormatException e;
/**
* Creates a new monitor frame event with the indication frame.
*
* @param source the network monitor which received the frame
* @param frame monitor indication frame encapsulated in cEMI type
*/
public MonitorFrameEvent(final KNXNetworkMonitor source, final CEMI frame)
{
super(source, frame);
raw = null;
e = null;
}
/**
* Creates a new monitor frame event with the indication frame and the decoded raw
* frame.
*
* @param source the network monitor which received the frame
* @param frame monitor indication frame encapsulated in cEMI type
* @param rawFrame the decoded raw frame on medium encapsulated in type RawFrame, use
* null if no decoded raw frame is available
*/
public MonitorFrameEvent(final KNXNetworkMonitor source, final CEMI frame,
final RawFrame rawFrame)
{
super(source, frame);
raw = rawFrame;
e = null;
}
/**
* Creates a new monitor frame event with the indication frame and error information about a
* failed decoding of the raw frame.
*
* @param source the network monitor which received the frame
* @param frame monitor indication frame encapsulated in cEMI type
* @param decodeError the exception object obtained during decoding the received raw
* frame on medium
*/
public MonitorFrameEvent(final KNXNetworkMonitor source, final CEMI frame,
final KNXFormatException decodeError)
{
super(source, frame);
raw = null;
e = decodeError;
}
/**
* Returns the decoded raw frame on medium.
*
* If decoding of raw frames is enabled and this method returns null, try
* {@link #getDecodeError()} for decode error information.
*
* @return the frame of type RawFrame or null on no decoded raw frame
*/
public final RawFrame getRawFrame()
{
return raw;
}
/**
* Returns the exception object obtained during creation of a decoded raw frame, providing error
* information while decoding the raw frame on medium.
*
* If decoding of raw frames is disabled, this method returns always null.
*
* @return the exception object, or null if {@link #getRawFrame()} returns the
* decoded {@link RawFrame}, i.e., not null
*/
public final KNXFormatException getDecodeError()
{
return e;
}
}