torc-master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
torc::architecture::WireArray Class Reference

Array of wire indexes. More...

#include <WireInfo.hpp>

+ Inheritance diagram for torc::architecture::WireArray:
+ Collaboration diagram for torc::architecture::WireArray:

Public Types

typedef const const
xilinx::WireIndex
const_iterator
 Constant T iterator type. More...
 
typedef const xilinx::WireIndexiterator
 Non-constant T iterator type. More...
 

Public Member Functions

const xilinx::WireIndexbegin (void)
 Returns the non-constant begin iterator. More...
 
const const xilinx::WireIndexbegin (void) const
 Returns the constant begin iterator. More...
 
const xilinx::WireIndexend (void)
 Returns the non-constant end iterator. More...
 
const const xilinx::WireIndexend (void) const
 Returns the constant end iterator. More...
 
uint32_t getSize (void) const
 Returns the array size. More...
 
void setSize (uint32_t inSize)
 Discards all contents and resizes the array. More...
 
const xilinx::WireIndexoperator[] (uint32_t inIndex)
 Non-constant subscript operator. More...
 
const const xilinx::WireIndexoperator[] (uint32_t inIndex) const
 Constant subscript operator. More...
 

Protected Types

typedef boost::uint32_t uint32_t
 Imported type name. More...
 
typedef boost::remove_const
< const xilinx::WireIndex >
::type 
T_non_const
 A type identical to template parameter T, but with any 'const' trait removed. More...
 

Protected Attributes

const xilinx::WireIndexmArray
 The internal array. More...
 
uint32_t mSize
 The logical and actual size of the array. More...
 

Detailed Description

Array of wire indexes.

Definition at line 31 of file WireInfo.hpp.

Member Typedef Documentation

Constant T iterator type.

Definition at line 83 of file Array.hpp.

Non-constant T iterator type.

Definition at line 85 of file Array.hpp.

typedef boost::remove_const<const xilinx::WireIndex >::type torc::architecture::Array< const xilinx::WireIndex >::T_non_const
protectedinherited

A type identical to template parameter T, but with any 'const' trait removed.

Definition at line 45 of file Array.hpp.

typedef boost::uint32_t torc::architecture::Array< const xilinx::WireIndex >::uint32_t
protectedinherited

Imported type name.

Definition at line 43 of file Array.hpp.

Member Function Documentation

const xilinx::WireIndex * torc::architecture::Array< const xilinx::WireIndex >::begin ( void  )
inlineinherited

Returns the non-constant begin iterator.

Definition at line 95 of file Array.hpp.

95 { return mArray; }
const xilinx::WireIndex * mArray
The internal array.
Definition: Array.hpp:48
const const xilinx::WireIndex * torc::architecture::Array< const xilinx::WireIndex >::begin ( void  ) const
inlineinherited

Returns the constant begin iterator.

Definition at line 99 of file Array.hpp.

99 { return mArray; }
const xilinx::WireIndex * mArray
The internal array.
Definition: Array.hpp:48
const xilinx::WireIndex * torc::architecture::Array< const xilinx::WireIndex >::end ( void  )
inlineinherited

Returns the non-constant end iterator.

Definition at line 97 of file Array.hpp.

97 { return mArray + mSize; }
const xilinx::WireIndex * mArray
The internal array.
Definition: Array.hpp:48
uint32_t mSize
The logical and actual size of the array.
Definition: Array.hpp:50
const const xilinx::WireIndex * torc::architecture::Array< const xilinx::WireIndex >::end ( void  ) const
inlineinherited

Returns the constant end iterator.

Definition at line 101 of file Array.hpp.

101 { return mArray + mSize; }
const xilinx::WireIndex * mArray
The internal array.
Definition: Array.hpp:48
uint32_t mSize
The logical and actual size of the array.
Definition: Array.hpp:50
uint32_t torc::architecture::Array< const xilinx::WireIndex >::getSize ( void  ) const
inlineinherited

Returns the array size.

Definition at line 104 of file Array.hpp.

104 { return mSize; }
uint32_t mSize
The logical and actual size of the array.
Definition: Array.hpp:50
const xilinx::WireIndex & torc::architecture::Array< const xilinx::WireIndex >::operator[] ( uint32_t  inIndex)
inlineinherited

Non-constant subscript operator.

Definition at line 110 of file Array.hpp.

110  {
111  enforceBounds(inIndex);
112  return mArray[inIndex];
113  }
#define enforceBounds(index)
Enforce array bounds if so requested.
Definition: Array.hpp:78
const xilinx::WireIndex * mArray
The internal array.
Definition: Array.hpp:48
const const xilinx::WireIndex & torc::architecture::Array< const xilinx::WireIndex >::operator[] ( uint32_t  inIndex) const
inlineinherited

Constant subscript operator.

Definition at line 115 of file Array.hpp.

115  {
116  enforceBounds(inIndex);
117  return mArray[inIndex];
118  }
#define enforceBounds(index)
Enforce array bounds if so requested.
Definition: Array.hpp:78
const xilinx::WireIndex * mArray
The internal array.
Definition: Array.hpp:48
void torc::architecture::Array< const xilinx::WireIndex >::setSize ( uint32_t  inSize)
inlineinherited

Discards all contents and resizes the array.

Definition at line 107 of file Array.hpp.

107 { allocate(inSize); }
void allocate(uint32_t inSize)
Allocate an array of the specified size.
Definition: Array.hpp:53

Field Documentation

const xilinx::WireIndex * torc::architecture::Array< const xilinx::WireIndex >::mArray
protectedinherited

The internal array.

Definition at line 48 of file Array.hpp.

uint32_t torc::architecture::Array< const xilinx::WireIndex >::mSize
protectedinherited

The logical and actual size of the array.

Definition at line 50 of file Array.hpp.


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