ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_6::FrTOCEvent Class Reference

#include <FrTOCEvent.hh>

Inheritance diagram for FrameCPP::Version_6::FrTOCEvent:

Classes

struct  event_type
 

Public Types

typedef INT_4U nevent_type
 
typedef STRING name_type
 
typedef INT_4U gtimesEvent_type
 
typedef INT_4U gtimenEvent_type
 
typedef REAL_4 amplitudeEvent_type
 
typedef INT_8U positionEvent_type
 
typedef std::vector< event_typeevents_container_type
 
typedef std::map< name_type, events_container_typenameEvent_container_type
 
typedef INT_4U nevent_type
 
typedef STRING name_type
 
typedef INT_4U gtimesEvent_type
 
typedef INT_4U gtimenEvent_type
 
typedef REAL_4 amplitudeEvent_type
 
typedef INT_8U positionEvent_type
 
typedef std::vector< event_typeevents_container_type
 
typedef std::map< name_type, events_container_typenameEvent_container_type
 

Public Member Functions

 FrTOCEvent ()
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
const nameEvent_container_typeGetEvent () const
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCEvent &RHS) const
 
 FrTOCEvent ()
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
const nameEvent_container_typeGetEvent () const
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCEvent &RHS) const
 

Static Public Member Functions

template<typename SE>
static void Description (Common::Description &Desc)
 
template<typename SE>
static void Description (Common::Description &Desc)
 

Static Public Attributes

static const int event_type_size
 

Protected Member Functions

 FrTOCEvent (Common::IStream &Stream)
 
positionEvent_type positionEvent (INT_4U Frame, const std::string &Channel) const
 Locate the position of the event.
 
positionEvent_type positionEvent (const std::string &EventType, INT_4U Index) const
 Locate the position of the event.
 
void write (Common::OStream &Stream) const
 
 FrTOCEvent (Common::IStream &Stream)
 
positionEvent_type positionEvent (INT_4U Frame, const std::string &Channel) const
 Locate the position of the event.
 
positionEvent_type positionEvent (const std::string &EventType, INT_4U Index) const
 Locate the position of the event.
 
void write (Common::OStream &Stream) const
 

Protected Attributes

nameEvent_container_type m_info
 

Member Typedef Documentation

◆ amplitudeEvent_type [1/2]

◆ amplitudeEvent_type [2/2]

◆ events_container_type [1/2]

◆ events_container_type [2/2]

◆ gtimenEvent_type [1/2]

◆ gtimenEvent_type [2/2]

◆ gtimesEvent_type [1/2]

◆ gtimesEvent_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ nameEvent_container_type [1/2]

◆ nameEvent_container_type [2/2]

◆ nevent_type [1/2]

◆ nevent_type [2/2]

◆ positionEvent_type [1/2]

◆ positionEvent_type [2/2]

Constructor & Destructor Documentation

◆ FrTOCEvent() [1/4]

FrameCPP::Version_6::FrTOCEvent::FrTOCEvent ( )

◆ FrTOCEvent() [2/4]

FrameCPP::Version_6::FrTOCEvent::FrTOCEvent ( Common::IStream & Stream)
protected

◆ FrTOCEvent() [3/4]

FrameCPP::Version_6::FrTOCEvent::FrTOCEvent ( )

◆ FrTOCEvent() [4/4]

FrameCPP::Version_6::FrTOCEvent::FrTOCEvent ( Common::IStream & Stream)
protected

Member Function Documentation

◆ Bytes() [1/2]

Common::FrameSpec::size_type FrameCPP::Version_6::FrTOCEvent::Bytes ( const Common::StreamBase & Stream) const
inline

◆ Bytes() [2/2]

Common::FrameSpec::size_type FrameCPP::Version_6::FrTOCEvent::Bytes ( const Common::StreamBase & Stream) const

◆ Description() [1/2]

template<typename SE>
void FrameCPP::Version_6::FrTOCEvent::Description ( Common::Description & Desc)
static

◆ Description() [2/2]

template<typename SE>
static void FrameCPP::Version_6::FrTOCEvent::Description ( Common::Description & Desc)
static

◆ GetEvent() [1/2]

const FrTOCEvent::nameEvent_container_type & FrameCPP::Version_6::FrTOCEvent::GetEvent ( ) const
inline

◆ GetEvent() [2/2]

const nameEvent_container_type & FrameCPP::Version_6::FrTOCEvent::GetEvent ( ) const

◆ operator==() [1/2]

bool FrameCPP::Version_6::FrTOCEvent::operator== ( const FrTOCEvent & RHS) const

◆ operator==() [2/2]

bool FrameCPP::Version_6::FrTOCEvent::operator== ( const FrTOCEvent & RHS) const

◆ positionEvent() [1/4]

FrTOCEvent::positionEvent_type FrameCPP::Version_6::FrTOCEvent::positionEvent ( const std::string & EventType,
INT_4U Index ) const
protected

Locate the position of the event.

Parameters
[in]EventTypeThe name of the event.
[in]IndexOffset of the event.
Returns
The file position of the requested event.

◆ positionEvent() [2/4]

positionEvent_type FrameCPP::Version_6::FrTOCEvent::positionEvent ( const std::string & EventType,
INT_4U Index ) const
protected

Locate the position of the event.

Parameters
[in]EventTypeThe name of the event.
[in]IndexOffset of the event.
Returns
The file position of the requested event.

◆ positionEvent() [3/4]

FrTOCEvent::positionEvent_type FrameCPP::Version_6::FrTOCEvent::positionEvent ( INT_4U Frame,
const std::string & Channel ) const
protected

Locate the position of the event.

Parameters
[in]FrameFrame offset of the event.
[in]EventThe name of the event.
Returns
The file position of the requested event.

◆ positionEvent() [4/4]

positionEvent_type FrameCPP::Version_6::FrTOCEvent::positionEvent ( INT_4U Frame,
const std::string & Channel ) const
protected

Locate the position of the event.

Parameters
[in]FrameFrame offset of the event.
[in]EventThe name of the event.
Returns
The file position of the requested event.

◆ QueryEvent() [1/2]

void FrameCPP::Version_6::FrTOCEvent::QueryEvent ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )

◆ QueryEvent() [2/2]

void FrameCPP::Version_6::FrTOCEvent::QueryEvent ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )

◆ write() [1/2]

void FrameCPP::Version_6::FrTOCEvent::write ( Common::OStream & Stream) const
protected

◆ write() [2/2]

void FrameCPP::Version_6::FrTOCEvent::write ( Common::OStream & Stream) const
protected

Member Data Documentation

◆ event_type_size

static const int FrameCPP::Version_6::FrTOCEvent::event_type_size
static
Initial value:
= sizeof( gtimesEvent_type ) +
sizeof( gtimenEvent_type ) + sizeof( amplitudeEvent_type ) +
INT_4U gtimenEvent_type
Definition FrTOCEvent.hh:45
INT_8U positionEvent_type
Definition FrTOCEvent.hh:47
INT_4U gtimesEvent_type
Definition FrTOCEvent.hh:44
REAL_4 amplitudeEvent_type
Definition FrTOCEvent.hh:46

◆ m_info

nameEvent_container_type FrameCPP::Version_6::FrTOCEvent::m_info
protected

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