torc::architecture::Segments::SegmentReference Class Reference

Encapsulation of compact segment index and an anchoring tile index. More...

#include <Segments.hpp>

Collaboration diagram for torc::architecture::Segments::SegmentReference:

Public Member Functions
CompactSegmentIndex	getCompactSegmentIndex (void) const
TileIndex	getAnchorTileIndex (void) const
	SegmentReference (void)
	SegmentReference (CompactSegmentIndex inCompactSegmentIndex, TileIndex inAnchorTileIndex)
void	undefine (void)
bool	isDefined (void) const
bool	isTrivial (void) const

Static Public Member Functions
static const SegmentReference &	getTrivialSegment (void)

Static Public Attributes
static const SegmentReference	sTrivialSegmentReference

Private Attributes
CompactSegmentIndex	mCompactSegmentIndex
TileIndex	mAnchorTileIndex

Detailed Description

Encapsulation of compact segment index and an anchoring tile index.

Compact segments are normalized relative to tile index 0. The accompanying tile index serves as an anchor from which to derive a full segment description.

Definition at line 78 of file Segments.hpp.

Constructor & Destructor Documentation

torc::architecture::Segments::SegmentReference::SegmentReference ( void  )

inline

Definition at line 85 of file Segments.hpp.

: mCompactSegmentIndex(), mAnchorTileIndex() {}

torc::architecture::Segments::SegmentReference::SegmentReference ( CompactSegmentIndex  inCompactSegmentIndex, TileIndex  inAnchorTileIndex  )

inline

Definition at line 86 of file Segments.hpp.

                : mCompactSegmentIndex(inCompactSegmentIndex), mAnchorTileIndex(inAnchorTileIndex) 
                {}

Member Function Documentation

TileIndex torc::architecture::Segments::SegmentReference::getAnchorTileIndex ( void  ) const

inline

Definition at line 84 of file Segments.hpp.

{ return mAnchorTileIndex; }

Here is the caller graph for this function:

CompactSegmentIndex torc::architecture::Segments::SegmentReference::getCompactSegmentIndex ( void  ) const

inline

Definition at line 82 of file Segments.hpp.

                { return mCompactSegmentIndex; }

Here is the caller graph for this function:

static const SegmentReference& torc::architecture::Segments::SegmentReference::getTrivialSegment ( void  )

inlinestatic

Definition at line 95 of file Segments.hpp.

                { return sTrivialSegmentReference; }

bool torc::architecture::Segments::SegmentReference::isDefined ( void  ) const

inline

Definition at line 93 of file Segments.hpp.

{ return mCompactSegmentIndex != eSegmentUndefined; }

Here is the caller graph for this function:

bool torc::architecture::Segments::SegmentReference::isTrivial ( void  ) const

inline

Definition at line 94 of file Segments.hpp.

{ return mCompactSegmentIndex == eSegmentTrivial; }

Here is the caller graph for this function:

void torc::architecture::Segments::SegmentReference::undefine ( void  )

inline

Definition at line 89 of file Segments.hpp.

                                { 
                mCompactSegmentIndex = CompactSegmentIndex(eSegmentUndefined); 
                mAnchorTileIndex = TileIndex(eSegmentUndefined);
            }

Field Documentation

TileIndex torc::architecture::Segments::SegmentReference::mAnchorTileIndex

private

Definition at line 80 of file Segments.hpp.

CompactSegmentIndex torc::architecture::Segments::SegmentReference::mCompactSegmentIndex

private

Definition at line 79 of file Segments.hpp.

const Segments::SegmentReference torc::architecture::Segments::SegmentReference::sTrivialSegmentReference

static

Definition at line 97 of file Segments.hpp.

---

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

• Segments.hpp
• Segments.cpp