torc::architecture::TileInfo Class Reference

Encapsulation of a tile within a device tile map. More...

#include <TileInfo.hpp>

Collaboration diagram for torc::architecture::TileInfo:

Public Member Functions
	TileInfo (void)
	Null constructor. More...
	~TileInfo (void)
	Non-virtual destructor. More...
const TileTypeIndex &	getTypeIndex (void) const
	Returns the tile type index for this tile. More...
const TileRow &	getRow (void) const
	Returns the row for this tile. More...
const TileCol &	getCol (void) const
	Returns the column for this tile. More...
const char *	getName (void) const
	Returns the name for this tile. More...

Protected Types
typedef boost::uint32_t	uint32_t
	Imported type name. More...
typedef boost::int32_t	int32_t
	Imported type name. More...
typedef xilinx::TileTypeIndex	TileTypeIndex
	Imported type name. More...
typedef xilinx::TileRow	TileRow
	Imported type name. More...
typedef xilinx::TileCol	TileCol
	Imported type name. More...

Protected Member Functions
void	set (const TileTypeIndex &inTypeIndex, const TileRow &inRow, const TileCol &inCol, const char *inName)
	Protected initializer intended for use by the Tiles class. More...
	TileInfo (const TileInfo &)
	Disabled copy constructor. More...

Protected Attributes
TileTypeIndex	mTypeIndex
	The tile type index for this tile. More...
TileRow	mRow
	The row for this tile. More...
TileCol	mCol
	The column for this tile. More...
const char *	mName
	The name for this tile. More...

Friends
class	Tiles
	The Tiles class has access to our protected members. More...
class	torc::architecture::architecture::TileInfoUnitTest
	Our unit test has direct access to our internals. More...
uint32_t	manhattanDistance (const TileInfo &inA, const TileInfo &inB)
	Returns the Manhattan distance between two tiles. More...

Detailed Description

Encapsulation of a tile within a device tile map.

Definition at line 33 of file TileInfo.hpp.

Member Typedef Documentation

typedef boost::int32_t torc::architecture::TileInfo::int32_t

protected

Imported type name.

Definition at line 42 of file TileInfo.hpp.

typedef xilinx::TileCol torc::architecture::TileInfo::TileCol

protected

Imported type name.

Definition at line 45 of file TileInfo.hpp.

typedef xilinx::TileRow torc::architecture::TileInfo::TileRow

protected

Imported type name.

Definition at line 44 of file TileInfo.hpp.

typedef xilinx::TileTypeIndex torc::architecture::TileInfo::TileTypeIndex

protected

Imported type name.

Definition at line 43 of file TileInfo.hpp.

typedef boost::uint32_t torc::architecture::TileInfo::uint32_t

protected

Imported type name.

Definition at line 41 of file TileInfo.hpp.

Constructor & Destructor Documentation

torc::architecture::TileInfo::TileInfo ( const TileInfo &  )

inlineprotected

Disabled copy constructor.

Definition at line 74 of file TileInfo.hpp.

: mTypeIndex(), mRow(), mCol(), mName(0) {}

torc::architecture::TileInfo::TileInfo ( void  )

inline

Null constructor.

Definition at line 78 of file TileInfo.hpp.

: mTypeIndex(), mRow(), mCol(), mName(0) {}

torc::architecture::TileInfo::~TileInfo ( void  )

inline

Non-virtual destructor.

Definition at line 80 of file TileInfo.hpp.

                        {
            // release the tile name if allocated
            if(mName != 0) { free(const_cast<char*>(mName)); mName = 0; }
        }

Member Function Documentation

const TileCol& torc::architecture::TileInfo::getCol ( void  ) const

inline

Returns the column for this tile.

Definition at line 96 of file TileInfo.hpp.

{ return mCol; }

Here is the caller graph for this function:

const char* torc::architecture::TileInfo::getName ( void  ) const

inline

Returns the name for this tile.

Definition at line 98 of file TileInfo.hpp.

{ return mName; }

Here is the caller graph for this function:

const TileRow& torc::architecture::TileInfo::getRow ( void  ) const

inline

Returns the row for this tile.

Definition at line 94 of file TileInfo.hpp.

{ return mRow; }

Here is the caller graph for this function:

const TileTypeIndex& torc::architecture::TileInfo::getTypeIndex ( void  ) const

inline

Returns the tile type index for this tile.

Definition at line 92 of file TileInfo.hpp.

{ return mTypeIndex; }

Here is the caller graph for this function:

void torc::architecture::TileInfo::set ( const TileTypeIndex &  inTypeIndex, const TileRow &  inRow, const TileCol &  inCol, const char *  inName  )

inlineprotected

Protected initializer intended for use by the Tiles class.

Parameters

inTypeIndex	The tile type index.
inRow	The tile row.
inCol	The tile column.
inName	The tile name.

Definition at line 61 of file TileInfo.hpp.

                                 {
            // release the current name if applicable
            if(mName != 0) { free(const_cast<char*>(mName)); mName = 0; }
            // make a private copy of the tile name
            mName = strdup(inName);
            // copy the remaining fields
            mTypeIndex = inTypeIndex;
            mRow = inRow;
            mCol = inCol;
        }

Here is the caller graph for this function:

Friends And Related Function Documentation

uint32_t manhattanDistance ( const TileInfo &  inA, const TileInfo &  inB  )

friend

Returns the Manhattan distance between two tiles.

Definition at line 86 of file TileInfo.hpp.

                                                                                    {
            return uint32_t(abs(int32_t(inA.mRow) - int32_t(inB.mRow))) 
                + uint32_t(abs(int32_t(inA.mCol) - int32_t(inB.mCol)));
        }

friend class Tiles

friend

The Tiles class has access to our protected members.

Definition at line 36 of file TileInfo.hpp.

friend class torc::architecture::architecture::TileInfoUnitTest

friend

Our unit test has direct access to our internals.

Definition at line 38 of file TileInfo.hpp.

Field Documentation

TileCol torc::architecture::TileInfo::mCol

protected

The column for this tile.

Definition at line 52 of file TileInfo.hpp.

const char* torc::architecture::TileInfo::mName

protected

The name for this tile.

Definition at line 54 of file TileInfo.hpp.

TileRow torc::architecture::TileInfo::mRow

protected

The row for this tile.

Definition at line 50 of file TileInfo.hpp.

TileTypeIndex torc::architecture::TileInfo::mTypeIndex

protected

The tile type index for this tile.

Definition at line 48 of file TileInfo.hpp.

---

The documentation for this class was generated from the following file:

• TileInfo.hpp