org.refcodes.codec.ModemMetrics Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of refcodes-codec Show documentation

Artifact with encoding and decoding (not in terms of encryption/decryption) implementations (codecs) such as BASE64 encoding / decoding.

There is a newer version: 3.3.8

Show newest version

// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// /////////////////////////////////////////////////////////////////////////////
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// -----------------------------------------------------------------------------
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// -----------------------------------------------------------------------------
// Apache License, v2.0 ("http://www.apache.org/licenses/LICENSE-2.0")
// -----------------------------------------------------------------------------
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////
package org.refcodes.codec;

/**
 * The Interface ModemMetrics.
 */
public interface ModemMetrics extends SampleRateAccessor, ModulationFormatAccessor, ChannelSelectorAccessor, ModemModeAccessor, FrequencyThresholdAccessor {

	/**
	 * Calculates the upper threshold for the higher frequency.
	 * 
	 * @return The according threshold.
	 */
	default int toHigherFrequencyUpperThreshold() {
		return getModemMode().getHigherFrequency() + Math.round( (getModemMode().getHigherFrequency() * getFrequencyThreshold().getPercent()) / 100.0f );
	}

	/**
	 * Calculates the upper threshold for the lower frequency.
	 * 
	 * @return The according threshold.
	 */
	default int toLowerFrequencyUpperThreshold() {
		return getModemMode().getLowerFrequency() + Math.round( (getModemMode().getLowerFrequency() * getFrequencyThreshold().getPercent()) / 100.0f );
	}

	/**
	 * Calculates the samples per bit.
	 * 
	 * @return The according number of samples.
	 */
	default int toSamplesPerBit() {
		return getSampleRate().getValue() / getModemMode().getBaudRate();
	}

}