torc-master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
torc::bitstream::FrameSet< FRAME_TYPE > Class Template Reference

Set of contiguous frames. More...

#include <FrameSet.hpp>

+ Inheritance diagram for torc::bitstream::FrameSet< FRAME_TYPE >:
+ Collaboration diagram for torc::bitstream::FrameSet< FRAME_TYPE >:

Public Types

typedef FRAME_TYPE frame_t
 FrameSet frame type. More...
 
typedef FRAME_TYPE::word_t word_t
 FrameSet word type. More...
 
typedef boost::shared_ptr
< FRAME_TYPE > 
FrameSharedPtr
 Shared pointer encapsulation of a Frame. More...
 
typedef boost::shared_ptr
< VirtexFrameAddress
VirtexFarSharedPtr
 Shared pointer for frame addressing. More...
 
typedef boost::shared_array
< uint32_t
WordSharedArray
 Word shared array for frame words. More...
 

Public Member Functions

 FrameSet (void)
 Null constructor. More...
 
 FrameSet (uint32_t inFrameLength, uint32_t inFrameCount)
 
 FrameSet (uint32_t inFrameLength, uint32_t inFrameCount, WordSharedArray inWords, VirtexFrameAddress &inFar)
 

Protected Types

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

Detailed Description

template<class FRAME_TYPE>
class torc::bitstream::FrameSet< FRAME_TYPE >

Set of contiguous frames.

Definition at line 31 of file FrameSet.hpp.

Member Typedef Documentation

template<class FRAME_TYPE>
typedef FRAME_TYPE torc::bitstream::FrameSet< FRAME_TYPE >::frame_t

FrameSet frame type.

Definition at line 40 of file FrameSet.hpp.

template<class FRAME_TYPE>
typedef boost::shared_ptr<FRAME_TYPE> torc::bitstream::FrameSet< FRAME_TYPE >::FrameSharedPtr

Shared pointer encapsulation of a Frame.

Definition at line 44 of file FrameSet.hpp.

template<class FRAME_TYPE>
typedef boost::uint32_t torc::bitstream::FrameSet< FRAME_TYPE >::uint32_t
protected

Imported type name.

Definition at line 36 of file FrameSet.hpp.

template<class FRAME_TYPE>
typedef boost::shared_ptr<VirtexFrameAddress> torc::bitstream::FrameSet< FRAME_TYPE >::VirtexFarSharedPtr

Shared pointer for frame addressing.

Definition at line 46 of file FrameSet.hpp.

template<class FRAME_TYPE>
typedef FRAME_TYPE::word_t torc::bitstream::FrameSet< FRAME_TYPE >::word_t

FrameSet word type.

Definition at line 42 of file FrameSet.hpp.

template<class FRAME_TYPE>
typedef boost::shared_array<uint32_t> torc::bitstream::FrameSet< FRAME_TYPE >::WordSharedArray

Word shared array for frame words.

Definition at line 48 of file FrameSet.hpp.

Constructor & Destructor Documentation

template<class FRAME_TYPE>
torc::bitstream::FrameSet< FRAME_TYPE >::FrameSet ( void  )
inline

Null constructor.

Definition at line 51 of file FrameSet.hpp.

51 {}
template<class FRAME_TYPE>
torc::bitstream::FrameSet< FRAME_TYPE >::FrameSet ( uint32_t  inFrameLength,
uint32_t  inFrameCount 
)
inline

Definition at line 55 of file FrameSet.hpp.

55  {
56  for(uint32_t i = 0; i < inFrameCount; i++)
57  this->push_back(FrameSharedPtr(new FRAME_TYPE(inFrameLength)));
58  }
boost::shared_ptr< FRAME_TYPE > FrameSharedPtr
Shared pointer encapsulation of a Frame.
Definition: FrameSet.hpp:44
boost::uint32_t uint32_t
Imported type name.
Definition: FrameSet.hpp:36
template<class FRAME_TYPE>
torc::bitstream::FrameSet< FRAME_TYPE >::FrameSet ( uint32_t  inFrameLength,
uint32_t  inFrameCount,
WordSharedArray  inWords,
VirtexFrameAddress inFar 
)
inline

Definition at line 64 of file FrameSet.hpp.

65  {
66  VirtexFarSharedPtr farPtr = inFar;
67  for(uint32_t i = 0; i < inFrameCount; i++)
68  this->push_back(FrameSharedPtr(new FRAME_TYPE(inFrameLength,
69  &inWords[i*inFrameLength])));
70  }
boost::shared_ptr< FRAME_TYPE > FrameSharedPtr
Shared pointer encapsulation of a Frame.
Definition: FrameSet.hpp:44
boost::shared_ptr< VirtexFrameAddress > VirtexFarSharedPtr
Shared pointer for frame addressing.
Definition: FrameSet.hpp:46
boost::uint32_t uint32_t
Imported type name.
Definition: FrameSet.hpp:36

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