ldas-tools-frameAPI  2.6.6
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
FrameAPI::Channel Class Referenceabstract

Generic wrapper for channel information. More...

#include <Channel.hh>

Inheritance diagram for FrameAPI::Channel:
Inheritance graph
[legend]

Public Types

typedef CHANNEL_NAME_TYPE name_type
 
typedef CHANNEL_DATA_TYPE data_type
 
typedef boost::shared_array< ::FrameCPP::Dimension::dx_type > dx_type
 
typedef boost::shared_array< ::FrameCPP::Dimension::nx_type > nx_type
 
typedef boost::shared_array< ::FrameCPP::Dimension::startX_type > startX_type
 
typedef boost::shared_array< ::FrameCPP::Dimension::unitX_type > unitX_type
 
typedef CHANNEL_UNIT_Y_TYPE unitY_type
 
typedef CHANNEL_NAME_TYPE name_type
 
typedef CHANNEL_DATA_TYPE data_type
 
typedef boost::shared_array< ::FrameCPP::Dimension::dx_type > dx_type
 
typedef boost::shared_array< ::FrameCPP::Dimension::nx_type > nx_type
 
typedef boost::shared_array< ::FrameCPP::Dimension::startX_type > startX_type
 
typedef boost::shared_array< ::FrameCPP::Dimension::unitX_type > unitX_type
 
typedef CHANNEL_UNIT_Y_TYPE unitY_type
 
typedef CHANNEL_NAME_TYPE name_type
 
typedef CHANNEL_DATA_TYPE data_type
 
typedef boost::shared_array< ::FrameCPP::Dimension::dx_type > dx_type
 
typedef boost::shared_array< ::FrameCPP::Dimension::nx_type > nx_type
 
typedef boost::shared_array< ::FrameCPP::Dimension::startX_type > startX_type
 
typedef boost::shared_array< ::FrameCPP::Dimension::unitX_type > unitX_type
 
typedef CHANNEL_UNIT_Y_TYPE unitY_type
 

Public Member Functions

 Channel ()
 
virtual ~Channel ()
 
dx_type GetDx () const
 
name_type GetName () const
 
nx_type GetNx () const
 
startX_type GetStartX () const
 
unitX_type GetUnitX () const
 
unitY_type GetUnitY () const
 
virtual data_typeRefData () const =0
 
 Channel ()
 
virtual ~Channel ()
 
dx_type GetDx () const
 
name_type GetName () const
 
nx_type GetNx () const
 
startX_type GetStartX () const
 
unitX_type GetUnitX () const
 
unitY_type GetUnitY () const
 
virtual data_typeRefData () const =0
 
 Channel ()
 
virtual ~Channel ()
 
dx_type GetDx () const
 
name_type GetName () const
 
nx_type GetNx () const
 
startX_type GetStartX () const
 
unitX_type GetUnitX () const
 
unitY_type GetUnitY () const
 
virtual data_typeRefData () const =0
 

Private Member Functions

data_typeseed () const
 
data_typeseed () const
 
data_typeseed () const
 

Private Attributes

dx_type m_dx
 
name_type name
 
nx_type m_nx
 
startX_type m_startX
 
unitX_type m_unitX
 

Detailed Description

Generic wrapper for channel information.

Member Typedef Documentation

◆ data_type [1/3]

◆ data_type [2/3]

◆ data_type [3/3]

◆ dx_type [1/3]

typedef boost::shared_array< ::FrameCPP::Dimension::dx_type > FrameAPI::Channel::dx_type

◆ dx_type [2/3]

typedef boost::shared_array< ::FrameCPP::Dimension::dx_type > FrameAPI::Channel::dx_type

◆ dx_type [3/3]

typedef boost::shared_array< ::FrameCPP::Dimension::dx_type > FrameAPI::Channel::dx_type

◆ name_type [1/3]

◆ name_type [2/3]

◆ name_type [3/3]

◆ nx_type [1/3]

typedef boost::shared_array< ::FrameCPP::Dimension::nx_type > FrameAPI::Channel::nx_type

◆ nx_type [2/3]

typedef boost::shared_array< ::FrameCPP::Dimension::nx_type > FrameAPI::Channel::nx_type

◆ nx_type [3/3]

typedef boost::shared_array< ::FrameCPP::Dimension::nx_type > FrameAPI::Channel::nx_type

◆ startX_type [1/3]

typedef boost::shared_array< ::FrameCPP::Dimension::startX_type > FrameAPI::Channel::startX_type

◆ startX_type [2/3]

typedef boost::shared_array< ::FrameCPP::Dimension::startX_type > FrameAPI::Channel::startX_type

◆ startX_type [3/3]

typedef boost::shared_array< ::FrameCPP::Dimension::startX_type > FrameAPI::Channel::startX_type

◆ unitX_type [1/3]

typedef boost::shared_array< ::FrameCPP::Dimension::unitX_type > FrameAPI::Channel::unitX_type

◆ unitX_type [2/3]

typedef boost::shared_array< ::FrameCPP::Dimension::unitX_type > FrameAPI::Channel::unitX_type

◆ unitX_type [3/3]

typedef boost::shared_array< ::FrameCPP::Dimension::unitX_type > FrameAPI::Channel::unitX_type

◆ unitY_type [1/3]

◆ unitY_type [2/3]

◆ unitY_type [3/3]

Constructor & Destructor Documentation

◆ Channel() [1/3]

FrameAPI::Channel::Channel ( )

◆ ~Channel() [1/3]

FrameAPI::Channel::~Channel ( )
virtual

◆ Channel() [2/3]

FrameAPI::Channel::Channel ( )

◆ ~Channel() [2/3]

virtual FrameAPI::Channel::~Channel ( )
virtual

◆ Channel() [3/3]

FrameAPI::Channel::Channel ( )

◆ ~Channel() [3/3]

virtual FrameAPI::Channel::~Channel ( )
virtual

Member Function Documentation

◆ GetDx() [1/3]

Channel::dx_type FrameAPI::Channel::GetDx ( ) const
inline

◆ GetDx() [2/3]

dx_type FrameAPI::Channel::GetDx ( ) const

◆ GetDx() [3/3]

dx_type FrameAPI::Channel::GetDx ( ) const

◆ GetName() [1/3]

Channel::name_type FrameAPI::Channel::GetName ( ) const
inline

◆ GetName() [2/3]

name_type FrameAPI::Channel::GetName ( ) const

◆ GetName() [3/3]

name_type FrameAPI::Channel::GetName ( ) const

◆ GetNx() [1/3]

Channel::nx_type FrameAPI::Channel::GetNx ( ) const
inline

◆ GetNx() [2/3]

nx_type FrameAPI::Channel::GetNx ( ) const

◆ GetNx() [3/3]

nx_type FrameAPI::Channel::GetNx ( ) const

◆ GetStartX() [1/3]

Channel::startX_type FrameAPI::Channel::GetStartX ( ) const
inline

◆ GetStartX() [2/3]

startX_type FrameAPI::Channel::GetStartX ( ) const

◆ GetStartX() [3/3]

startX_type FrameAPI::Channel::GetStartX ( ) const

◆ GetUnitX() [1/3]

Channel::unitX_type FrameAPI::Channel::GetUnitX ( ) const
inline

◆ GetUnitX() [2/3]

unitX_type FrameAPI::Channel::GetUnitX ( ) const

◆ GetUnitX() [3/3]

unitX_type FrameAPI::Channel::GetUnitX ( ) const

◆ GetUnitY() [1/3]

Channel::unitY_type FrameAPI::Channel::GetUnitY ( ) const
inline

◆ GetUnitY() [2/3]

unitY_type FrameAPI::Channel::GetUnitY ( ) const

◆ GetUnitY() [3/3]

unitY_type FrameAPI::Channel::GetUnitY ( ) const

◆ RefData() [1/3]

virtual data_type& FrameAPI::Channel::RefData ( ) const
pure virtual

◆ RefData() [2/3]

virtual data_type& FrameAPI::Channel::RefData ( ) const
pure virtual

◆ RefData() [3/3]

virtual data_type& FrameAPI::Channel::RefData ( ) const
pure virtual

◆ seed() [1/3]

Channel::data_type & FrameAPI::Channel::seed ( ) const
inlineprivate

◆ seed() [2/3]

data_type& FrameAPI::Channel::seed ( ) const
private

◆ seed() [3/3]

data_type& FrameAPI::Channel::seed ( ) const
private

Member Data Documentation

◆ m_dx

dx_type FrameAPI::Channel::m_dx
mutableprivate

◆ m_nx

nx_type FrameAPI::Channel::m_nx
mutableprivate

◆ m_startX

startX_type FrameAPI::Channel::m_startX
mutableprivate

◆ m_unitX

unitX_type FrameAPI::Channel::m_unitX
mutableprivate

◆ name

name_type FrameAPI::Channel::name
mutableprivate

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