File content as of revision 142:85b71cfd617e:

/******************************************************************//**
* Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* Except as contained in this notice, the name of Maxim Integrated
* Products, Inc. shall not be used except as stated in the Maxim Integrated
* Products, Inc. Branding Policy.
*
* The mere transfer of this software does not imply any licenses
* of trade secrets, proprietary technology, copyrights, patents,
* trademarks, maskwork rights, or any other form of intellectual
* property whatsoever. Maxim Integrated Products, Inc. retains all
* ownership rights.
**********************************************************************/

#ifndef OneWire_RomId
#define OneWire_RomId

#include "Utilities/array.h"
#include "Utilities/crc.h"

namespace OneWire
{
    /// Standard container for a 1-Wire ROM ID.
    struct RomId
    {
        typedef array<uint8_t, 8> Buffer;
    
        /// Direct access to the buffer.
        Buffer buffer;
        /// @}

        /// @{
        /// Access the Family Code byte.
        uint8_t & familyCode() { return buffer.front(); }
        const uint8_t & familyCode() const { return buffer.front(); }
        /// @}

        /// @{
        /// Access the CRC8 byte.
        uint8_t & crc8() { return buffer.back(); }
        const uint8_t & crc8() const { return buffer.back(); }
        /// @}

        /// Check if the ROM ID is valid (Family Code and CRC8 are both valid).
        /// @returns True if the ROM ID is valid.
        bool valid() const
        {
            return crc::calculateCrc8(buffer.data(), buffer.size() - 1, 0x00) == crc8();
        }
        
        bool operator==(const RomId & rhs) const { return (this->buffer == rhs.buffer); }
        bool operator!=(const RomId & rhs) const { return !operator==(rhs); }
    };
}

#endif