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::FrTOCSimEvent Class Reference

Indexed elements of the FrSimEvent structure. More...

#include <FrTOCSimEvent.hh>

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

Classes

struct  event_type
 

Public Types

typedef INT_4U nevent_type
 
typedef STRING name_type
 
typedef INT_4U nTotalSEvent_type
 
typedef INT_4U gtimesSim_type
 
typedef INT_4U gtimenSim_type
 
typedef REAL_4 amplitudeSimEvent_type
 
typedef INT_8U positionSimEvent_type
 
typedef std::vector< event_typeevents_container_type
 
typedef std::map< name_type, events_container_typenameSimEvent_container_type
 
typedef INT_4U nevent_type
 
typedef STRING name_type
 
typedef INT_4U nTotalSEvent_type
 
typedef INT_4U gtimesSim_type
 
typedef INT_4U gtimenSim_type
 
typedef REAL_4 amplitudeSimEvent_type
 
typedef INT_8U positionSimEvent_type
 
typedef std::vector< event_typeevents_container_type
 
typedef std::map< name_type, events_container_typenameSimEvent_container_type
 

Public Member Functions

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

 FrTOCSimEvent (Common::IStream &Stream)
 Stream constructor. More...
 
positionSimEvent_type positionSimEvent (INT_4U Frame, const std::string &SimEvent) const
 Locate the position of the event. More...
 
positionSimEvent_type positionSimEvent (const std::string &EventType, INT_4U Index) const
 Locate the position of the event. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
 FrTOCSimEvent (Common::IStream &Stream)
 Stream constructor. More...
 
positionSimEvent_type positionSimEvent (INT_4U Frame, const std::string &SimEvent) const
 Locate the position of the event. More...
 
positionSimEvent_type positionSimEvent (const std::string &EventType, 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

nameSimEvent_container_type m_info
 

Detailed Description

Indexed elements of the FrSimEvent structure.

Member Typedef Documentation

◆ amplitudeSimEvent_type [1/2]

◆ amplitudeSimEvent_type [2/2]

◆ events_container_type [1/2]

◆ events_container_type [2/2]

◆ gtimenSim_type [1/2]

◆ gtimenSim_type [2/2]

◆ gtimesSim_type [1/2]

◆ gtimesSim_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ nameSimEvent_container_type [1/2]

◆ nameSimEvent_container_type [2/2]

◆ nevent_type [1/2]

◆ nevent_type [2/2]

◆ nTotalSEvent_type [1/2]

◆ nTotalSEvent_type [2/2]

◆ positionSimEvent_type [1/2]

◆ positionSimEvent_type [2/2]

Constructor & Destructor Documentation

◆ FrTOCSimEvent() [1/4]

FrameCPP::Version_8::FrTOCSimEvent::FrTOCSimEvent ( )

Default constructor.

◆ FrTOCSimEvent() [2/4]

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

Stream constructor.

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

◆ FrTOCSimEvent() [3/4]

FrameCPP::Version_8::FrTOCSimEvent::FrTOCSimEvent ( )

Default constructor.

◆ FrTOCSimEvent() [4/4]

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

The description of structure.

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

◆ Description() [2/2]

template<typename SE >
static void FrameCPP::Version_8::FrTOCSimEvent::Description ( Common::Description Desc)
static

The description of structure.

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

◆ GetSimEvent() [1/2]

const FrTOCSimEvent::nameSimEvent_container_type & FrameCPP::Version_8::FrTOCSimEvent::GetSimEvent ( ) const
inline

Return all events.

Returns
Constant container to the indexed FrSimEvent elements.

◆ GetSimEvent() [2/2]

const nameSimEvent_container_type& FrameCPP::Version_8::FrTOCSimEvent::GetSimEvent ( ) const

Return all events.

Returns
Constant container to the indexed FrSimEvent elements.

◆ operator=() [1/2]

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

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [2/2]

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

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator==() [1/2]

bool FrameCPP::Version_8::FrTOCSimEvent::operator== ( const FrTOCSimEvent 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::FrTOCSimEvent::operator== ( const FrTOCSimEvent 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.

◆ positionSimEvent() [1/4]

FrTOCSimEvent::positionSimEvent_type FrameCPP::Version_8::FrTOCSimEvent::positionSimEvent ( 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.

◆ positionSimEvent() [2/4]

positionSimEvent_type FrameCPP::Version_8::FrTOCSimEvent::positionSimEvent ( 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.

◆ positionSimEvent() [3/4]

FrTOCSimEvent::positionSimEvent_type FrameCPP::Version_8::FrTOCSimEvent::positionSimEvent ( INT_4U  Frame,
const std::string &  SimEvent 
) const
protected

Locate the position of the event.

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

◆ positionSimEvent() [4/4]

positionSimEvent_type FrameCPP::Version_8::FrTOCSimEvent::positionSimEvent ( INT_4U  Frame,
const std::string &  SimEvent 
) const
protected

Locate the position of the event.

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

◆ QuerySimEvent() [1/2]

void FrameCPP::Version_8::FrTOCSimEvent::QuerySimEvent ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)

Gather TOC info for FrSimEvent 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.

◆ QuerySimEvent() [2/2]

void FrameCPP::Version_8::FrTOCSimEvent::QuerySimEvent ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)

Gather TOC info for FrSimEvent 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::FrTOCSimEvent::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::FrTOCSimEvent::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::FrTOCSimEvent::event_type_size
static
Initial value:
= sizeof( gtimesSim_type ) +
sizeof( gtimenSim_type ) + sizeof( amplitudeSimEvent_type ) +

◆ m_info

nameSimEvent_container_type FrameCPP::Version_8::FrTOCSimEvent::m_info
protected

The documentation for this class was generated from the following files:
FrameCPP::Version_8::FrTOCSimEvent::gtimesSim_type
INT_4U gtimesSim_type
Definition: FrTOCSimEvent.hh:58
FrameCPP::Version_8::FrTOCSimEvent::positionSimEvent_type
INT_8U positionSimEvent_type
Definition: FrTOCSimEvent.hh:61
FrameCPP::Version_8::FrTOCSimEvent::gtimenSim_type
INT_4U gtimenSim_type
Definition: FrTOCSimEvent.hh:59
FrameCPP::Version_8::FrTOCSimEvent::amplitudeSimEvent_type
REAL_4 amplitudeSimEvent_type
Definition: FrTOCSimEvent.hh:60