torc::bitstream::Frame< WORD_TYPE > Class Template Reference

Bitstream frame. More...

#include <Frame.hpp>

Public Types
typedef WORD_TYPE	word_t
	Frame word type. More...

Public Member Functions
	Frame (uint32_t inLength, word_t *inWords=0)
	Basic constructor. More...
	~Frame (void)
uint32_t	getLength (void) const
	Returns the length of the frame in words. More...
const word_t *	getWords (void) const
	Returns a const raw word pointer. More...
bool	isUsed (void) const
	Returns a non-const raw word pointer. More...
bool	isDirty (void) const
	Returns true if the frame has been modified, or false otherwise. More...
void	setUsed (bool inIsUsed=true)
	Marks the frame used or unused, and if unused automatically marks it clean. More...
void	setDirty (bool inIsDirty=true)
	Marks the frame dirty or clean, and if dirty automatically marks it used. More...
word_t	operator[] (int index)
	Returns the specified frame word, or 0 if out of bounds. More...
void	setWord (int index, word_t inWord)
	Sets the value of the specified frame word. More...

Protected Types
typedef boost::uint32_t	uint32_t
	Imported type name. More...

Protected Attributes
bool	mIsUsed
	Flag to indicate whether the frame is in use. More...
bool	mIsDirty
	Flag to indicate whether the frame has been modified. More...
uint32_t	mLength
	Frame length in words. More...
WORD_TYPE *	mWords
	Array of frame words. More...

Detailed Description

template<typename WORD_TYPE>
class torc::bitstream::Frame< WORD_TYPE >

Bitstream frame.

Definition at line 31 of file Frame.hpp.

Member Typedef Documentation

template<typename WORD_TYPE >

typedef boost::uint32_t torc::bitstream::Frame< WORD_TYPE >::uint32_t

protected

Imported type name.

Definition at line 35 of file Frame.hpp.

template<typename WORD_TYPE >

typedef WORD_TYPE torc::bitstream::Frame< WORD_TYPE >::word_t

Frame word type.

Definition at line 48 of file Frame.hpp.

Constructor & Destructor Documentation

template<typename WORD_TYPE >

torc::bitstream::Frame< WORD_TYPE >::Frame ( uint32_t  inLength, word_t *  inWords = 0  )

inline

Basic constructor.

Definition at line 51 of file Frame.hpp.

                                                      : mIsUsed(true), mIsDirty(false), 
            mLength(inLength) {
            if(inWords && inLength) {
                mWords = new word_t[inLength];
                word_t* p = mWords;
                for(uint32_t i = 0; i < inLength; i++) *p++ = *inWords++;
            } else {
                mWords = 0;
            }
        }

template<typename WORD_TYPE >

torc::bitstream::Frame< WORD_TYPE >::~Frame ( void  )

inline

Definition at line 61 of file Frame.hpp.

                     {
            if(mWords) delete mWords;
            mWords = 0;
        }

Member Function Documentation

template<typename WORD_TYPE >

uint32_t torc::bitstream::Frame< WORD_TYPE >::getLength ( void  ) const

inline

Returns the length of the frame in words.

Definition at line 67 of file Frame.hpp.

{ return mLength; }

Here is the caller graph for this function:

template<typename WORD_TYPE >

const word_t* torc::bitstream::Frame< WORD_TYPE >::getWords ( void  ) const

inline

Returns a const raw word pointer.

Definition at line 69 of file Frame.hpp.

{ return mWords; }

Here is the caller graph for this function:

template<typename WORD_TYPE >

bool torc::bitstream::Frame< WORD_TYPE >::isDirty ( void  ) const

inline

Returns true if the frame has been modified, or false otherwise.

Definition at line 75 of file Frame.hpp.

{ return mIsDirty; }

Here is the caller graph for this function:

template<typename WORD_TYPE >

bool torc::bitstream::Frame< WORD_TYPE >::isUsed ( void  ) const

inline

Returns a non-const raw word pointer.

Returns true if the frame is in use in the bitstream, or false otherwise.

Definition at line 73 of file Frame.hpp.

{ return mIsUsed; }

Here is the caller graph for this function:

template<typename WORD_TYPE >

word_t torc::bitstream::Frame< WORD_TYPE >::operator[] ( int  index )

inline

Returns the specified frame word, or 0 if out of bounds.

Definition at line 81 of file Frame.hpp.

                                      {
            if(mWords == 0 || index < 0 || static_cast<uint32_t>(index) >= mLength) return 0;
            return mWords[index];
        }

template<typename WORD_TYPE >

void torc::bitstream::Frame< WORD_TYPE >::setDirty ( bool  inIsDirty = true )

inline

Marks the frame dirty or clean, and if dirty automatically marks it used.

Definition at line 79 of file Frame.hpp.

{ mIsDirty = inIsDirty; if(mIsDirty) mIsUsed = true; }

Here is the caller graph for this function:

template<typename WORD_TYPE >

void torc::bitstream::Frame< WORD_TYPE >::setUsed ( bool  inIsUsed = true )

inline

Marks the frame used or unused, and if unused automatically marks it clean.

Definition at line 77 of file Frame.hpp.

{ mIsUsed = inIsUsed; if(!mIsUsed) mIsDirty = false; }

template<typename WORD_TYPE >

void torc::bitstream::Frame< WORD_TYPE >::setWord ( int  index, word_t  inWord  )

inline

Sets the value of the specified frame word.

Definition at line 86 of file Frame.hpp.

                                               {
            // do nothing if the index is out of bounds
            if(index < 0 || static_cast<uint32_t>(index) >= mLength) return;
            // allocate and zero out the words if they were previously unallocated
            if(mWords == 0) {
                mWords = new word_t[mLength];
                word_t* p = mWords;
                for(uint32_t i = 0; i < mLength; i++) *p++ = 0;
                setDirty();
            }
            // if the new value is different, update the word and mark the frame dirty
            if(mWords[index] != inWord) {
                mWords[index] = inWord;
                setDirty();
            }
        }

Here is the call graph for this function:

Field Documentation

template<typename WORD_TYPE >

bool torc::bitstream::Frame< WORD_TYPE >::mIsDirty

protected

Flag to indicate whether the frame has been modified.

Definition at line 40 of file Frame.hpp.

template<typename WORD_TYPE >

bool torc::bitstream::Frame< WORD_TYPE >::mIsUsed

protected

Flag to indicate whether the frame is in use.

Definition at line 38 of file Frame.hpp.

template<typename WORD_TYPE >

uint32_t torc::bitstream::Frame< WORD_TYPE >::mLength

protected

Frame length in words.

Definition at line 42 of file Frame.hpp.

template<typename WORD_TYPE >

WORD_TYPE* torc::bitstream::Frame< WORD_TYPE >::mWords

protected

Array of frame words.

Definition at line 44 of file Frame.hpp.

---

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

• Frame.hpp