#include <FrTOCSimEventClassicIO.hh>

Inheritance diagram for FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO:

Collaboration diagram for FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO:

Public Types
typedef LDASTools::AL::GPSTime	gtime_type
typedef LDASTools::AL::GPSTime	gtime_type
typedef INT_4U	nevent_type
typedef INT_4U	nevent_type
typedef std::string	name_type
typedef std::string	name_type
typedef INT_4U	nTotalSEvent_type
typedef INT_4U	nTotalSEvent_type
typedef INT_4U	gtimesSim_type
typedef INT_4U	gtimesSim_type
typedef INT_4U	gtimenSim_type
typedef INT_4U	gtimenSim_type
typedef REAL_4	amplitudeSimEvent_type
typedef REAL_4	amplitudeSimEvent_type
typedef INT_8U	positionSimEvent_type
typedef INT_8U	positionSimEvent_type
typedef std::vector< event_type >	events_container_type
typedef std::vector< event_type >	events_container_type
typedef std::map< name_type, events_container_type >	nameSimEvent_container_type
typedef std::map< name_type, events_container_type >	nameSimEvent_container_type

Public Member Functions
	FrTOCSimEventClassicIO ()=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	QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
	Gather TOC info for FrSimEvent being written.
const FrTOCSimEventClassicIO &	operator= (const Previous::FrTOCImpl::FrTOCSimEventClassicIO &Source)
	asignment operator
FrTOCSimEventClassicIO &	operator= (FrTOCSimEventClassicIO &&TOC)
	FrTOCSimEventClassicIO ()=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	QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
	Gather TOC info for FrSimEvent being written.
const FrTOCSimEventClassicIO &	operator= (const Previous::FrTOCImpl::FrTOCSimEventClassicIO &Source)
	asignment operator
FrTOCSimEventClassicIO &	operator= (FrTOCSimEventClassicIO &&TOC)
const nameSimEvent_container_type &	GetSimEvent () const
	Return all events.
const nameSimEvent_container_type &	GetSimEvent () 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.
positionSimEvent_type	positionSimEvent (INT_4U Frame, const std::string &SimEvent) const
	Locate the position of the event.
positionSimEvent_type	positionSimEvent (const std::string &SimEvent, INT_4U Index) const
positionSimEvent_type	positionSimEvent (INT_4U Frame, const std::string &SimEvent) const
	Locate the position of the event.
positionSimEvent_type	positionSimEvent (const std::string &SimEvent, INT_4U Index) const

Protected Attributes
nameSimEvent_container_type	m_info

Member Typedef Documentation

◆ amplitudeSimEvent_type [1/2]

typedef REAL_4 FrameCPP::v8::FrTOCSimEvent::amplitudeSimEvent_type

inherited

◆ amplitudeSimEvent_type [2/2]

typedef REAL_4 FrameCPP::v8::FrTOCSimEvent::amplitudeSimEvent_type

inherited

◆ events_container_type [1/2]

typedef std::vector< event_type > FrameCPP::v8::FrTOCSimEvent::events_container_type

inherited

◆ events_container_type [2/2]

typedef std::vector< event_type > FrameCPP::v8::FrTOCSimEvent::events_container_type

inherited

◆ gtime_type [1/2]

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

inherited

◆ gtime_type [2/2]

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

inherited

◆ gtimenSim_type [1/2]

typedef INT_4U FrameCPP::v8::FrTOCSimEvent::gtimenSim_type

inherited

◆ gtimenSim_type [2/2]

typedef INT_4U FrameCPP::v8::FrTOCSimEvent::gtimenSim_type

inherited

◆ gtimesSim_type [1/2]

typedef INT_4U FrameCPP::v8::FrTOCSimEvent::gtimesSim_type

inherited

◆ gtimesSim_type [2/2]

typedef INT_4U FrameCPP::v8::FrTOCSimEvent::gtimesSim_type

inherited

◆ name_type [1/2]

typedef std::string FrameCPP::v8::FrTOCSimEvent::name_type

inherited

◆ name_type [2/2]

typedef std::string FrameCPP::v8::FrTOCSimEvent::name_type

inherited

◆ nameSimEvent_container_type [1/2]

typedef std::map< name_type, events_container_type > FrameCPP::v8::FrTOCSimEvent::nameSimEvent_container_type

inherited

◆ nameSimEvent_container_type [2/2]

typedef std::map< name_type, events_container_type > FrameCPP::v8::FrTOCSimEvent::nameSimEvent_container_type

inherited

◆ nevent_type [1/2]

typedef INT_4U FrameCPP::v8::FrTOCSimEvent::nevent_type

inherited

◆ nevent_type [2/2]

typedef INT_4U FrameCPP::v8::FrTOCSimEvent::nevent_type

inherited

◆ nTotalSEvent_type [1/2]

typedef INT_4U FrameCPP::v8::FrTOCSimEvent::nTotalSEvent_type

inherited

◆ nTotalSEvent_type [2/2]

typedef INT_4U FrameCPP::v8::FrTOCSimEvent::nTotalSEvent_type

inherited

◆ positionSimEvent_type [1/2]

typedef INT_8U FrameCPP::v8::FrTOCSimEvent::positionSimEvent_type

inherited

◆ positionSimEvent_type [2/2]

typedef INT_8U FrameCPP::v8::FrTOCSimEvent::positionSimEvent_type

inherited

Constructor & Destructor Documentation

◆ FrTOCSimEventClassicIO() [1/2]

FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::FrTOCSimEventClassicIO ( )

default

◆ FrTOCSimEventClassicIO() [2/2]

FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::FrTOCSimEventClassicIO ( )

default

Member Function Documentation

◆ Bytes() [1/2]

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

inline

Number of bytes needed to write this structure.

Parameters

[in] Stream The 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::FrTOCSimEventClassicIO::Bytes ( const Common::StreamBase & Stream ) const

inline

Number of bytes needed to write this structure.

Parameters

[in] Stream The 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_9::FrTOCImpl::FrTOCSimEventClassicIO::Description ( Common::Description & Desc )

inlinestatic

The description of structure.

Parameters

[out] Desc Storage 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>

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::Description ( Common::Description & Desc )

inlinestatic

The description of structure.

Parameters

[out] Desc Storage for the description of the structure.

Returns: A Description object which describes this structure as specified by the frame specification.

◆ GetSimEvent() [1/2]

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

inlineinherited

Return all events.

Returns: Constant container to the indexed FrSimEvent elements.

◆ GetSimEvent() [2/2]

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

inlineinherited

Return all events.

Returns: Constant container to the indexed FrSimEvent elements.

◆ Load() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::Load ( istream_type & Stream )

inline

Read contents from stream.

Parameters

[in] Stream The stream from which the object is being read.

Returns: A new instance of this object.

◆ Load() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::Load ( istream_type & Stream )

inline

Read contents from stream.

Parameters

[in] Stream The stream from which the object is being read.

Returns: A new instance of this object.

◆ operator=() [1/4]

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

inline

asignment operator

Parameters

[in] Source The source to be copied.

◆ operator=() [2/4]

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

inline

asignment operator

Parameters

[in] Source The source to be copied.

◆ operator=() [3/4]

FrTOCSimEventClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::operator= ( FrTOCSimEventClassicIO && TOC )

inline

◆ operator=() [4/4]

FrTOCSimEventClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::operator= ( FrTOCSimEventClassicIO && TOC )

inline

◆ positionSimEvent() [1/4]

positionSimEvent_type FrameCPP::v8::FrTOCSimEvent::positionSimEvent	(	const std::string &	SimEvent,
		INT_4U	Index ) const

inlineprotectedinherited

◆ positionSimEvent() [2/4]

positionSimEvent_type FrameCPP::v8::FrTOCSimEvent::positionSimEvent	(	const std::string &	SimEvent,
		INT_4U	Index ) const

inlineprotectedinherited

◆ positionSimEvent() [3/4]

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

inlineprotectedinherited

Locate the position of the event.

Parameters

[in]	Frame	Frame offset of the event.
[in]	SimEvent	The name of the event.

Returns: The file position of the requested event.

◆ positionSimEvent() [4/4]

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

inlineprotectedinherited

Locate the position of the event.

Parameters

[in]	Frame	Frame offset of the event.
[in]	SimEvent	The name of the event.

Returns: The file position of the requested event.

◆ QuerySimEvent() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::QuerySimEvent	(	const Common::TOCInfo &	Info,
		INT_4U	FrameOffset,
		INT_8U	Position )

inline

Gather TOC info for FrSimEvent being written.

Parameters

[in]	Info	Information
[in]	FrameOffset	The frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]	Position	The byte offset from the start of the file where the structure is written.

◆ QuerySimEvent() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::QuerySimEvent	(	const Common::TOCInfo &	Info,
		INT_4U	FrameOffset,
		INT_8U	Position )

inline

Gather TOC info for FrSimEvent being written.

Parameters

[in]	Info	Information
[in]	FrameOffset	The frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]	Position	The byte offset from the start of the file where the structure is written.

◆ write() [1/2]

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

inlineprotected

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

◆ write() [2/2]

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

inlineprotected

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

Member Data Documentation

◆ event_type_size

const int FrameCPP::v8::FrTOCSimEvent::event_type_size

staticinherited

Initial value:

                             = sizeof( gtimesSim_type ) +
sizeof( gtimenSim_type ) + sizeof( amplitudeSimEvent_type ) +
sizeof( positionSimEvent_type )

◆ m_info

nameSimEvent_container_type FrameCPP::v8::FrTOCSimEvent::m_info

protectedinherited

◆ NO_DATA_AVAILABLE

constexpr INT_4U FrameCPP::v8::FrTOCSimEvent::NO_DATA_AVAILABLE = 0xFFFFFFFF

staticconstexprinherited

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

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version9/impl/FrTOCSimEventClassicIO.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version9/impl/FrTOCSimEventClassicIO.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ amplitudeSimEvent_type [1/2]

◆ amplitudeSimEvent_type [2/2]

◆ events_container_type [1/2]

◆ events_container_type [2/2]

◆ gtime_type [1/2]

◆ gtime_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

◆ FrTOCSimEventClassicIO() [1/2]

◆ FrTOCSimEventClassicIO() [2/2]

Member Function Documentation

◆ Bytes() [1/2]

◆ Bytes() [2/2]

◆ Description() [1/2]

◆ Description() [2/2]

◆ GetSimEvent() [1/2]

◆ GetSimEvent() [2/2]

◆ Load() [1/2]

◆ Load() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ positionSimEvent() [1/4]

◆ positionSimEvent() [2/4]

◆ positionSimEvent() [3/4]

◆ positionSimEvent() [4/4]

◆ QuerySimEvent() [1/2]

◆ QuerySimEvent() [2/2]

◆ write() [1/2]

◆ write() [2/2]

Member Data Documentation

◆ event_type_size

◆ m_info

◆ NO_DATA_AVAILABLE