Sensor.java

/*****************************************************************
SPINE - Signal Processing In-Node Environment is a framework that 
allows dynamic on node configuration for feature extraction and a 
OtA protocol for the management for WSN

Copyright (C) 2007 Telecom Italia S.p.A. 
 
GNU Lesser General Public License
 
This library is free software; you can redistribute
modify it under the terms of the sub-license (below).

*****************************************************************/

/*****************************************************************
BSPAN - BlueTooth Sensor Processing for Android is a framework 
that extends the SPINE framework to work on Android and the 
Android Bluetooth communication services.

Copyright (C) 2011 The National Center for Telehealth and 
Technology

Eclipse Public License 1.0 (EPL-1.0)

This library is free software; you can redistribute it and/or
modify it under the terms of the Eclipse Public License as
published by the Free Software Foundation, version 1.0 of the 
License.

The Eclipse Public License is a reciprocal license, under 
Section 3. REQUIREMENTS iv) states that source code for the 
Program is available from such Contributor, and informs licensees 
how to obtain it in a reasonable manner on or through a medium 
customarily used for software exchange.

Post your updates and modifications to our GitHub or email to 
t2@tee2.org.

This library is distributed WITHOUT ANY WARRANTY; without 
the implied warranty of MERCHANTABILITY or FITNESS FOR A 
PARTICULAR PURPOSE.  See the Eclipse Public License 1.0 (EPL-1.0)
for more details.
 
You should have received a copy of the Eclipse Public License
along with this library; if not, 
visit http://www.opensource.org/licenses/EPL-1.0

*****************************************************************/

package spine.datamodel;

import java.io.Serializable;

import spine.SPINESensorConstants;

public class Sensor implements Serializable {

	private static final long serialVersionUID = 1L;
	
	private byte code;
	private byte channelBitmask;
	
	/**
	 * Constructor of a Sensor object.
	 * 
	 * @param code the sensor code
	 * @param channelBitmask the channels bitmask representing by which channels the sensor is composed of
	 * 
	 * @see spine.SPINESensorConstants 
	 */
	public Sensor(byte code, byte channelBitmask) {
		this.code = code;
		this.channelBitmask = channelBitmask; 
	}
	
	/**
	 * Getter method of the sensor code
	 * 
	 * @return the sensor code
	 */
	public byte getCode() {
		return code;
	}

	/**
	 * Getter method of the sensor channels bitmask
	 * 
	 * @return the sensor channels bitmask
	 */
	public byte getChannelBitmask() {
		return channelBitmask;
	}
	
	/**
	 * 
	 * Returns a string representation of the Sensor object.
	 * 
	 * @return a string representation of this Sensor
	 * 
	 */
	public String toString() {
		return SPINESensorConstants.sensorCodeToString(code) + " - " + 
			   SPINESensorConstants.channelBitmaskToString(channelBitmask);
	}
}