ldas-tools-framecpp 2.9.2
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
FrameC::FrChannel Struct Reference

#include <FrChanInternal.hh>

Inheritance diagram for FrameC::FrChannel:
Inheritance graph
[legend]
Collaboration diagram for FrameC::FrChannel:
Collaboration graph
[legend]

Classes

struct  channel_t
 

Public Types

typedef boost::shared_ptr< ::FrameCPP::FrVectvector_type
 
typedef boost::shared_ptr< ::FrameCPP::FrVect > const const_vector_type
 

Public Member Functions

 FrChannel ()
 
 FrChannel (const std::string &Name, fr_chan_type, fr_vect_data_types_t DataType, fr_vect_ndata_t NData)
 
 FrChannel (const std::string &Name, fr_proc_type Type, fr_proc_sub_type SubType, fr_vect_data_types_t DataType, fr_vect_ndata_t NData)
 
virtual ~FrChannel ()
 
void Read (::fr_file_t *Stream, const ::fr_chan_name_t Name, ::fr_chan_offset_t Offset)
 
const_vector_type Vector () const
 
vector_type Vector ()
 
vector_type Vector (fr_vect_data_types_t DataType, fr_vect_ndata_t NData)
 
template<class T >
boost::shared_ptr< T > Channel ()
 
enum fr_chan_type Type () const
 

Static Public Member Functions

::FrameCPP::FrVect::compression_scheme_type CompressionScheme (fr_vect_compression_schemes_t Scheme)
 
static fr_vect_compression_schemes_t CompressionScheme (::FrameCPP::FrVect::compress_type Scheme)
 
static void Register (FrameCError **Error, void *Pointer, pointer_type ExpectedType, framec_errno_type ErrorCode)
 
static void Free (FrameCError **Error, void *Pointer, pointer_type ExpectedType, framec_errno_type ErrorCode)
 
static void Deposit (const Handle *Ptr)
 
static void Validate (const Handle *Ptr, pointer_type Type)
 
static void Withdraw (const Handle *Ptr)
 

Private Types

typedef std::set< const Handle * > handle_container_type
 

Private Member Functions

friend void::FrameCFrChanQuery (FrameCError **Error, const fr_chan_t *Channel, int Options,...)
 
friend void::FrameCFrChanSet (FrameCError **Error, const fr_chan_t *Channel, int Options,...)
 

Private Attributes

struct FrameC::FrChannel::channel_t m_channel
 
const pointer_type m_type
 

Static Private Attributes

static LDASTools::AL::MutexLock::baton_type m_baton
 
static handle_container_type m_handles
 

Member Typedef Documentation

◆ const_vector_type

typedef boost::shared_ptr< ::FrameCPP::FrVect > const FrameC::FrChannel::const_vector_type

◆ handle_container_type

typedef std::set< const Handle* > FrameC::Handle::handle_container_type
privateinherited

◆ vector_type

typedef boost::shared_ptr< ::FrameCPP::FrVect > FrameC::FrChannel::vector_type

Constructor & Destructor Documentation

◆ FrChannel() [1/3]

FrameC::FrChannel::FrChannel ( )

◆ FrChannel() [2/3]

FrameC::FrChannel::FrChannel ( const std::string &  Name,
fr_chan_type  ChannelType,
fr_vect_data_types_t  DataType,
fr_vect_ndata_t  NData 
)

◆ FrChannel() [3/3]

FrameC::FrChannel::FrChannel ( const std::string &  Name,
fr_proc_type  Type,
fr_proc_sub_type  SubType,
fr_vect_data_types_t  DataType,
fr_vect_ndata_t  NData 
)

◆ ~FrChannel()

FrameC::FrChannel::~FrChannel ( )
virtual

Member Function Documentation

◆ Channel()

template<class T >
boost::shared_ptr< T > FrameC::FrChannel::Channel ( )
inline

◆ CompressionScheme() [1/2]

fr_vect_compression_schemes_t FrameC::FrChannel::CompressionScheme ( ::FrameCPP::FrVect::compress_type  Scheme)
inlinestatic

◆ CompressionScheme() [2/2]

FrameCPP::FrVect::compression_scheme_type FrameC::FrChannel::CompressionScheme ( fr_vect_compression_schemes_t  Scheme)
inlinestatic

◆ Deposit()

void FrameC::Handle::Deposit ( const Handle Ptr)
staticinherited

◆ Free()

void FrameC::Handle::Free ( FrameCError **  Error,
void *  Pointer,
pointer_type  ExpectedType,
framec_errno_type  ErrorCode 
)
staticinherited

◆ Read()

void FrameC::FrChannel::Read ( ::fr_file_t Stream,
const ::fr_chan_name_t  Name,
::fr_chan_offset_t  Offset 
)
inline

◆ Register()

static void FrameC::Handle::Register ( FrameCError **  Error,
void *  Pointer,
pointer_type  ExpectedType,
framec_errno_type  ErrorCode 
)
staticinherited

◆ Type()

enum fr_chan_type FrameC::FrChannel::Type ( ) const
inline

◆ Validate()

void FrameC::Handle::Validate ( const Handle Ptr,
pointer_type  Type 
)
staticinherited

◆ Vector() [1/3]

vector_type FrameC::FrChannel::Vector ( )
inline

◆ Vector() [2/3]

const_vector_type FrameC::FrChannel::Vector ( ) const
inline

◆ Vector() [3/3]

vector_type FrameC::FrChannel::Vector ( fr_vect_data_types_t  DataType,
fr_vect_ndata_t  NData 
)
inline

◆ void::FrameCFrChanQuery()

FrameC::FrChannel::void::FrameCFrChanQuery ( FrameCError **  Error,
const fr_chan_t Channel,
int  Options,
  ... 
)
private

◆ void::FrameCFrChanSet()

FrameC::FrChannel::void::FrameCFrChanSet ( FrameCError **  Error,
const fr_chan_t Channel,
int  Options,
  ... 
)
private

◆ Withdraw()

void FrameC::Handle::Withdraw ( const Handle Ptr)
staticinherited

Member Data Documentation

◆ m_baton

MutexLock::baton_type FrameC::Handle::m_baton
staticprivateinherited

◆ m_channel

struct FrameC::FrChannel::channel_t FrameC::FrChannel::m_channel
private

◆ m_handles

Handle::handle_container_type FrameC::Handle::m_handles
staticprivateinherited

◆ m_type

const pointer_type FrameC::Handle::m_type
privateinherited

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