sdrtrunk/src/main/java/io/github/dsheirer/message/SyncLossMessage.java

/*******************************************************************************
 * sdr-trunk
 * Copyright (C) 2014-2018 Dennis Sheirer
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>
 *
 ******************************************************************************/
package io.github.dsheirer.message;

import io.github.dsheirer.identifier.Identifier;
import io.github.dsheirer.protocol.Protocol;

import java.util.Collections;
import java.util.List;

/**
 * Empty message to convey that a number of bits were processed with no sync or valid message detected.
 *
 * This message supports periodic updates to external processor(s) that may be tracking bit error rates.
 */
public class SyncLossMessage extends Message
{
    private int mBitsProcessed;
    private Protocol mProtocol;
    private int mTimeslot = 0;

    /**
     * Constructs a sync loss message.
     *
     * @param timestamp of the message
     * @param bitsProcessed without a sync pattern detection of message decode
     * @param timeslot that lost the sync
     */
    public SyncLossMessage(long timestamp, int bitsProcessed, Protocol protocol, int timeslot)
    {
        super(timestamp);
        mBitsProcessed = bitsProcessed;
        mProtocol = protocol;
        mTimeslot = timeslot;
    }

    /**
     * Constructs a sync loss message.
     *
     * @param timestamp of the message
     * @param bitsProcessed without a sync pattern detection of message decode
     */
    public SyncLossMessage(long timestamp, int bitsProcessed, Protocol protocol)
    {
        this(timestamp, bitsProcessed, protocol, 0);
    }

    /**
     * Timeslot that lost the sync
     * @return timeslot or a default of 0
     */
    @Override
    public int getTimeslot()
    {
        return mTimeslot;
    }

    /**
     * Indicates the number of bits that were processed without a sync detection or message decode
     */
    public int getBitsProcessed()
    {
        return mBitsProcessed;
    }

    @Override
    public String toString()
    {
        return "<-> SYNC LOSS - BITS PROCESSED [" + getBitsProcessed() + "]";
    }

    @Override
    public boolean isValid()
    {
        return true;
    }

    @Override
    public Protocol getProtocol()
    {
        return mProtocol;
    }

    @Override
    public List<Identifier> getIdentifiers()
    {
        return Collections.EMPTY_LIST;
    }
}