ldas-tools-framecpp  2.9.3
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_6::FrTOCEvent Class Reference

#include <FrTOCEvent.hh>

Inheritance diagram for FrameCPP::Version_6::FrTOCEvent:
Inheritance graph
[legend]

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
 
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
 
 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)
 
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. More...
 
positionEvent_type positionEvent (const std::string &EventType, INT_4U Index) const
 Locate the position of the event. More...
 
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. More...
 
positionEvent_type positionEvent (const std::string &EventType, INT_4U Index) const
 Locate the position of the event. More...
 
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. More...
 
positionEvent_type positionEvent (const std::string &EventType, INT_4U Index) const
 Locate the position of the event. More...
 
void write (Common::OStream &Stream) const
 

Protected Attributes

nameEvent_container_type m_info
 

Member Typedef Documentation

◆ amplitudeEvent_type [1/3]

◆ amplitudeEvent_type [2/3]

◆ amplitudeEvent_type [3/3]

◆ events_container_type [1/3]

◆ events_container_type [2/3]

◆ events_container_type [3/3]

◆ gtimenEvent_type [1/3]

◆ gtimenEvent_type [2/3]

◆ gtimenEvent_type [3/3]

◆ gtimesEvent_type [1/3]

◆ gtimesEvent_type [2/3]

◆ gtimesEvent_type [3/3]

◆ name_type [1/3]

◆ name_type [2/3]

◆ name_type [3/3]

◆ nameEvent_container_type [1/3]

◆ nameEvent_container_type [2/3]

◆ nameEvent_container_type [3/3]

◆ nevent_type [1/3]

◆ nevent_type [2/3]

◆ nevent_type [3/3]

◆ positionEvent_type [1/3]

◆ positionEvent_type [2/3]

◆ positionEvent_type [3/3]

Constructor & Destructor Documentation

◆ FrTOCEvent() [1/6]

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

◆ FrTOCEvent() [2/6]

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

◆ FrTOCEvent() [3/6]

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

◆ FrTOCEvent() [4/6]

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

◆ FrTOCEvent() [5/6]

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

◆ FrTOCEvent() [6/6]

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

Member Function Documentation

◆ Bytes() [1/3]

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

◆ Bytes() [2/3]

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

◆ Bytes() [3/3]

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

◆ Description() [1/3]

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

◆ Description() [2/3]

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

◆ Description() [3/3]

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

◆ GetEvent() [1/3]

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

◆ GetEvent() [2/3]

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

◆ GetEvent() [3/3]

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

◆ operator==() [1/3]

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

◆ operator==() [2/3]

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

◆ operator==() [3/3]

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

◆ positionEvent() [1/6]

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/6]

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/6]

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() [4/6]

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() [5/6]

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() [6/6]

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/3]

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

◆ QueryEvent() [2/3]

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

◆ QueryEvent() [3/3]

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

◆ write() [1/3]

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

◆ write() [2/3]

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

◆ write() [3/3]

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:52
INT_4U gtimesEvent_type
Definition: FrTOCEvent.hh:51
REAL_4 amplitudeEvent_type
Definition: FrTOCEvent.hh:53
INT_8U positionEvent_type
Definition: FrTOCEvent.hh:54

◆ m_info

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

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