Indexed elements of the FrAdcData structure. More...

#include <FrTOCAdcData.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOCAdcData:

Public Types
typedef std::map< name_type, adc_info_type >	MapADC_type
	Container of indexed FrAdcData elements. More...

typedef std::map< name_type, adc_info_type >	MapADC_type
	Container of indexed FrAdcData elements. More...

Public Member Functions
	FrTOCAdcData ()
	Default constructor.

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

const MapADC_type &	GetADC () const
	Return all channels. More...

MapADC_type::const_iterator	GetADC (const std::string &Name) const
	Return the indexed data for a named channel. More...

MapADC_type::const_iterator	GetADC (INT_4U index) const
	Return the indexed data for an indexed channel. More...

const key_container_type &	GetKeys () const
	Retrieve the keys. More...

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

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

bool	operator== (const FrTOCAdcData &RHS) const
	equality operator More...

	FrTOCAdcData ()
	Default constructor.

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

const MapADC_type &	GetADC () const
	Return all channels. More...

MapADC_type::const_iterator	GetADC (const std::string &Name) const
	Return the indexed data for a named channel. More...

MapADC_type::const_iterator	GetADC (INT_4U index) const
	Return the indexed data for an indexed channel. More...

const key_container_type &	GetKeys () const
	Retrieve the keys. More...

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

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

bool	operator== (const FrTOCAdcData &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...

Protected Member Functions
	FrTOCAdcData (Common::IStream &Stream, INT_4U FrameCount)
	Stream constructor. More...

void	forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
	Iterate over contents. More...

void	cachePositions (istream_type &Stream)
	Cache where the positions of the Adc channels. More...

void	seekPositions (istream_type &Stream, channel_id_type Channel)
	Advance to the specified Adc channel. More...

void	seekPositions (istream_type &Stream, const std::string &Channel)
	Advance to the specified Adc channel. More...

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

	FrTOCAdcData (Common::IStream &Stream, INT_4U FrameCount)
	Stream constructor. More...

void	forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
	Iterate over contents. More...

void	cachePositions (istream_type &Stream)
	Cache where the positions of the Adc channels. More...

void	seekPositions (istream_type &Stream, channel_id_type Channel)
	Advance to the specified Adc channel. More...

void	seekPositions (istream_type &Stream, const std::string &Channel)
	Advance to the specified Adc channel. More...

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

Detailed Description

Indexed elements of the FrAdcData structure.

Member Typedef Documentation

◆ MapADC_type [1/2]

typedef std::map< name_type, adc_info_type > FrameCPP::Version_8::FrTOCAdcData::MapADC_type

Container of indexed FrAdcData elements.

This structure is ordered by the name of the FrAdcData channel name. There is one element for each channel of indexed data.

◆ MapADC_type [2/2]

typedef std::map< name_type, adc_info_type > FrameCPP::Version_8::FrTOCAdcData::MapADC_type

Container of indexed FrAdcData elements.

This structure is ordered by the name of the FrAdcData channel name. There is one element for each channel of indexed data.

Constructor & Destructor Documentation

◆ FrTOCAdcData() [1/2]

FrameCPP::Version_8::FrTOCAdcData::FrTOCAdcData	(	Common::IStream &	Stream,
		INT_4U	FrameCount
	)

protected

Stream constructor.

Parameters

[in]	Stream	The input stream from where the object is being read.
[in]	FrameCount	The frame offset.

◆ FrTOCAdcData() [2/2]

FrameCPP::Version_8::FrTOCAdcData::FrTOCAdcData	(	Common::IStream &	Stream,
		INT_4U	FrameCount
	)

protected

Stream constructor.

Parameters

[in]	Stream	The input stream from where the object is being read.
[in]	FrameCount	The frame offset.

Member Function Documentation

◆ Bytes() [1/2]

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

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.

◆ cachePositions() [1/2]

void FrameCPP::Version_8::FrTOCAdcData::cachePositions ( istream_type & Stream )

inlineprotected

Cache where the positions of the Adc channels.

Parameters

[in,out] Stream The Stream being read

◆ cachePositions() [2/2]

void FrameCPP::Version_8::FrTOCAdcData::cachePositions ( istream_type & Stream )

protected

Cache where the positions of the Adc channels.

Parameters

[in,out] Stream The Stream being read

◆ Description() [1/2]

template<typename SE >

void FrameCPP::Version_8::FrTOCAdcData::Description ( Common::Description & Desc )

static

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 >

static void FrameCPP::Version_8::FrTOCAdcData::Description ( Common::Description & Desc )

static

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.

◆ forEach() [1/2]

void FrameCPP::Version_8::FrTOCAdcData::forEach	(	Common::FrTOC::query_info_type	Info,
		Common::FrTOC::FunctionBase &	Action
	)		const

protected

Iterate over contents.

Parameters

[in]	Info	Specifies the type of information to be searched.
[in]	Action	Action to be taken for each piece of information found.

This method allows for iterting over each element of information and allows the caller to gather information about each element.

◆ forEach() [2/2]

void FrameCPP::Version_8::FrTOCAdcData::forEach	(	Common::FrTOC::query_info_type	Info,
		Common::FrTOC::FunctionBase &	Action
	)		const

protected

Iterate over contents.

Parameters

[in]	Info	Specifies the type of information to be searched.
[in]	Action	Action to be taken for each piece of information found.

◆ GetADC() [1/6]

const FrTOCAdcData::MapADC_type & FrameCPP::Version_8::FrTOCAdcData::GetADC ( ) const

inline

Return all channels.

Returns: Constant container to the indexed FrAdcData elements.

◆ GetADC() [2/6]

const MapADC_type& FrameCPP::Version_8::FrTOCAdcData::GetADC ( ) const

Return all channels.

Returns: Constant container to the indexed FrAdcData elements.

◆ GetADC() [3/6]

MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC ( const std::string & Name ) const

Return the indexed data for a named channel.

Parameters

[in] Name The name of the channel.

Returns: Constant iterator to the indexed FrAdcData element.

◆ GetADC() [4/6]

FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC ( const std::string & Name ) const

Return the indexed data for a named channel.

Parameters

[in] Name The name of the channel.

Returns: Constant iterator to the indexed FrAdcData element.

◆ GetADC() [5/6]

FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC ( INT_4U index ) const

Return the indexed data for an indexed channel.

Parameters

[in] index The numeric offset of the channel.

Returns: Constant iterator to the indexed FrAdcData element.

◆ GetADC() [6/6]

MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC ( INT_4U index ) const

Return the indexed data for an indexed channel.

Parameters

[in] index The numeric offset of the channel.

Returns: Constant iterator to the indexed FrAdcData element.

◆ GetKeys() [1/2]

const key_container_type& FrameCPP::Version_8::FrTOCAdcData::GetKeys ( ) const

Retrieve the keys.

Returns: Constant container of keys.

◆ GetKeys() [2/2]

const FrTOCAdcData::key_container_type & FrameCPP::Version_8::FrTOCAdcData::GetKeys ( ) const

inline

Retrieve the keys.

Returns: Constant container of keys.

◆ operator=() [1/2]

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

asignment operator

Parameters

[in] Source The source to be copied.

◆ operator=() [2/2]

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

asignment operator

Parameters

[in] Source The source to be copied.

◆ operator==() [1/2]

bool FrameCPP::Version_8::FrTOCAdcData::operator== ( const FrTOCAdcData & RHS ) const

equality operator

Parameters

[in] RHS The 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::FrTOCAdcData::operator== ( const FrTOCAdcData & RHS ) const

equality operator

Parameters

[in] RHS The FrTOCAdcData object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ QueryAdc() [1/2]

void FrameCPP::Version_8::FrTOCAdcData::QueryAdc	(	const Common::TOCInfo &	Info,
		INT_4U	FrameOffset,
		INT_8U	Position
	)

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

◆ QueryAdc() [2/2]

void FrameCPP::Version_8::FrTOCAdcData::QueryAdc	(	const Common::TOCInfo &	Info,
		INT_4U	FrameOffset,
		INT_8U	Position
	)

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

◆ seekPositions() [1/4]

void FrameCPP::Version_8::FrTOCAdcData::seekPositions	(	istream_type &	Stream,
		channel_id_type	Channel
	)

protected

Advance to the specified Adc channel.

Parameters

[in,out]	Stream	The Stream being read
[in]	Channel	The requested channel

◆ seekPositions() [2/4]

void FrameCPP::Version_8::FrTOCAdcData::seekPositions	(	istream_type &	Stream,
		channel_id_type	Channel
	)

inlineprotected

Advance to the specified Adc channel.

Parameters

[in,out]	Stream	The Stream being read
[in]	Channel	The requested channel

◆ seekPositions() [3/4]

void FrameCPP::Version_8::FrTOCAdcData::seekPositions	(	istream_type &	Stream,
		const std::string &	Channel
	)

protected

Advance to the specified Adc channel.

Parameters

[in,out]	Stream	The Stream being read
[in]	Channel	The requested channel

◆ seekPositions() [4/4]

void FrameCPP::Version_8::FrTOCAdcData::seekPositions	(	istream_type &	Stream,
		const std::string &	Channel
	)

inlineprotected

Advance to the specified Adc channel.

Parameters

[in,out]	Stream	The Stream being read
[in]	Channel	The requested channel

◆ write() [1/2]

void FrameCPP::Version_8::FrTOCAdcData::write ( Common::OStream & Stream ) const

protected

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

protected

Write the structure to the stream.

Parameters

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

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

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version8/FrTOCAdcData.hh
Version8/FrTOCAdcData.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ MapADC_type [1/2]

◆ MapADC_type [2/2]

Constructor & Destructor Documentation

◆ FrTOCAdcData() [1/2]

◆ FrTOCAdcData() [2/2]

Member Function Documentation

◆ Bytes() [1/2]

◆ Bytes() [2/2]

◆ cachePositions() [1/2]

◆ cachePositions() [2/2]

◆ Description() [1/2]

◆ Description() [2/2]

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ GetADC() [1/6]

◆ GetADC() [2/6]

◆ GetADC() [3/6]

◆ GetADC() [4/6]

◆ GetADC() [5/6]

◆ GetADC() [6/6]

◆ GetKeys() [1/2]

◆ GetKeys() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ QueryAdc() [1/2]

◆ QueryAdc() [2/2]

◆ seekPositions() [1/4]

◆ seekPositions() [2/4]

◆ seekPositions() [3/4]

◆ seekPositions() [4/4]

◆ write() [1/2]

◆ write() [2/2]