acomms/acomms_constants.h

// copyright 2009-2011 t. schneider tes@mit.edu
// 
// this file is part of goby-acomms, a collection of libraries for acoustic underwater networking
//
// 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 software 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 software.  If not, see <http://www.gnu.org/licenses/>.

#ifndef AcommsConstants20091122H
#define AcommsConstants20091122H

#include <string>
#include <limits>
#include <bitset>

#include "goby/core/core_constants.h"

namespace goby
{

    namespace acomms
    {
        const unsigned BITS_IN_BYTE = 8;
        // one hex char is a nibble (4 bits), two nibbles per byte
        const unsigned NIBS_IN_BYTE = 2;

        const int BROADCAST_ID = 0;
        const int QUERY_DESTINATION_ID = -1;
        
        const unsigned char DCCL_CCL_HEADER = 32;
    
        const double NaN = std::numeric_limits<double>::quiet_NaN();
        
        const unsigned DCCL_NUM_HEADER_BYTES = 6;

        const unsigned DCCL_NUM_HEADER_PARTS = 8;

        enum DCCLHeaderPart { HEAD_CCL_ID = 0,
                              HEAD_DCCL_ID = 1,
                              HEAD_TIME = 2,
                              HEAD_SRC_ID = 3,
                              HEAD_DEST_ID = 4,
                              HEAD_MULTIMESSAGE_FLAG = 5,
                              HEAD_BROADCAST_FLAG = 6,
                              HEAD_UNUSED = 7
        };
    
        const std::string DCCL_HEADER_NAMES [] = { "_ccl_id",
                                                   "_id",
                                                   "_time",
                                                   "_src_id",
                                                   "_dest_id",
                                                   "_multimessage_flag",
                                                   "_broadcast_flag",
                                                   "_unused",
        };
        inline std::string to_str(DCCLHeaderPart p)
        {
            return DCCL_HEADER_NAMES[p];
        }

        
        enum DCCLHeaderBits { HEAD_CCL_ID_SIZE = 8,
                              HEAD_DCCL_ID_SIZE = 9,
                              HEAD_TIME_SIZE = 17,
                              HEAD_SRC_ID_SIZE = 5,
                              HEAD_DEST_ID_SIZE = 5,
                              HEAD_FLAG_SIZE = 1,
                              HEAD_UNUSED_SIZE = 2
        };


        
                
        
    }
}
#endif