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

Bitstream frame. More...

#include <Frame.hpp>

Collaboration diagram for torc::bitstream::Frame< WORD_TYPE >:

[legend]

List of all members.

Public Types
typedef WORD_TYPE	word_t
	Frame word type.
Public Member Functions
	Frame (uint32_t inLength, word_t *inWords=0)
	Basic constructor.
void	touch (void)
	Touch the frame by marking it dirty.
uint32_t	getLength (void) const
	Returns the length of the frame in words.
const word_t *	getWords (void) const
	Returns a const raw word pointer.
bool	isUsed (void) const
	Returns a non-const raw word pointer.
bool	isDirty (void) const
	Returns true if the frame has been modified, or false otherwise.
word_t	operator[] (int index)
	Returns the specified frame word, or 0 if out of bounds.
void	setWord (int index, int inWord)
	Sets the value of the specified frame word.
void	setWords (int inWord)
	Sets the value of the specified frame words.
Protected Types
typedef boost::uint32_t	uint32_t
	Imported type name.
Protected Attributes
bool	mIsUsed
	Flag to indicate whether the frame is in use.
bool	mIsDirty
	Flag to indicate whether the frame has been modified.
uint32_t	mLength
	Frame length in words.
WORD_TYPE *	mWords
	Array of frame words.

---

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.

---

Member Function Documentation

template<typename WORD_TYPE>

void torc::bitstream::Frame< WORD_TYPE >::touch

(

void

)

[inline]

Touch the frame by marking it dirty.

WARNING: This is a temporary convenience function that will not be retained.

Definition at line 68 of file Frame.hpp.

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 71 of file Frame.hpp.

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 73 of file Frame.hpp.

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 77 of file Frame.hpp.

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 79 of file Frame.hpp.

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.

template<typename WORD_TYPE>

void torc::bitstream::Frame< WORD_TYPE >::setWord	(	int	index,
		int	inWord
	)			[inline]

Sets the value of the specified frame word.

Definition at line 86 of file Frame.hpp.

template<typename WORD_TYPE>

void torc::bitstream::Frame< WORD_TYPE >::setWords

(

int

inWord

)

[inline]

Sets the value of the specified frame words.

Definition at line 100 of file Frame.hpp.

---

Member Data Documentation

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>

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>

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:

• torc/bitstream/Frame.hpp