ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO Class Reference

#include <FrTOCEventClassicIO.hh>

Inheritance diagram for FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO:
Collaboration diagram for FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO:

Public Types

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

Public Member Functions

 FrTOCEventClassicIO ()=default
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
void Load (istream_type &Stream)
 Read contents from stream.
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrEvent being written.
 
const FrTOCEventClassicIOoperator= (const Previous::FrTOCImpl::FrTOCEventClassicIO &Source)
 asignment operator
 
FrTOCEventClassicIOoperator= (FrTOCEventClassicIO &&TOC)
 
 FrTOCEventClassicIO ()=default
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
void Load (istream_type &Stream)
 Read contents from stream.
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrEvent being written.
 
const FrTOCEventClassicIOoperator= (const Previous::FrTOCImpl::FrTOCEventClassicIO &Source)
 asignment operator
 
FrTOCEventClassicIOoperator= (FrTOCEventClassicIO &&TOC)
 
const nameEvent_container_typeGetEvent () const
 Return all events.
 
const nameEvent_container_typeGetEvent () const
 Return all events.
 

Static Public Member Functions

template<typename SE>
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE>
static void Description (Common::Description &Desc)
 The description of structure.
 

Static Public Attributes

static const int event_type_size
 
static constexpr INT_4U NO_DATA_AVAILABLE = 0xFFFFFFFF
 

Protected Member Functions

void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
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 [1/2]

◆ amplitudeEvent_type [2/2]

◆ events_container_type [1/2]

◆ events_container_type [2/2]

◆ gtime_type [1/2]

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

◆ gtime_type [2/2]

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

◆ gtimenEvent_type [1/2]

◆ gtimenEvent_type [2/2]

◆ gtimesEvent_type [1/2]

◆ gtimesEvent_type [2/2]

◆ name_type [1/2]

typedef std::string FrameCPP::v8::FrTOCEvent::name_type
inherited

◆ name_type [2/2]

typedef std::string FrameCPP::v8::FrTOCEvent::name_type
inherited

◆ nameEvent_container_type [1/2]

◆ nameEvent_container_type [2/2]

◆ nevent_type [1/2]

typedef INT_4U FrameCPP::v8::FrTOCEvent::nevent_type
inherited

◆ nevent_type [2/2]

typedef INT_4U FrameCPP::v8::FrTOCEvent::nevent_type
inherited

◆ nTotalEvent_type [1/2]

◆ nTotalEvent_type [2/2]

◆ positionEvent_type [1/2]

◆ positionEvent_type [2/2]

Constructor & Destructor Documentation

◆ FrTOCEventClassicIO() [1/2]

FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::FrTOCEventClassicIO ( )
default

◆ FrTOCEventClassicIO() [2/2]

FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::FrTOCEventClassicIO ( )
default

Member Function Documentation

◆ Bytes() [1/2]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::Bytes ( const Common::StreamBase & Stream) const
inline

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ Bytes() [2/2]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::Bytes ( const Common::StreamBase & Stream) const
inline

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ Description() [1/2]

template<typename SE>
static void FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::Description ( Common::Description & Desc)
inlinestatic

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.

◆ Description() [2/2]

template<typename SE>
static void FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::Description ( Common::Description & Desc)
inlinestatic

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.

◆ GetEvent() [1/2]

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

Return all events.

Returns
Constant container to the indexed FrEvent elements.

◆ GetEvent() [2/2]

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

Return all events.

Returns
Constant container to the indexed FrEvent elements.

◆ Load() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::Load ( istream_type & Stream)
inline

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::Load ( istream_type & Stream)
inline

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ operator=() [1/4]

const FrTOCEventClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::operator= ( const Previous::FrTOCImpl::FrTOCEventClassicIO & Source)
inline

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [2/4]

const FrTOCEventClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::operator= ( const Previous::FrTOCImpl::FrTOCEventClassicIO & Source)
inline

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [3/4]

FrTOCEventClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::operator= ( FrTOCEventClassicIO && TOC)
inline

◆ operator=() [4/4]

FrTOCEventClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::operator= ( FrTOCEventClassicIO && TOC)
inline

◆ positionEvent() [1/4]

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

◆ positionEvent() [2/4]

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

◆ positionEvent() [3/4]

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

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
inlineprotectedinherited

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_9::FrTOCImpl::FrTOCEventClassicIO::QueryEvent ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inline

Gather TOC info for FrEvent being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QueryEvent() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::QueryEvent ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inline

Gather TOC info for FrEvent being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ write() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::write ( Common::OStream & Stream) const
inlineprotected

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::write ( Common::OStream & Stream) const
inlineprotected

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Member Data Documentation

◆ event_type_size

static const int FrameCPP::v8::FrTOCEvent::event_type_size
staticinherited
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
protectedinherited

◆ NO_DATA_AVAILABLE

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

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