oaNetTermArrayBase Class Template Reference

Inheritance diagram for oaNetTermArrayBase:

oaModNetTermArray oaModNetTermNameArray oaModNetTermPosArray oaNetTermArray oaNetTermNameArray oaNetTermPosArray


Public Methods

 oaNetTermArrayBase (oaUInt4 size)
void append (const NetType &net, const TermType &term)
oaUInt4 getNumElements () const
void setNumElements (oaUInt4 numElements)
oaUInt4 getSize () const
const oaNetTermPair< NetType, TermType > & get (oaUInt4 index) const
oaNetTermPair< NetType, TermType > & get (oaUInt4 index)
const oaNetTermPair< NetType, TermType > & operator[] (oaUInt4 index) const
oaNetTermPair< NetType, TermType > & operator[] (oaUInt4 index)
oaUInt4 getNumBits () const
oaUInt4 getNumMultiBit () const

Public Types

typedef oaNetTermPair< NetType, TermType > NetTermPair

Detailed Description

template<class NetType, class TermType>
class oaNetTermArrayBase< NetType, TermType >

This class implements a template for an array of elements. The size of the array can be different than the number of elements actually stored. This is useful in situations where the array is used as a buffer because the need to re-allocate the array is reduced.


Member Typedef Documentation

template<class NetType, class TermType>
typedef oaNetTermPair<NetType, TermType> oaNetTermArrayBase< NetType, TermType >::NetTermPair
 


Constructor & Destructor Documentation

template<class NetType, class TermType>
oaNetTermArrayBase< NetType, TermType >::oaNetTermArrayBase oaUInt4    size [inline]
 

This is the constructor for the oaNetTermArrayBase class.

Parameters:
size An integer value indicating the initial size of the array.


Member Function Documentation

template<class NetType, class TermType>
void oaNetTermArrayBase< NetType, TermType >::append const NetType &    net,
const TermType &    term
[inline]
 

This function appends the given net and term pair to the end of the array.

Parameters:
net The net to append to the array.
term The term to append to the array.

template<class NetType, class TermType>
NetTermPair & oaNetTermArrayBase< NetType, TermType >::get oaUInt4    index [inline]
 

This function returns the element at the given index of the array.

Parameters:
index The index value of the element to return.

template<class NetType, class TermType>
const NetTermPair & oaNetTermArrayBase< NetType, TermType >::get oaUInt4    index const [inline]
 

This function returns the element at the given index of the array as a constant.

Parameters:
index The index value of the element to return.

template<class NetType, class TermType>
oaUInt4 oaNetTermArrayBase< NetType, TermType >::getNumBits   const
 

This function returns the total number of bits in the elements of the array.

template<class NetType, class TermType>
oaUInt4 oaNetTermArrayBase< NetType, TermType >::getNumElements   const [inline]
 

This function returns the number of elements in the array.

template<class NetType, class TermType>
oaUInt4 oaNetTermArrayBase< NetType, TermType >::getNumMultiBit   const
 

This function returns the number of multi-bit terms in the elements array.

template<class NetType, class TermType>
oaUInt4 oaNetTermArrayBase< NetType, TermType >::getSize   const [inline]
 

This function returns the size of the array.

template<class NetType, class TermType>
NetTermPair & oaNetTermArrayBase< NetType, TermType >::operator[] oaUInt4    index [inline]
 

This function returns the element at the given index of the array.

Parameters:
index The index for the array element to return.

template<class NetType, class TermType>
const NetTermPair & oaNetTermArrayBase< NetType, TermType >::operator[] oaUInt4    index const [inline]
 

This function returns the element at the given index of the array as a constant.

Parameters:
index The index value of the element to return.

template<class NetType, class TermType>
void oaNetTermArrayBase< NetType, TermType >::setNumElements oaUInt4    numElements [inline]
 

This function sets the number of elements in the array.

Parameters:
numElements The number of array elements.


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

Return to top of page