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

#include <FrTOCEvent.hh>

Inheritance diagram for FrameCPP::v8::FrTOCEvent:

Classes

struct  event_type
 

Public Types

typedef INT_4U nevent_type
 
typedef std::string name_type
 
typedef INT_4U nTotalEvent_type
 
typedef INT_4U gtimesEvent_type
 
typedef INT_4U gtimenEvent_type
 
typedef REAL_4 amplitudeEvent_type
 
typedef INT_8U positionEvent_type
 
typedef LDASTools::AL::GPSTime gtime_type
 
typedef std::vector< event_typeevents_container_type
 
typedef std::map< name_type, events_container_typenameEvent_container_type
 

Public Member Functions

const nameEvent_container_typeGetEvent () const
 Return all events.
 
const nameEvent_container_typeGetEvent () const
 Return all events.
 

Static Public Attributes

static const int event_type_size
 
static constexpr INT_4U NO_DATA_AVAILABLE = 0xFFFFFFFF
 

Protected Member Functions

positionEvent_type positionEvent (INT_4U Frame, const std::string &Event) const
 Locate the position of the event.
 
positionEvent_type positionEvent (const std::string &Event, INT_4U Index) const
 
positionEvent_type positionEvent (INT_4U Frame, const std::string &Event) const
 Locate the position of the event.
 
positionEvent_type positionEvent (const std::string &Event, INT_4U Index) const
 

Protected Attributes

nameEvent_container_type m_info
 

Member Typedef Documentation

◆ amplitudeEvent_type

◆ events_container_type

◆ gtime_type

typedef LDASTools::AL::GPSTime FrameCPP::v8::FrTOCEvent::gtime_type

◆ gtimenEvent_type

◆ gtimesEvent_type

◆ name_type

◆ nameEvent_container_type

◆ nevent_type

◆ nTotalEvent_type

◆ positionEvent_type

Member Function Documentation

◆ GetEvent() [1/2]

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

Return all events.

Returns
Constant container to the indexed FrEvent elements.

◆ GetEvent() [2/2]

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

Return all events.

Returns
Constant container to the indexed FrEvent elements.

◆ positionEvent() [1/4]

positionEvent_type FrameCPP::v8::FrTOCEvent::positionEvent ( const std::string & Event,
INT_4U Index ) const
inlineprotected

◆ positionEvent() [2/4]

positionEvent_type FrameCPP::v8::FrTOCEvent::positionEvent ( const std::string & Event,
INT_4U Index ) const
inlineprotected

◆ positionEvent() [3/4]

positionEvent_type FrameCPP::v8::FrTOCEvent::positionEvent ( INT_4U Frame,
const std::string & Event ) const
inlineprotected

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::v8::FrTOCEvent::positionEvent ( INT_4U Frame,
const std::string & Event ) const
inlineprotected

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.

Member Data Documentation

◆ event_type_size

static const int FrameCPP::v8::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::v8::FrTOCEvent::m_info
protected

◆ NO_DATA_AVAILABLE

static constexpr INT_4U FrameCPP::v8::FrTOCEvent::NO_DATA_AVAILABLE = 0xFFFFFFFF
staticconstexpr

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