#include <FrTOCSimEventClassicIO.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventClassicIO:

[legend]

Collaboration diagram for FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventClassicIO:

Public Types
typedef INT_4U	nevent_type

typedef INT_4U	nevent_type

typedef INT_4U	nevent_type

typedef STRING	name_type

typedef STRING	name_type

typedef STRING	name_type

typedef INT_4U	nTotalSEvent_type

typedef INT_4U	nTotalSEvent_type

typedef INT_4U	nTotalSEvent_type

typedef INT_4U	gtimesSim_type

typedef INT_4U	gtimesSim_type

typedef INT_4U	gtimesSim_type

typedef INT_4U	gtimenSim_type

typedef INT_4U	gtimenSim_type

typedef INT_4U	gtimenSim_type

typedef REAL_4	amplitudeSimEvent_type

typedef REAL_4	amplitudeSimEvent_type

typedef REAL_4	amplitudeSimEvent_type

typedef INT_8U	positionSimEvent_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::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

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. More...

void	Load (istream_type &Stream)
	Read contents from stream. More...

void	QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
	Gather TOC info for FrSimEvent being written. More...

const FrTOCSimEventClassicIO &	operator= (const Previous::FrTOCSimEvent &Source)
	asignment operator More...

FrTOCSimEventClassicIO &	operator= (FrTOCSimEventClassicIO &&TOC)

	FrTOCSimEventClassicIO ()=default

Common::FrameSpec::size_type	Bytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...

void	Load (istream_type &Stream)
	Read contents from stream. More...

void	QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
	Gather TOC info for FrSimEvent being written. More...

const FrTOCSimEventClassicIO &	operator= (const Previous::FrTOCSimEvent &Source)
	asignment operator More...

FrTOCSimEventClassicIO &	operator= (FrTOCSimEventClassicIO &&TOC)

	FrTOCSimEventClassicIO ()=default

Common::FrameSpec::size_type	Bytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...

void	Load (istream_type &Stream)
	Read contents from stream. More...

void	QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
	Gather TOC info for FrSimEvent being written. More...

const FrTOCSimEventClassicIO &	operator= (const Previous::FrTOCSimEvent &Source)
	asignment operator More...

FrTOCSimEventClassicIO &	operator= (FrTOCSimEventClassicIO &&TOC)

const nameSimEvent_container_type &	GetSimEvent () const
	Return all events. More...

const nameSimEvent_container_type &	GetSimEvent () const
	Return all events. More...

const nameSimEvent_container_type &	GetSimEvent () const
	Return all events. 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...

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

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. More...

void	write (Common::OStream &Stream) const
	Write the structure to the stream. More...

void	write (Common::OStream &Stream) const
	Write the structure to the stream. 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 &SimEvent, INT_4U Index) const

positionSimEvent_type	positionSimEvent (INT_4U Frame, const std::string &SimEvent) const
	Locate the position of the event. More...

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. More...

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

Protected Attributes
nameSimEvent_container_type	m_info

Member Typedef Documentation

◆ amplitudeSimEvent_type [1/3]

typedef REAL_4 FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::amplitudeSimEvent_type

inherited

◆ amplitudeSimEvent_type [2/3]

typedef REAL_4 FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::amplitudeSimEvent_type

inherited

◆ amplitudeSimEvent_type [3/3]

typedef REAL_4 FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::amplitudeSimEvent_type

inherited

◆ events_container_type [1/3]

typedef std::vector< event_type > FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::events_container_type

inherited

◆ events_container_type [2/3]

typedef std::vector< event_type > FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::events_container_type

inherited

◆ events_container_type [3/3]

typedef std::vector< event_type > FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::events_container_type

inherited

◆ gtimenSim_type [1/3]

typedef INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::gtimenSim_type

inherited

◆ gtimenSim_type [2/3]

typedef INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::gtimenSim_type

inherited

◆ gtimenSim_type [3/3]

typedef INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::gtimenSim_type

inherited

◆ gtimesSim_type [1/3]

typedef INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::gtimesSim_type

inherited

◆ gtimesSim_type [2/3]

typedef INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::gtimesSim_type

inherited

◆ gtimesSim_type [3/3]

typedef INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::gtimesSim_type

inherited

◆ name_type [1/3]

typedef STRING FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::name_type

inherited

◆ name_type [2/3]

typedef STRING FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::name_type

inherited

◆ name_type [3/3]

typedef STRING FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::name_type

inherited

◆ nameSimEvent_container_type [1/3]

typedef std::map< name_type, events_container_type > FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::nameSimEvent_container_type

inherited

◆ nameSimEvent_container_type [2/3]

typedef std::map< name_type, events_container_type > FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::nameSimEvent_container_type

inherited

◆ nameSimEvent_container_type [3/3]

typedef std::map< name_type, events_container_type > FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::nameSimEvent_container_type

inherited

◆ nevent_type [1/3]

typedef INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::nevent_type

inherited

◆ nevent_type [2/3]

typedef INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::nevent_type

inherited

◆ nevent_type [3/3]

typedef INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::nevent_type

inherited

◆ nTotalSEvent_type [1/3]

typedef INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::nTotalSEvent_type

inherited

◆ nTotalSEvent_type [2/3]

typedef INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::nTotalSEvent_type

inherited

◆ nTotalSEvent_type [3/3]

typedef INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::nTotalSEvent_type

inherited

◆ positionSimEvent_type [1/3]

typedef INT_8U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::positionSimEvent_type

inherited

◆ positionSimEvent_type [2/3]

typedef INT_8U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::positionSimEvent_type

inherited

◆ positionSimEvent_type [3/3]

typedef INT_8U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::positionSimEvent_type

inherited

Constructor & Destructor Documentation

◆ FrTOCSimEventClassicIO() [1/3]

FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventClassicIO::FrTOCSimEventClassicIO ( )

default

◆ FrTOCSimEventClassicIO() [2/3]

FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventClassicIO::FrTOCSimEventClassicIO ( )

default

◆ FrTOCSimEventClassicIO() [3/3]

FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventClassicIO::FrTOCSimEventClassicIO ( )

default

Member Function Documentation

◆ Bytes() [1/3]

Common::FrameSpec::size_type FrameCPP::Version_8::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/3]

Common::FrameSpec::size_type FrameCPP::Version_8::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() [3/3]

Common::FrameSpec::size_type FrameCPP::Version_8::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/3]

template<typename SE >

static void FrameCPP::Version_8::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/3]

template<typename SE >

static void FrameCPP::Version_8::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() [3/3]

template<typename SE >

static void FrameCPP::Version_8::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/3]

const nameSimEvent_container_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::GetSimEvent ( ) const

inlineinherited

Return all events.

Returns: Constant container to the indexed FrSimEvent elements.

◆ GetSimEvent() [2/3]

const nameSimEvent_container_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::GetSimEvent ( ) const

inlineinherited

Return all events.

Returns: Constant container to the indexed FrSimEvent elements.

◆ GetSimEvent() [3/3]

const nameSimEvent_container_type& FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::GetSimEvent ( ) const

inlineinherited

Return all events.

Returns: Constant container to the indexed FrSimEvent elements.

◆ Load() [1/3]

void FrameCPP::Version_8::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/3]

void FrameCPP::Version_8::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() [3/3]

void FrameCPP::Version_8::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/6]

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

inline

asignment operator

Parameters

[in] Source The source to be copied.

◆ operator=() [2/6]

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

inline

asignment operator

Parameters

[in] Source The source to be copied.

◆ operator=() [3/6]

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

inline

asignment operator

Parameters

[in] Source The source to be copied.

◆ operator=() [4/6]

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

inline

◆ operator=() [5/6]

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

inline

◆ operator=() [6/6]

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

inline

◆ positionSimEvent() [1/6]

positionSimEvent_type FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::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() [2/6]

positionSimEvent_type FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::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() [3/6]

positionSimEvent_type FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::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/6]

positionSimEvent_type FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::positionSimEvent	(	const std::string &	SimEvent,
		INT_4U	Index
	)		const

inlineprotectedinherited

◆ positionSimEvent() [5/6]

positionSimEvent_type FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::positionSimEvent	(	const std::string &	SimEvent,
		INT_4U	Index
	)		const

inlineprotectedinherited

◆ positionSimEvent() [6/6]

positionSimEvent_type FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::positionSimEvent	(	const std::string &	SimEvent,
		INT_4U	Index
	)		const

inlineprotectedinherited

◆ QuerySimEvent() [1/3]

void FrameCPP::Version_8::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/3]

void FrameCPP::Version_8::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() [3/3]

void FrameCPP::Version_8::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/3]

void FrameCPP::Version_8::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/3]

void FrameCPP::Version_8::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() [3/3]

void FrameCPP::Version_8::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

static const int FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::event_type_size

staticinherited

Initial value:

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

◆ m_info

nameSimEvent_container_type FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::m_info

protectedinherited

◆ NO_DATA_AVAILABLE

static constexpr INT_4U FrameCPP::Version_8::FrTOCImpl::FrTOCSimEventData::NO_DATA_AVAILABLE = 0xFFFFFFFF

staticinherited

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

/build/ldas-tools-framecpp-2.8.1/debian/tmp/usr/include/framecpp/Version8/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/3]

◆ amplitudeSimEvent_type [2/3]

◆ amplitudeSimEvent_type [3/3]

◆ events_container_type [1/3]

◆ events_container_type [2/3]

◆ events_container_type [3/3]

◆ gtimenSim_type [1/3]

◆ gtimenSim_type [2/3]

◆ gtimenSim_type [3/3]

◆ gtimesSim_type [1/3]

◆ gtimesSim_type [2/3]

◆ gtimesSim_type [3/3]

◆ name_type [1/3]

◆ name_type [2/3]

◆ name_type [3/3]

◆ nameSimEvent_container_type [1/3]

◆ nameSimEvent_container_type [2/3]

◆ nameSimEvent_container_type [3/3]

◆ nevent_type [1/3]

◆ nevent_type [2/3]

◆ nevent_type [3/3]

◆ nTotalSEvent_type [1/3]

◆ nTotalSEvent_type [2/3]

◆ nTotalSEvent_type [3/3]

◆ positionSimEvent_type [1/3]

◆ positionSimEvent_type [2/3]

◆ positionSimEvent_type [3/3]

Constructor & Destructor Documentation

◆ FrTOCSimEventClassicIO() [1/3]

◆ FrTOCSimEventClassicIO() [2/3]

◆ FrTOCSimEventClassicIO() [3/3]

Member Function Documentation

◆ Bytes() [1/3]

◆ Bytes() [2/3]

◆ Bytes() [3/3]

◆ Description() [1/3]

◆ Description() [2/3]

◆ Description() [3/3]

◆ GetSimEvent() [1/3]

◆ GetSimEvent() [2/3]

◆ GetSimEvent() [3/3]

◆ Load() [1/3]

◆ Load() [2/3]

◆ Load() [3/3]

◆ operator=() [1/6]

◆ operator=() [2/6]

◆ operator=() [3/6]

◆ operator=() [4/6]

◆ operator=() [5/6]

◆ operator=() [6/6]

◆ positionSimEvent() [1/6]

◆ positionSimEvent() [2/6]

◆ positionSimEvent() [3/6]

◆ positionSimEvent() [4/6]

◆ positionSimEvent() [5/6]

◆ positionSimEvent() [6/6]

◆ QuerySimEvent() [1/3]

◆ QuerySimEvent() [2/3]

◆ QuerySimEvent() [3/3]

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]

Member Data Documentation

◆ event_type_size

◆ m_info

◆ NO_DATA_AVAILABLE