V5AddressLayout.hpp

Go to the documentation of this file.

#pragma once
#ifndef BIL_V5ADDRESSLAYOUT_HPP
#define BIL_V5ADDRESSLAYOUT_HPP

#include <configuration/V5CfgBlock.hpp>
#include <configuration/V5CfgColumn.hpp>
#include <serialization/V5AddressLayoutBS.hpp>


namespace bil {

    class V5AddressLayout {
    public:

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

        V5AddressLayout();

        V5AddressLayout(unsigned upperRowCount, unsigned lowerRowCount, const V5CfgColumnSequence& columnSequence);


        /**********************************************************************/
        /* UPPER ROW COUNT                                                    */
        /**********************************************************************/

        static const unsigned ROWCOUNT_MAX = 31;

        void upperRowCount(unsigned count);

        unsigned upperRowCount() const;


        /**********************************************************************/
        /* LOWER ROW COUNT                                                    */
        /**********************************************************************/

        void lowerRowCount(unsigned count);

        unsigned lowerRowCount() const;


        /**********************************************************************/
        /* COLUMN SEQUENCE                                                    */
        /**********************************************************************/

        static const unsigned COLUMNCOUNT_MAX = 255;

        void columnSequence(const V5CfgColumnSequence& columns);

        const V5CfgColumnSequence& columnSequence() const;


        /**********************************************************************/
        /* QUERY FUNCTIONS                                                    */
        /**********************************************************************/

        unsigned rowCount(bool lowerHalf) const;

        unsigned columnCount(V5CfgBlock::block_t block) const;

        unsigned frameCount(V5CfgBlock::block_t block, V5CfgColumn::column_t column) const;

        V5CfgColumn::column_t columnType(V5CfgBlock::block_t block, size_t columnIndex) const;


    protected:

        unsigned countBRAMs(const V5CfgColumnSequence& columns) const;


    private:

        friend bool operator== (const V5AddressLayout& al1, const V5AddressLayout& al2);

        friend void writeBinary(const V5AddressLayout& data, std::ostream& outputStream);
        friend void readBinary(V5AddressLayout& data, std::istream& inputStream);


        unsigned m_upperRowCount;
        unsigned m_lowerRowCount;
        V5CfgColumnSequence m_columns;
        unsigned m_bramCount;

    };


    inline bool operator== (const V5AddressLayout& al1, const V5AddressLayout& al2)
    {
        if (al1.m_upperRowCount != al2.m_upperRowCount) return false;
        if (al1.m_lowerRowCount != al2.m_lowerRowCount) return false;
        if (al1.m_bramCount != al2.m_bramCount) return false;
        return al1.m_columns == al2.m_columns;
    }

    inline bool operator!= (const V5AddressLayout& al1, const V5AddressLayout& al2)
    {
        return !(operator== (al1, al2));
    }

}

#endif