V5FrameAddress.hpp

Go to the documentation of this file.

#pragma once
#ifndef BIL_V5FRAMEADDRESS_HPP
#define BIL_V5FRAMEADDRESS_HPP

#include <boost/cstdint.hpp>
#include <configuration/V5AddressLayout.hpp>
#include <configuration/V5CfgBlock.hpp>
#include <configuration/V5CfgColumn.hpp>


namespace bil {

    class V5FrameAddress {
    public:

        /**********************************************************************/
        /* CONSTRUCTION / DESTRUCTION                                         */
        /**********************************************************************/

        V5FrameAddress();

        explicit V5FrameAddress(const V5AddressLayout* layout);


        /**********************************************************************/
        /* CONFIGURATION WITH ADDRESS LAYOUT                                  */
        /**********************************************************************/

        void addressLayout(const V5AddressLayout* layout);

        const V5AddressLayout* addressLayout() const;


        /**********************************************************************/
        /* BLOCK                                                              */
        /**********************************************************************/

        static const unsigned BLOCK_MAX = 7;

        void block(V5CfgBlock::block_t block);

        V5CfgBlock::block_t block() const;


        /**********************************************************************/
        /* LOWER/UPPER HALF                                                   */
        /**********************************************************************/

        void lowerHalf(bool lower);

        bool lowerHalf() const;


        /**********************************************************************/
        /* ROW INDEX                                                          */
        /**********************************************************************/

        static const unsigned ROWINDEX_MAX = V5AddressLayout::ROWCOUNT_MAX - 1;

        void rowIndex(unsigned char ri);

        unsigned char rowIndex() const;


        /**********************************************************************/
        /* COLUMN INDEX                                                       */
        /**********************************************************************/

        static const unsigned COLUMNINDEX_MAX = V5AddressLayout::COLUMNCOUNT_MAX - 1;

        void columnIndex(unsigned char ci);

        unsigned char columnIndex() const;


        /**********************************************************************/
        /* FRAME INDEX                                                        */
        /**********************************************************************/

        static const unsigned FRAMEINDEX_MAX = 127;

        void frameIndex(unsigned char fi);

        unsigned char frameIndex() const;


        /**********************************************************************/
        /* ADDRESS ITERATION                                                  */
        /**********************************************************************/

        void first();

        void last();

        bool next();


        /**********************************************************************/
        /* VALIDITY                                                           */
        /**********************************************************************/

        bool isValid() const;


        /**********************************************************************/
        /* ADDRESS TARGET COLUMN TYPE                                         */
        /**********************************************************************/

        V5CfgColumn::column_t columnType() const;


        /**********************************************************************/
        /* RAW ADDRESS                                                        */
        /**********************************************************************/

        void rawAddress(boost::uint32_t ra);

        boost::uint32_t rawAddress() const;


    private:

        friend bool operator== (const V5FrameAddress& fa1, const V5FrameAddress& fa2);
        friend bool operator< (const V5FrameAddress& fa1, const V5FrameAddress& fa2);


        const V5AddressLayout* m_addressLayout;

        V5CfgBlock::block_t m_block;
        bool m_lowerHalf;
        unsigned char m_rowIndex;
        unsigned char m_columnIndex;
        unsigned char m_frameIndex;

    };


    inline bool operator== (const V5FrameAddress& fa1, const V5FrameAddress& fa2)
    {
        if (fa1.m_block != fa2.m_block) return false;
        if (fa1.m_lowerHalf != fa2.m_lowerHalf) return false;
        if (fa1.m_rowIndex != fa2.m_rowIndex) return false;
        if (fa1.m_columnIndex != fa2.m_columnIndex) return false;
        return fa1.m_frameIndex == fa2.m_frameIndex;
    }

    inline bool operator!= (const V5FrameAddress& fa1, const V5FrameAddress& fa2)
    {
        return !(operator== (fa1, fa2));
    }


    inline bool operator< (const V5FrameAddress& fa1, const V5FrameAddress& fa2)
    {
        if (fa1.m_block != fa2.m_block) return fa1.m_block < fa2.m_block;
        if (fa1.m_lowerHalf != fa2.m_lowerHalf) return fa2.m_lowerHalf;
        if (fa1.m_rowIndex != fa2.m_rowIndex) return fa1.m_rowIndex < fa2.m_rowIndex;
        if (fa1.m_columnIndex != fa2.m_columnIndex) return fa1.m_columnIndex < fa2.m_columnIndex;
        return fa1.m_frameIndex < fa2.m_frameIndex;
    }

    inline bool operator> (const V5FrameAddress& fa1, const V5FrameAddress& fa2)
    {
        return (operator< (fa2, fa1));
    }

    inline bool operator<= (const V5FrameAddress& fa1, const V5FrameAddress& fa2)
    {
        return !(operator> (fa1, fa2));
    }

    inline bool operator>= (const V5FrameAddress& fa1, const V5FrameAddress& fa2)
    {
        return !(operator< (fa1, fa2));
    }

}

#endif