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

Indexed elements of the FrEvent structure. More...

#include <FrTOCEvent.hh>

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

Classes

struct  event_type
 

Public Types

typedef INT_4U nevent_type
 
typedef 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 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 nTotalEvent_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 ()
 Default constructor. More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const nameEvent_container_typeGetEvent () const
 Return all events. More...
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrEvent being written. More...
 
const FrTOCEventoperator= (const Previous::FrTOCEvent &Source)
 asignment operator More...
 
bool operator== (const FrTOCEvent &RHS) const
 equality operator More...
 
 FrTOCEvent ()
 Default constructor. More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const nameEvent_container_typeGetEvent () const
 Return all events. More...
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrEvent being written. More...
 
const FrTOCEventoperator= (const Previous::FrTOCEvent &Source)
 asignment operator More...
 
bool operator== (const FrTOCEvent &RHS) const
 equality operator More...
 

Static Public Member Functions

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

Static Public Attributes

static const int event_type_size
 

Protected Member Functions

 FrTOCEvent (Common::IStream &Stream)
 Stream constructor. More...
 
positionEvent_type positionEvent (INT_4U Frame, const std::string &Event) const
 Locate the position of the event. More...
 
positionEvent_type positionEvent (const std::string &Event, INT_4U Index) const
 Locate the position of the event. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
 FrTOCEvent (Common::IStream &Stream)
 Stream constructor. More...
 
positionEvent_type positionEvent (INT_4U Frame, const std::string &Event) const
 Locate the position of the event. More...
 
positionEvent_type positionEvent (const std::string &Event, INT_4U Index) const
 Locate the position of the event. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 

Protected Attributes

nameEvent_container_type m_info
 

Detailed Description

Indexed elements of the FrEvent structure.

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]

◆ nTotalEvent_type [1/2]

◆ nTotalEvent_type [2/2]

◆ positionEvent_type [1/2]

◆ positionEvent_type [2/2]

Constructor & Destructor Documentation

◆ FrTOCEvent() [1/4]

FrameCPP::Version_8::FrTOCEvent::FrTOCEvent ( )

Default constructor.

◆ FrTOCEvent() [2/4]

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

Stream constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

◆ FrTOCEvent() [3/4]

FrameCPP::Version_8::FrTOCEvent::FrTOCEvent ( )

Default constructor.

◆ FrTOCEvent() [4/4]

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

Stream constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

Member Function Documentation

◆ Bytes() [1/2]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCEvent::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_8::FrTOCEvent::Bytes ( const Common::StreamBase Stream) const

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 >
void FrameCPP::Version_8::FrTOCEvent::Description ( Common::Description Desc)
static

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_8::FrTOCEvent::Description ( Common::Description Desc)
static

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 FrTOCEvent::nameEvent_container_type & FrameCPP::Version_8::FrTOCEvent::GetEvent ( ) const
inline

Return all events.

Returns
Constant container to the indexed FrEvent elements.

◆ GetEvent() [2/2]

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

Return all events.

Returns
Constant container to the indexed FrEvent elements.

◆ operator=() [1/2]

const FrTOCEvent & FrameCPP::Version_8::FrTOCEvent::operator= ( const Previous::FrTOCEvent &  Source)

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [2/2]

const FrTOCEvent& FrameCPP::Version_8::FrTOCEvent::operator= ( const Previous::FrTOCEvent &  Source)

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator==() [1/2]

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

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/2]

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

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ positionEvent() [1/4]

FrTOCEvent::positionEvent_type FrameCPP::Version_8::FrTOCEvent::positionEvent ( const std::string &  Event,
INT_4U  Index 
) const
protected

Locate the position of the event.

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

◆ positionEvent() [2/4]

positionEvent_type FrameCPP::Version_8::FrTOCEvent::positionEvent ( const std::string &  Event,
INT_4U  Index 
) const
protected

Locate the position of the event.

Parameters
[in]EventThe 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_8::FrTOCEvent::positionEvent ( INT_4U  Frame,
const std::string &  Event 
) 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_8::FrTOCEvent::positionEvent ( INT_4U  Frame,
const std::string &  Event 
) 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_8::FrTOCEvent::QueryEvent ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)

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_8::FrTOCEvent::QueryEvent ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)

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_8::FrTOCEvent::write ( Common::OStream Stream) const
protected

Write the structure to the stream.

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

◆ write() [2/2]

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

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::Version_8::FrTOCEvent::event_type_size
static
Initial value:
= sizeof( gtimesEvent_type ) +
sizeof( gtimenEvent_type ) + sizeof( amplitudeEvent_type ) +
REAL_4 amplitudeEvent_type
Definition: FrTOCEvent.hh:60
INT_8U positionEvent_type
Definition: FrTOCEvent.hh:61
INT_4U gtimesEvent_type
Definition: FrTOCEvent.hh:58
INT_4U gtimenEvent_type
Definition: FrTOCEvent.hh:59

◆ m_info

nameEvent_container_type FrameCPP::Version_8::FrTOCEvent::m_info
protected

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