#include <FrProcDataClassicIO.hh>

Inheritance diagram for FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >:

Collaboration diagram for FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >:

Public Types
enum	e_type_type { UNKNOWN_TYPE = 0 , TIME_SERIES = 1 , FREQUENCY_SERIES = 2 , OTHER_1D_SERIES_DATA = 3 , TIME_FREQUENCY = 4 , WAVELETS = 5 , MULTI_DIMENSIONAL = 6 , UNKNOWN_TYPE = 0 , TIME_SERIES = 1 , FREQUENCY_SERIES = 2 , OTHER_1D_SERIES_DATA = 3 , TIME_FREQUENCY = 4 , WAVELETS = 5 , MULTI_DIMENSIONAL = 6 }
enum	e_type_type { UNKNOWN_TYPE = 0 , TIME_SERIES = 1 , FREQUENCY_SERIES = 2 , OTHER_1D_SERIES_DATA = 3 , TIME_FREQUENCY = 4 , WAVELETS = 5 , MULTI_DIMENSIONAL = 6 , UNKNOWN_TYPE = 0 , TIME_SERIES = 1 , FREQUENCY_SERIES = 2 , OTHER_1D_SERIES_DATA = 3 , TIME_FREQUENCY = 4 , WAVELETS = 5 , MULTI_DIMENSIONAL = 6 }
enum	e_subType_type { UNKNOWN_SUB_TYPE = 0 , DFT = 1 , AMPLITUDE_SPECTRAL_DENSITY = 2 , POWER_SPECTRAL_DENSITY = 3 , CROSS_SPECTRAL_DENSITY = 4 , COHERENCE = 5 , TRANSFER_FUNCTION = 6 , UNKNOWN_SUB_TYPE = 0 , DFT = 1 , AMPLITUDE_SPECTRAL_DENSITY = 2 , POWER_SPECTRAL_DENSITY = 3 , CROSS_SPECTRAL_DENSITY = 4 , COHERENCE = 5 , TRANSFER_FUNCTION = 6 }
enum	e_subType_type { UNKNOWN_SUB_TYPE = 0 , DFT = 1 , AMPLITUDE_SPECTRAL_DENSITY = 2 , POWER_SPECTRAL_DENSITY = 3 , CROSS_SPECTRAL_DENSITY = 4 , COHERENCE = 5 , TRANSFER_FUNCTION = 6 , UNKNOWN_SUB_TYPE = 0 , DFT = 1 , AMPLITUDE_SPECTRAL_DENSITY = 2 , POWER_SPECTRAL_DENSITY = 3 , CROSS_SPECTRAL_DENSITY = 4 , COHERENCE = 5 , TRANSFER_FUNCTION = 6 }
typedef struct FrameCPP::Version_8::FrProcDataImpl::Data::auxParamInfo	auxParamInfo_type
typedef struct FrameCPP::Version_8::FrProcDataImpl::Data::auxParamInfo	auxParamInfo_type
typedef FR_PROC_DATA_NAME_TYPE	name_type
typedef FR_PROC_DATA_NAME_TYPE	name_type
typedef FR_PROC_DATA_COMMENT_TYPE	comment_type
typedef FR_PROC_DATA_COMMENT_TYPE	comment_type
typedef FR_PROC_DATA_TYPE_TYPE	type_type
typedef FR_PROC_DATA_TYPE_TYPE	type_type
typedef FR_PROC_DATA_SUB_TYPE_TYPE	subType_type
typedef FR_PROC_DATA_SUB_TYPE_TYPE	subType_type
typedef FR_PROC_DATA_TIME_OFFSET_TYPE	timeOffset_type
typedef FR_PROC_DATA_TIME_OFFSET_TYPE	timeOffset_type
typedef FR_PROC_DATA_T_RANGE_TYPE	tRange_type
typedef FR_PROC_DATA_T_RANGE_TYPE	tRange_type
typedef FR_PROC_DATA_F_SHIFT_TYPE	fShift_type
typedef FR_PROC_DATA_F_SHIFT_TYPE	fShift_type
typedef FR_PROC_DATA_PHASE_TYPE	phase_type
typedef FR_PROC_DATA_PHASE_TYPE	phase_type
typedef FR_PROC_DATA_F_RANGE_TYPE	fRange_type
typedef FR_PROC_DATA_F_RANGE_TYPE	fRange_type
typedef FR_PROC_DATA_BW_TYPE	BW_type
typedef FR_PROC_DATA_BW_TYPE	BW_type
typedef std::vector< auxParamInfo_type >	auxParam_type
typedef std::vector< auxParamInfo_type >	auxParam_type
typedef Common::Container< FrVect >	data_type
typedef Common::Container< FrVect >	data_type
typedef data_type::const_iterator	const_iterator
typedef data_type::const_iterator	const_iterator
typedef data_type::iterator	iterator
typedef data_type::iterator	iterator
typedef Common::Container< FrVect >	aux_type
typedef Common::Container< FrVect >	aux_type
typedef aux_type::const_iterator	const_aux_iterator
typedef aux_type::const_iterator	const_aux_iterator
typedef aux_type::iterator	aux_iterator
typedef aux_type::iterator	aux_iterator
typedef Common::Container< FrTable >	table_type
typedef Common::Container< FrTable >	table_type
typedef FrTable	table_value_type
typedef FrTable	table_value_type
typedef table_type::const_iterator	const_table_iterator
typedef table_type::const_iterator	const_table_iterator
typedef table_type::iterator	table_iterator
typedef table_type::iterator	table_iterator
typedef Common::Container< FrHistory >	history_type
typedef Common::Container< FrHistory >	history_type
typedef history_type::const_iterator	const_history_iterator
typedef history_type::const_iterator	const_history_iterator
typedef history_type::iterator	history_iterator
typedef history_type::iterator	history_iterator
typedef auxParam_type	AuxParamList_type
typedef auxParam_type	AuxParamList_type
typedef auxParam_type::value_type	AuxParam_type
typedef auxParam_type::value_type	AuxParam_type
typedef const char *const	struct_name_type
typedef const char *const	struct_name_type
typedef const char *const	struct_desc_type
typedef const char *const	struct_desc_type
typedef INT_2U const	struct_id_type
typedef INT_2U const	struct_id_type
enum	{ DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U , DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U , DT_REAL_4 , DT_REAL_8 }
enum	{ IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY , IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT , IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N , IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME , IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION }
enum	{ DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U , DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U , DT_REAL_4 , DT_REAL_8 }
enum	{ IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY , IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT , IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N , IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME , IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION }
typedef STRING< INT_2U >	string_2_type
typedef STRING< INT_2U >	string_2_type
typedef ObjectWithChecksum< ObjectType, ChecksumType >	self_type
typedef ObjectWithChecksum< ObjectType, ChecksumType >	self_type
typedef IStream	istream_type
typedef IStream	istream_type
typedef OStream	ostream_type
typedef OStream	ostream_type

Public Member Functions
	ClassicIO ()
	ClassicIO (Previous::FrProcData &Source, stream_base_type *Stream)
virtual const char *	ObjectStructName () const
	The name structure name of this object.
	ClassicIO ()
	ClassicIO (Previous::FrProcData &Source, stream_base_type *Stream)
virtual const char *	ObjectStructName () const
	The name structure name of this object.
void	AppendComment (const std::string &Comment)
void	AppendComment (const std::string &Comment)
void	AppendAuxParam (const auxParam_type::value_type &Param)
void	AppendAuxParam (const auxParam_type::value_type &Param)
const name_type &	GetName () const
	Return the name associate with the FrProcData structure.
const name_type &	GetName () const
	Return the name associate with the FrProcData structure.
const name_type &	GetNameSlow () const
const name_type &	GetNameSlow () const
const comment_type &	GetComment () const
	A brief description of the FrProcData structure.
const comment_type &	GetComment () const
	A brief description of the FrProcData structure.
type_type	GetType () const
type_type	GetType () const
subType_type	GetSubType () const
subType_type	GetSubType () const
timeOffset_type	GetTimeOffset () const
timeOffset_type	GetTimeOffset () const
fShift_type	GetFShift () const
fShift_type	GetFShift () const
phase_type	GetPhase () const
phase_type	GetPhase () const
BW_type	GetBW () const
BW_type	GetBW () const
const auxParam_type &	GetAuxParam () const
auxParam_type &	GetAuxParam ()
const auxParam_type &	GetAuxParam () const
auxParam_type &	GetAuxParam ()
fRange_type	GetFRange () const
	Retrieve the frequency range.
fRange_type	GetFRange () const
	Retrieve the frequency range.
tRange_type	GetTRange () const
	Retrieve the time range.
tRange_type	GetTRange () const
	Retrieve the time range.
void	SetAuxParam (const auxParam_type &AuxParams)
void	SetAuxParam (const auxParam_type &AuxParams)
void	SetComment (const comment_type &Comment)
void	SetComment (const comment_type &Comment)
void	SetFRange (fRange_type FRange)
void	SetFRange (fRange_type FRange)
void	SetFShift (fShift_type FShift)
void	SetFShift (fShift_type FShift)
void	SetTimeOffset (timeOffset_type TimeOffset)
void	SetTimeOffset (timeOffset_type TimeOffset)
void	SetTRange (tRange_type TRange)
void	SetTRange (tRange_type TRange)
const aux_type &	RefAux () const
	Identifier for vector for auxilliary data.
aux_type &	RefAux ()
	Identifier for vector for auxilliary data.
const aux_type &	RefAux () const
	Identifier for vector for auxilliary data.
aux_type &	RefAux ()
	Identifier for vector for auxilliary data.
const data_type &	RefData () const
	Identifier for vector for data vector.
data_type &	RefData ()
	Identifier for vector for data vector.
const data_type &	RefData () const
	Identifier for vector for data vector.
data_type &	RefData ()
	Identifier for vector for data vector.
const table_type &	RefTable () const
	Identifier for parameter table.
table_type &	RefTable ()
	Identifier for parameter table.
const table_type &	RefTable () const
	Identifier for parameter table.
table_type &	RefTable ()
	Identifier for parameter table.
const history_type &	RefHistory () const
	Identifier for channel history.
history_type &	RefHistory ()
	Identifier for channel history.
const history_type &	RefHistory () const
	Identifier for channel history.
history_type &	RefHistory ()
	Identifier for channel history.
bool	operator== (const Data &RHS) const
	equality operator
bool	operator== (const Data &RHS) const
	equality operator
void	TOCQuery (int InfoClass,...) const
void	TOCQuery (int InfoClass,...) const
virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.
virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.
virtual void	Write (ostream_type &Stream) const
	Write object to the stream.
virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

Static Public Member Functions
static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
	Promote previous version of object to this version.
static const Common::Description *	StructDescription ()
	The description of structure.
static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
	Promote previous version of object to this version.
static const Common::Description *	StructDescription ()
	The description of structure.
static const std::string &	IDTypeToString (type_type Type)
	Convert numeric types to string representation.
static const std::string &	IDTypeToString (type_type Type)
	Convert numeric types to string representation.
static const std::string &	IDSubTypeToString (type_type Type, subType_type SubType)
	Convert numeric sub-types to string representation.
static const std::string &	IDSubTypeToString (type_type Type, subType_type SubType)
	Convert numeric sub-types to string representation.
static struct_name_type	FrameSpecName ()
static struct_name_type	FrameSpecName ()
static struct_name_type	StructName ()
static struct_name_type	StructName ()
static struct_desc_type	FrameSpecDescription ()
	Return the dictionary name of the structure.
static struct_desc_type	FrameSpecDescription ()
	Return the dictionary name of the structure.
static struct_id_type	FrameSpecId ()
	Return the dictionary name of the structure.
static struct_id_type	FrameSpecId ()
	Return the dictionary name of the structure.
template<class T>
static int	DataType (const T *Data)
template<class T>
static int	DataType (const T &Data)
template<class T>
static int	DataType (const T *Data)
template<class T>
static int	DataType (const T &Data)
static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.
static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.
static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.
static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.

Static Public Attributes
static constexpr phase_type	PHASE_UNKNOWN { 0 }
static constexpr fRange_type	FRANGE_UNKNOWN { 0 }
static constexpr BW_type	BW_UNKNOWN { 0 }
static struct_name_type	struct_name
static struct_desc_type	struct_desc
static struct_id_type	struct_id

Protected Member Functions
virtual void	vTOCQuery (int InfoClass, va_list vl) const
	Answer requests for information as needed by TOC.
virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
	Down grade an object.
virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
	Upgrade an object.
cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.
virtual self_type *	pCreate (istream_type &Stream) const
	Virtual constructor.
virtual void	pWrite (ostream_type &Stream) const
	Virtual constructor.
virtual void	vTOCQuery (int InfoClass, va_list vl) const
	Answer requests for information as needed by TOC.
virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
	Down grade an object.
virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
	Upgrade an object.
cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.
virtual self_type *	pCreate (istream_type &Stream) const
	Virtual constructor.
virtual void	pWrite (ostream_type &Stream) const
	Virtual constructor.
void	copy_core (const Data &Source)
	Copy core data.
void	copy_core (const Data &Source)
	Copy core data.
void	sync () const
void	sync () const
void	sync_with_vector ()
void	sync_with_vector ()

Protected Attributes
name_type	name
	Channel name – must be unique with the frame.
comment_type	comment
	Comment.
type_type	type
	Type of data object.
subType_type	subType
	Subtype for f-Series (TBD for other types).
timeOffset_type	timeOffset
tRange_type	tRange
	Duration of sampled data (tStop-tStart).
fShift_type	fShift
phase_type	phase
fRange_type	fRange
	Frequency range (=fMax-fMin, 0 if unknown).
BW_type	BW
	Resolution bandwidth.
auxParam_type	auxParam
	Auxiliary parameters.
data_type	data
aux_type	aux
	Auxiliary data; use is generic.
table_type	table
	Parameter table.
history_type	history
	Channel history.
bool	synced_with_vector_

Static Protected Attributes
static constexpr unsigned int	MAX_REF { 4 }

Private Types
typedef STRING	io_name_type
typedef STRING	io_comment_type
typedef STRING	io_name_type
typedef STRING	io_comment_type
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >	object_base_type

Private Member Functions
virtual Object *	Create () const
virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual
virtual Object *	Create () const
virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual

Private Attributes
ChecksumType	m_chkSum
	Structure checksum.

Member Typedef Documentation

◆ aux_iterator [1/2]

typedef aux_type::iterator FrameCPP::Version_8::FrProcDataImpl::Data::aux_iterator

inherited

◆ aux_iterator [2/2]

typedef aux_type::iterator FrameCPP::Version_8::FrProcDataImpl::Data::aux_iterator

inherited

◆ aux_type [1/2]

typedef Common::Container< FrVect > FrameCPP::Version_8::FrProcDataImpl::Data::aux_type

inherited

◆ aux_type [2/2]

typedef Common::Container< FrVect > FrameCPP::Version_8::FrProcDataImpl::Data::aux_type

inherited

◆ AuxParam_type [1/2]

typedef auxParam_type::value_type FrameCPP::Version_8::FrProcDataImpl::Data::AuxParam_type

inherited

◆ AuxParam_type [2/2]

typedef auxParam_type::value_type FrameCPP::Version_8::FrProcDataImpl::Data::AuxParam_type

inherited

◆ auxParam_type [1/2]

typedef std::vector< auxParamInfo_type > FrameCPP::Version_8::FrProcDataImpl::Data::auxParam_type

inherited

◆ auxParam_type [2/2]

typedef std::vector< auxParamInfo_type > FrameCPP::Version_8::FrProcDataImpl::Data::auxParam_type

inherited

◆ auxParamInfo_type [1/2]

typedef struct FrameCPP::Version_8::FrProcDataImpl::Data::auxParamInfo FrameCPP::Version_8::FrProcDataImpl::Data::auxParamInfo_type

inherited

◆ auxParamInfo_type [2/2]

typedef struct FrameCPP::Version_8::FrProcDataImpl::Data::auxParamInfo FrameCPP::Version_8::FrProcDataImpl::Data::auxParamInfo_type

inherited

◆ AuxParamList_type [1/2]

typedef auxParam_type FrameCPP::Version_8::FrProcDataImpl::Data::AuxParamList_type

inherited

◆ AuxParamList_type [2/2]

typedef auxParam_type FrameCPP::Version_8::FrProcDataImpl::Data::AuxParamList_type

inherited

◆ BW_type [1/2]

typedef FR_PROC_DATA_BW_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::BW_type

inherited

◆ BW_type [2/2]

typedef FR_PROC_DATA_BW_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::BW_type

inherited

◆ comment_type [1/2]

typedef FR_PROC_DATA_COMMENT_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::comment_type

inherited

◆ comment_type [2/2]

typedef FR_PROC_DATA_COMMENT_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::comment_type

inherited

◆ const_aux_iterator [1/2]

typedef aux_type::const_iterator FrameCPP::Version_8::FrProcDataImpl::Data::const_aux_iterator

inherited

◆ const_aux_iterator [2/2]

typedef aux_type::const_iterator FrameCPP::Version_8::FrProcDataImpl::Data::const_aux_iterator

inherited

◆ const_history_iterator [1/2]

typedef history_type::const_iterator FrameCPP::Version_8::FrProcDataImpl::Data::const_history_iterator

inherited

◆ const_history_iterator [2/2]

typedef history_type::const_iterator FrameCPP::Version_8::FrProcDataImpl::Data::const_history_iterator

inherited

◆ const_iterator [1/2]

typedef data_type::const_iterator FrameCPP::Version_8::FrProcDataImpl::Data::const_iterator

inherited

◆ const_iterator [2/2]

typedef data_type::const_iterator FrameCPP::Version_8::FrProcDataImpl::Data::const_iterator

inherited

◆ const_table_iterator [1/2]

typedef table_type::const_iterator FrameCPP::Version_8::FrProcDataImpl::Data::const_table_iterator

inherited

◆ const_table_iterator [2/2]

typedef table_type::const_iterator FrameCPP::Version_8::FrProcDataImpl::Data::const_table_iterator

inherited

◆ data_type [1/2]

typedef Common::Container< FrVect > FrameCPP::Version_8::FrProcDataImpl::Data::data_type

inherited

◆ data_type [2/2]

typedef Common::Container< FrVect > FrameCPP::Version_8::FrProcDataImpl::Data::data_type

inherited

◆ fRange_type [1/2]

typedef FR_PROC_DATA_F_RANGE_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::fRange_type

inherited

◆ fRange_type [2/2]

typedef FR_PROC_DATA_F_RANGE_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::fRange_type

inherited

◆ fShift_type [1/2]

typedef FR_PROC_DATA_F_SHIFT_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::fShift_type

inherited

◆ fShift_type [2/2]

typedef FR_PROC_DATA_F_SHIFT_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::fShift_type

inherited

◆ history_iterator [1/2]

typedef history_type::iterator FrameCPP::Version_8::FrProcDataImpl::Data::history_iterator

inherited

◆ history_iterator [2/2]

typedef history_type::iterator FrameCPP::Version_8::FrProcDataImpl::Data::history_iterator

inherited

◆ history_type [1/2]

typedef Common::Container< FrHistory > FrameCPP::Version_8::FrProcDataImpl::Data::history_type

inherited

◆ history_type [2/2]

typedef Common::Container< FrHistory > FrameCPP::Version_8::FrProcDataImpl::Data::history_type

inherited

◆ io_comment_type [1/2]

template<typename T>

typedef STRING FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::io_comment_type

private

◆ io_comment_type [2/2]

template<typename T>

typedef STRING FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::io_comment_type

private

◆ io_name_type [1/2]

template<typename T>

typedef STRING FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::io_name_type

private

◆ io_name_type [2/2]

template<typename T>

typedef STRING FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::io_name_type

private

◆ istream_type [1/2]

template<typename ObjectType, typename ChecksumType>

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type

inherited

◆ istream_type [2/2]

template<typename ObjectType, typename ChecksumType>

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type

inherited

◆ iterator [1/2]

typedef data_type::iterator FrameCPP::Version_8::FrProcDataImpl::Data::iterator

inherited

◆ iterator [2/2]

typedef data_type::iterator FrameCPP::Version_8::FrProcDataImpl::Data::iterator

inherited

◆ name_type [1/2]

typedef FR_PROC_DATA_NAME_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::name_type

inherited

◆ name_type [2/2]

typedef FR_PROC_DATA_NAME_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::name_type

inherited

◆ object_base_type

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Version_8::ObjectWithChecksum< Common::FrameSpec::Object >::object_base_type

privateinherited

◆ ostream_type [1/2]

template<typename ObjectType, typename ChecksumType>

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type

inherited

◆ ostream_type [2/2]

template<typename ObjectType, typename ChecksumType>

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type

inherited

◆ phase_type [1/2]

typedef FR_PROC_DATA_PHASE_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::phase_type

inherited

◆ phase_type [2/2]

typedef FR_PROC_DATA_PHASE_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::phase_type

inherited

◆ self_type [1/2]

template<typename ObjectType, typename ChecksumType>

typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type

inherited

◆ self_type [2/2]

template<typename ObjectType, typename ChecksumType>

typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type

inherited

◆ string_2_type [1/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type

inherited

◆ string_2_type [2/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type

inherited

◆ struct_desc_type [1/2]

template<typename Object_T>

typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type

inherited

◆ struct_desc_type [2/2]

template<typename Object_T>

typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type

inherited

◆ struct_id_type [1/2]

template<typename Object_T>

typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type

inherited

◆ struct_id_type [2/2]

template<typename Object_T>

typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type

inherited

◆ struct_name_type [1/2]

template<typename Object_T>

typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type

inherited

◆ struct_name_type [2/2]

template<typename Object_T>

typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type

inherited

◆ subType_type [1/2]

typedef FR_PROC_DATA_SUB_TYPE_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::subType_type

inherited

◆ subType_type [2/2]

typedef FR_PROC_DATA_SUB_TYPE_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::subType_type

inherited

◆ table_iterator [1/2]

typedef table_type::iterator FrameCPP::Version_8::FrProcDataImpl::Data::table_iterator

inherited

◆ table_iterator [2/2]

typedef table_type::iterator FrameCPP::Version_8::FrProcDataImpl::Data::table_iterator

inherited

◆ table_type [1/2]

typedef Common::Container< FrTable > FrameCPP::Version_8::FrProcDataImpl::Data::table_type

inherited

◆ table_type [2/2]

typedef Common::Container< FrTable > FrameCPP::Version_8::FrProcDataImpl::Data::table_type

inherited

◆ table_value_type [1/2]

typedef FrTable FrameCPP::Version_8::FrProcDataImpl::Data::table_value_type

inherited

◆ table_value_type [2/2]

typedef FrTable FrameCPP::Version_8::FrProcDataImpl::Data::table_value_type

inherited

◆ timeOffset_type [1/2]

typedef FR_PROC_DATA_TIME_OFFSET_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::timeOffset_type

inherited

◆ timeOffset_type [2/2]

typedef FR_PROC_DATA_TIME_OFFSET_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::timeOffset_type

inherited

◆ tRange_type [1/2]

typedef FR_PROC_DATA_T_RANGE_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::tRange_type

inherited

◆ tRange_type [2/2]

typedef FR_PROC_DATA_T_RANGE_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::tRange_type

inherited

◆ type_type [1/2]

typedef FR_PROC_DATA_TYPE_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::type_type

inherited

◆ type_type [2/2]

typedef FR_PROC_DATA_TYPE_TYPE FrameCPP::Version_8::FrProcDataImpl::Data::type_type

inherited

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Enumerator
IC_EOQ
IC_AMPLITUDE
IC_CHANNEL_ID
IC_DATA_QUALITY
IC_DATA_VALID
IC_DETECTOR
IC_DETECTOR_PREFIX
IC_DT
IC_END
IC_FRAME
IC_GROUP_ID
IC_GTIME_N
IC_GTIME_S
IC_ID
IC_LOCAL_TIME
IC_NAME
IC_RUN
IC_START
IC_ULEAP_S
IC_VERSION

◆ anonymous enum

anonymous enum

inherited

Enumerator
DT_CHAR_PTR
DT_STRING_2
DT_INT_2S
DT_INT_2U
DT_INT_4S
DT_INT_4U
DT_INT_8S
DT_INT_8U
DT_REAL_4
DT_REAL_8

◆ anonymous enum

anonymous enum

inherited

Enumerator
IC_EOQ
IC_AMPLITUDE
IC_CHANNEL_ID
IC_DATA_QUALITY
IC_DATA_VALID
IC_DETECTOR
IC_DETECTOR_PREFIX
IC_DT
IC_END
IC_FRAME
IC_GROUP_ID
IC_GTIME_N
IC_GTIME_S
IC_ID
IC_LOCAL_TIME
IC_NAME
IC_RUN
IC_START
IC_ULEAP_S
IC_VERSION

◆ anonymous enum

anonymous enum

inherited

Enumerator
DT_CHAR_PTR
DT_STRING_2
DT_INT_2S
DT_INT_2U
DT_INT_4S
DT_INT_4U
DT_INT_8S
DT_INT_8U
DT_REAL_4
DT_REAL_8

◆ e_subType_type [1/2]

enum FrameCPP::Version_8::FrProcDataImpl::Data::e_subType_type

inherited

Enumerator
UNKNOWN_SUB_TYPE
DFT
AMPLITUDE_SPECTRAL_DENSITY
POWER_SPECTRAL_DENSITY
CROSS_SPECTRAL_DENSITY
COHERENCE
TRANSFER_FUNCTION
UNKNOWN_SUB_TYPE
DFT
AMPLITUDE_SPECTRAL_DENSITY
POWER_SPECTRAL_DENSITY
CROSS_SPECTRAL_DENSITY
COHERENCE
TRANSFER_FUNCTION

◆ e_subType_type [2/2]

enum FrameCPP::Version_8::FrProcDataImpl::Data::e_subType_type

inherited

Enumerator
UNKNOWN_SUB_TYPE
DFT
AMPLITUDE_SPECTRAL_DENSITY
POWER_SPECTRAL_DENSITY
CROSS_SPECTRAL_DENSITY
COHERENCE
TRANSFER_FUNCTION
UNKNOWN_SUB_TYPE
DFT
AMPLITUDE_SPECTRAL_DENSITY
POWER_SPECTRAL_DENSITY
CROSS_SPECTRAL_DENSITY
COHERENCE
TRANSFER_FUNCTION

◆ e_type_type [1/2]

enum FrameCPP::Version_8::FrProcDataImpl::Data::e_type_type

inherited

Enumerator
UNKNOWN_TYPE
TIME_SERIES
FREQUENCY_SERIES
OTHER_1D_SERIES_DATA
TIME_FREQUENCY
WAVELETS
MULTI_DIMENSIONAL
UNKNOWN_TYPE
TIME_SERIES
FREQUENCY_SERIES
OTHER_1D_SERIES_DATA
TIME_FREQUENCY
WAVELETS
MULTI_DIMENSIONAL

◆ e_type_type [2/2]

enum FrameCPP::Version_8::FrProcDataImpl::Data::e_type_type

inherited

Enumerator
UNKNOWN_TYPE
TIME_SERIES
FREQUENCY_SERIES
OTHER_1D_SERIES_DATA
TIME_FREQUENCY
WAVELETS
MULTI_DIMENSIONAL
UNKNOWN_TYPE
TIME_SERIES
FREQUENCY_SERIES
OTHER_1D_SERIES_DATA
TIME_FREQUENCY
WAVELETS
MULTI_DIMENSIONAL

Constructor & Destructor Documentation

◆ ClassicIO() [1/4]

template<typename T>

FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::ClassicIO ( )

inline

◆ ClassicIO() [2/4]

template<typename T>

FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::ClassicIO	(	Previous::FrProcData &	Source,
		stream_base_type *	Stream )

inline

◆ ClassicIO() [3/4]

template<typename T>

FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::ClassicIO ( )

inline

◆ ClassicIO() [4/4]

template<typename T>

FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::ClassicIO	(	Previous::FrProcData &	Source,
		stream_base_type *	Stream )

inline

Member Function Documentation

◆ AppendAuxParam() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::AppendAuxParam ( const auxParam_type::value_type & Param )

inlineinherited

◆ AppendAuxParam() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::AppendAuxParam ( const auxParam_type::value_type & Param )

inlineinherited

◆ AppendComment() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::AppendComment ( const std::string & Comment )

inlineinherited

◆ AppendComment() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::AppendComment ( const std::string & Comment )

inlineinherited

◆ Bytes() [1/2]

template<typename ObjectType, typename ChecksumType>

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in] Stream Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns: The number of bytes for this object

◆ Bytes() [2/2]

template<typename ObjectType, typename ChecksumType>

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in] Stream Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns: The number of bytes for this object

◆ CheckSumDataClass() [1/2]

template<typename ObjectType, typename ChecksumType>

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType, typename ChecksumType>

const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType, typename ChecksumType>

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType, typename ChecksumType>

const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

◆ copy_core() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::copy_core ( const Data & Source )

inlineprotectedinherited

Copy core data.

Parameters

[in] Source The source from which to copy the data

◆ copy_core() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::copy_core ( const Data & Source )

inlineprotectedinherited

Copy core data.

Parameters

[in] Source The source from which to copy the data

◆ Create() [1/6]

template<typename ObjectType, typename ChecksumType>

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const

inlineprivatevirtualinherited

Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.

◆ Create() [2/6]

template<typename ObjectType, typename ChecksumType>

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const

inlineprivatevirtualinherited

Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.

◆ Create() [3/6]

template<typename ObjectType, typename ChecksumType>

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

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

Returns: Return pointer to the newly allocated resource.

◆ Create() [4/6]

template<typename ObjectType, typename ChecksumType>

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

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

Returns: Return pointer to the newly allocated resource.

◆ Create() [5/6]

template<typename ObjectType, typename ChecksumType>

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer ) const

inlineprivatevirtualinherited

constructor - virtual

◆ Create() [6/6]

template<typename ObjectType, typename ChecksumType>

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer ) const

inlineprivatevirtualinherited

constructor - virtual

◆ DataType() [1/4]

template<class T>

int FrameCPP::Common::TOCInfo::DataType ( const T & Data )

staticinherited

◆ DataType() [2/4]

template<class T>

int FrameCPP::Common::TOCInfo::DataType ( const T & Data )

staticinherited

◆ DataType() [3/4]

template<class T>

int FrameCPP::Common::TOCInfo::DataType ( const T * Data )

staticinherited

◆ DataType() [4/4]

template<class T>

int FrameCPP::Common::TOCInfo::DataType ( const T * Data )

staticinherited

◆ demote() [1/2]

template<typename T>

virtual demote_ret_type FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		demote_stream_type *	Stream ) const

inlineprotectedvirtual

Down grade an object.

Parameters

[in]	Target	The version of the frame specification to demote too.
[in]	Obj	The version of the object to demote.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of the previous generation.

Todo: See if the actual sample rate can be computed

◆ demote() [2/2]

template<typename T>

virtual demote_ret_type FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		demote_stream_type *	Stream ) const

inlineprotectedvirtual

Down grade an object.

Parameters

[in]	Target	The version of the frame specification to demote too.
[in]	Obj	The version of the object to demote.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of the previous generation.

Todo: See if the actual sample rate can be computed

◆ FrameSpecDescription() [1/2]

template<typename Object_T>

struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/2]

template<typename Object_T>

struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [1/2]

template<typename Object_T>

struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [2/2]

template<typename Object_T>

struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName() [1/2]

template<typename Object_T>

struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )

inlinestaticinherited

◆ FrameSpecName() [2/2]

template<typename Object_T>

struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )

inlinestaticinherited

◆ GetAuxParam() [1/4]

auxParam_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetAuxParam ( )

inlineinherited

◆ GetAuxParam() [2/4]

auxParam_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetAuxParam ( )

inlineinherited

◆ GetAuxParam() [3/4]

const auxParam_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetAuxParam ( ) const

inlineinherited

◆ GetAuxParam() [4/4]

const auxParam_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetAuxParam ( ) const

inlineinherited

◆ GetBW() [1/2]

BW_type FrameCPP::Version_8::FrProcDataImpl::Data::GetBW ( ) const

inlineinherited

◆ GetBW() [2/2]

BW_type FrameCPP::Version_8::FrProcDataImpl::Data::GetBW ( ) const

inlineinherited

◆ GetComment() [1/2]

const comment_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetComment ( ) const

inlineinherited

A brief description of the FrProcData structure.

Returns: A brief description of the FrProcData structure

◆ GetComment() [2/2]

const comment_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetComment ( ) const

inlineinherited

A brief description of the FrProcData structure.

Returns: A brief description of the FrProcData structure

◆ GetFRange() [1/2]

fRange_type FrameCPP::Version_8::FrProcDataImpl::Data::GetFRange ( ) const

inlineinherited

Retrieve the frequency range.

Returns: The frequency range.

◆ GetFRange() [2/2]

fRange_type FrameCPP::Version_8::FrProcDataImpl::Data::GetFRange ( ) const

inlineinherited

Retrieve the frequency range.

Returns: The frequency range.

◆ GetFShift() [1/2]

fShift_type FrameCPP::Version_8::FrProcDataImpl::Data::GetFShift ( ) const

inlineinherited

◆ GetFShift() [2/2]

fShift_type FrameCPP::Version_8::FrProcDataImpl::Data::GetFShift ( ) const

inlineinherited

◆ GetName() [1/2]

const name_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetName ( ) const

inlineinherited

Return the name associate with the FrProcData structure.

Returns: The name associated with the FrProcData structure

◆ GetName() [2/2]

const name_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetName ( ) const

inlineinherited

Return the name associate with the FrProcData structure.

Returns: The name associated with the FrProcData structure

◆ GetNameSlow() [1/2]

const Data::name_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetNameSlow ( ) const

inherited

◆ GetNameSlow() [2/2]

const name_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetNameSlow ( ) const

inherited

◆ GetPhase() [1/2]

phase_type FrameCPP::Version_8::FrProcDataImpl::Data::GetPhase ( ) const

inlineinherited

◆ GetPhase() [2/2]

phase_type FrameCPP::Version_8::FrProcDataImpl::Data::GetPhase ( ) const

inlineinherited

◆ GetSubType() [1/2]

subType_type FrameCPP::Version_8::FrProcDataImpl::Data::GetSubType ( ) const

inlineinherited

◆ GetSubType() [2/2]

subType_type FrameCPP::Version_8::FrProcDataImpl::Data::GetSubType ( ) const

inlineinherited

◆ GetTimeOffset() [1/2]

timeOffset_type FrameCPP::Version_8::FrProcDataImpl::Data::GetTimeOffset ( ) const

inlineinherited

◆ GetTimeOffset() [2/2]

timeOffset_type FrameCPP::Version_8::FrProcDataImpl::Data::GetTimeOffset ( ) const

inlineinherited

◆ GetTRange() [1/2]

tRange_type FrameCPP::Version_8::FrProcDataImpl::Data::GetTRange ( ) const

inlineinherited

Retrieve the time range.

Returns: The time range.

◆ GetTRange() [2/2]

tRange_type FrameCPP::Version_8::FrProcDataImpl::Data::GetTRange ( ) const

inlineinherited

Retrieve the time range.

Returns: The time range.

◆ GetType() [1/2]

type_type FrameCPP::Version_8::FrProcDataImpl::Data::GetType ( ) const

inlineinherited

◆ GetType() [2/2]

type_type FrameCPP::Version_8::FrProcDataImpl::Data::GetType ( ) const

inlineinherited

◆ IDSubTypeToString() [1/2]

const std::string & FrameCPP::Version_8::FrProcDataImpl::Data::IDSubTypeToString	(	Data::type_type	Type,
		Data::subType_type	SubType )

staticinherited

Convert numeric sub-types to string representation.

Parameters

[in]	Type	Numeric type.
[in]	SubType	Numeric sub-type.

Returns: The string representation of SubType of Type.

◆ IDSubTypeToString() [2/2]

const std::string & FrameCPP::Version_8::FrProcDataImpl::Data::IDSubTypeToString	(	type_type	Type,
		subType_type	SubType )

staticinherited

Convert numeric sub-types to string representation.

Parameters

[in]	Type	Numeric type.
[in]	SubType	Numeric sub-type.

Returns: The string representation of SubType of Type.

◆ IDTypeToString() [1/2]

const std::string & FrameCPP::Version_8::FrProcDataImpl::Data::IDTypeToString ( Data::type_type Type )

staticinherited

Convert numeric types to string representation.

Parameters

[in] Type Numeric type.

Returns: The string representation of Type.

◆ IDTypeToString() [2/2]

const std::string & FrameCPP::Version_8::FrProcDataImpl::Data::IDTypeToString ( type_type Type )

staticinherited

Convert numeric types to string representation.

Parameters

[in] Type Numeric type.

Returns: The string representation of Type.

◆ ObjectStructName() [1/2]

template<typename T>

virtual const char * FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::ObjectStructName ( ) const

inlinevirtual

The name structure name of this object.

Returns: The name of the structure as specified by the frame specification.

◆ ObjectStructName() [2/2]

template<typename T>

virtual const char * FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::ObjectStructName ( ) const

inlinevirtual

The name structure name of this object.

Returns: The name of the structure as specified by the frame specification.

◆ operator==() [1/2]

bool FrameCPP::Version_8::FrProcDataImpl::Data::operator== ( const Data & RHS ) const

inlineinherited

equality operator

Parameters

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

inlineinherited

equality operator

Parameters

[in] RHS The FrProcData object to be compared.

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

◆ pBytes() [1/2]

template<typename T>

cmn_streamsize_type FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtual

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.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pBytes() [2/2]

template<typename T>

cmn_streamsize_type FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtual

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.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [1/2]

template<typename T>

virtual self_type * FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::pCreate ( istream_type & Stream ) const

inlineprotectedvirtual

Virtual constructor.

Parameters

[in] Stream The stream from which the earliest version of the FrProcData structure was read.

Returns: A new instance of this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [2/2]

template<typename T>

virtual self_type * FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::pCreate ( istream_type & Stream ) const

inlineprotectedvirtual

Virtual constructor.

Parameters

[in] Stream The stream from which the earliest version of the FrProcData structure was read.

Returns: A new instance of this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ Promote() [1/2]

template<typename T>

promote_ret_type FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		promote_stream_type *	Stream )

inlinestatic

Promote previous version of object to this version.

Parameters

[in]	Source	The frame specification version of the object.
[in]	Obj	The previous version of the object.
[in]	Stream	Stream from which the origional object was created.

Returns: A new instance of FrameH based on Obj

◆ Promote() [2/2]

template<typename T>

promote_ret_type FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		promote_stream_type *	Stream )

inlinestatic

Promote previous version of object to this version.

Parameters

[in]	Source	The frame specification version of the object.
[in]	Obj	The previous version of the object.
[in]	Stream	Stream from which the origional object was created.

Returns: A new instance of FrameH based on Obj

◆ promote() [1/2]

template<typename T>

virtual promote_ret_type FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		promote_stream_type *	Stream ) const

inlineprotectedvirtual

Upgrade an object.

Parameters

[in]	Target	The version of the frame specification to promote too.
[in]	Obj	The object to be promoted.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of this class.

◆ promote() [2/2]

template<typename T>

virtual promote_ret_type FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		promote_stream_type *	Stream ) const

inlineprotectedvirtual

Upgrade an object.

Parameters

[in]	Target	The version of the frame specification to promote too.
[in]	Obj	The object to be promoted.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of this class.

◆ pWrite() [1/2]

template<typename T>

virtual void FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtual

Virtual constructor.

Parameters

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pWrite() [2/2]

template<typename T>

virtual void FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtual

Virtual constructor.

Parameters

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ RefAux() [1/4]

aux_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefAux ( )

inlineinherited

Identifier for vector for auxilliary data.

Returns: A reference to the auxilliary data.

◆ RefAux() [2/4]

aux_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefAux ( )

inlineinherited

Identifier for vector for auxilliary data.

Returns: A reference to the auxilliary data.

◆ RefAux() [3/4]

const aux_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefAux ( ) const

inlineinherited

Identifier for vector for auxilliary data.

Returns: A constant reference to the auxilliary data.

◆ RefAux() [4/4]

const aux_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefAux ( ) const

inlineinherited

Identifier for vector for auxilliary data.

Returns: A constant reference to the auxilliary data.

◆ RefData() [1/4]

data_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefData ( )

inlineinherited

Identifier for vector for data vector.

Returns: A reference to the data vector.

◆ RefData() [2/4]

data_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefData ( )

inlineinherited

Identifier for vector for data vector.

Returns: A reference to the data vector.

◆ RefData() [3/4]

const data_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefData ( ) const

inlineinherited

Identifier for vector for data vector.

Returns: A constant reference to the data vector.

◆ RefData() [4/4]

const data_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefData ( ) const

inlineinherited

Identifier for vector for data vector.

Returns: A constant reference to the data vector.

◆ RefHistory() [1/4]

history_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefHistory ( )

inlineinherited

Identifier for channel history.

Returns: A reference to the channel history.

◆ RefHistory() [2/4]

history_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefHistory ( )

inlineinherited

Identifier for channel history.

Returns: A reference to the channel history.

◆ RefHistory() [3/4]

const history_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefHistory ( ) const

inlineinherited

Identifier for channel history.

Returns: A constant reference to the channel history.

◆ RefHistory() [4/4]

const history_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefHistory ( ) const

inlineinherited

Identifier for channel history.

Returns: A constant reference to the channel history.

◆ RefTable() [1/4]

table_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefTable ( )

inlineinherited

Identifier for parameter table.

Returns: A reference to the parameter table.

◆ RefTable() [2/4]

table_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefTable ( )

inlineinherited

Identifier for parameter table.

Returns: A reference to the parameter table.

◆ RefTable() [3/4]

const table_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefTable ( ) const

inlineinherited

Identifier for parameter table.

Returns: A constant reference to the parameter table.

◆ RefTable() [4/4]

const table_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefTable ( ) const

inlineinherited

Identifier for parameter table.

Returns: A constant reference to the parameter table.

◆ SetAuxParam() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetAuxParam ( const auxParam_type & AuxParams )

inlineinherited

◆ SetAuxParam() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetAuxParam ( const auxParam_type & AuxParams )

inlineinherited

◆ SetComment() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetComment ( const comment_type & Comment )

inlineinherited

◆ SetComment() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetComment ( const comment_type & Comment )

inlineinherited

◆ SetFRange() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetFRange ( fRange_type FRange )

inlineinherited

◆ SetFRange() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetFRange ( fRange_type FRange )

inlineinherited

◆ SetFShift() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetFShift ( fShift_type FShift )

inlineinherited

◆ SetFShift() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetFShift ( fShift_type FShift )

inlineinherited

◆ SetTimeOffset() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetTimeOffset ( timeOffset_type TimeOffset )

inlineinherited

◆ SetTimeOffset() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetTimeOffset ( timeOffset_type TimeOffset )

inlineinherited

◆ SetTRange() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetTRange ( tRange_type TRange )

inlineinherited

◆ SetTRange() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetTRange ( tRange_type TRange )

inlineinherited

◆ StructDescription() [1/2]

template<typename T>

const Common::Description * FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::StructDescription ( )

inlinestatic

The description of structure.

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

◆ StructDescription() [2/2]

template<typename T>

const Common::Description * FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::StructDescription ( )

inlinestatic

The description of structure.

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

◆ StructName() [1/2]

template<typename Object_T>

struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )

inlinestaticinherited

◆ StructName() [2/2]

template<typename Object_T>

struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )

inlinestaticinherited

◆ sync() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::sync ( ) const

inlineprotectedinherited

◆ sync() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::sync ( ) const

inlineprotectedinherited

◆ sync_with_vector() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::sync_with_vector ( )

inlineprotectedinherited

◆ sync_with_vector() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::sync_with_vector ( )

inlineprotectedinherited

◆ TOCQuery() [1/2]

void FrameCPP::Common::TOCInfo::TOCQuery	(	int	InfoClass,
			... ) const

inlineinherited

◆ TOCQuery() [2/2]

void FrameCPP::Common::TOCInfo::TOCQuery	(	int	InfoClass,
			... ) const

inherited

◆ vTOCQuery() [1/2]

template<typename T>

virtual void FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::vTOCQuery	(	int	InfoClass,
		va_list	vl ) const

inlineprotectedvirtual

Answer requests for information as needed by TOC.

Parameters

[in]	InfoClass	Class of information being requested.
[in]	vl	Variable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [2/2]

template<typename T>

virtual void FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >::vTOCQuery	(	int	InfoClass,
		va_list	vl ) const

inlineprotectedvirtual

Answer requests for information as needed by TOC.

Parameters

[in]	InfoClass	Class of information being requested.
[in]	vl	Variable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ Write() [1/2]

template<typename ObjectType, typename ChecksumType>

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType, typename ChecksumType>

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

Member Data Documentation

◆ aux

aux_type FrameCPP::Version_8::FrProcDataImpl::Data::aux

protectedinherited

Auxiliary data; use is generic.

◆ auxParam

auxParam_type FrameCPP::Version_8::FrProcDataImpl::Data::auxParam

protectedinherited

Auxiliary parameters.

◆ BW

BW_type FrameCPP::Version_8::FrProcDataImpl::Data::BW

protectedinherited

Resolution bandwidth.

◆ BW_UNKNOWN

constexpr BW_type FrameCPP::Version_8::FrProcDataImpl::Data::BW_UNKNOWN { 0 }

staticconstexprinherited

◆ comment

comment_type FrameCPP::Version_8::FrProcDataImpl::Data::comment

protectedinherited

Comment.

◆ data

data_type FrameCPP::Version_8::FrProcDataImpl::Data::data

protectedinherited

Data vector. The data vector fro single dimensional types (t-Series and f-Series) must have a single dimension.

◆ fRange

fRange_type FrameCPP::Version_8::FrProcDataImpl::Data::fRange

protectedinherited

Frequency range (=fMax-fMin, 0 if unknown).

◆ FRANGE_UNKNOWN

constexpr fRange_type FrameCPP::Version_8::FrProcDataImpl::Data::FRANGE_UNKNOWN { 0 }

staticconstexprinherited

◆ fShift

fShift_type FrameCPP::Version_8::FrProcDataImpl::Data::fShift

protectedinherited

fShift is the frequency in the original data that corresponds to 0 Hz in the heterodyned series

◆ history

history_type FrameCPP::Version_8::FrProcDataImpl::Data::history

protectedinherited

Channel history.

◆ m_chkSum

template<typename ObjectType, typename ChecksumType>

ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum

privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ MAX_REF

constexpr unsigned int FrameCPP::Version_8::FrProcDataImpl::Data::MAX_REF { 4 }

staticconstexprprotectedinherited

◆ name

name_type FrameCPP::Version_8::FrProcDataImpl::Data::name

protectedinherited

Channel name – must be unique with the frame.

◆ phase

phase_type FrameCPP::Version_8::FrProcDataImpl::Data::phase

protectedinherited

Phase of heterodyning signal at start of dataset (radians, 0 if unknown)

◆ PHASE_UNKNOWN

constexpr phase_type FrameCPP::Version_8::FrProcDataImpl::Data::PHASE_UNKNOWN { 0 }

staticconstexprinherited

◆ struct_desc

template<typename Object_T>

struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc

staticinherited

◆ struct_id

template<typename Object_T>

struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id

staticinherited

◆ struct_name

template<typename Object_T>

struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name

staticinherited

◆ subType

subType_type FrameCPP::Version_8::FrProcDataImpl::Data::subType

protectedinherited

Subtype for f-Series (TBD for other types).

◆ synced_with_vector_

bool FrameCPP::Version_8::FrProcDataImpl::Data::synced_with_vector_

protectedinherited

◆ table

table_type FrameCPP::Version_8::FrProcDataImpl::Data::table

protectedinherited

Parameter table.

◆ timeOffset

timeOffset_type FrameCPP::Version_8::FrProcDataImpl::Data::timeOffset

protectedinherited

Offset of 1st sample relative to the frame start time (seconds)

◆ tRange

tRange_type FrameCPP::Version_8::FrProcDataImpl::Data::tRange

protectedinherited

Duration of sampled data (tStop-tStart).

◆ type

type_type FrameCPP::Version_8::FrProcDataImpl::Data::type

protectedinherited

Type of data object.

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/Version8/impl/FrProcDataClassicIO.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version8/impl/FrProcDataClassicIO.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ aux_iterator [1/2]

◆ aux_iterator [2/2]

◆ aux_type [1/2]

◆ aux_type [2/2]

◆ AuxParam_type [1/2]

◆ AuxParam_type [2/2]

◆ auxParam_type [1/2]

◆ auxParam_type [2/2]

◆ auxParamInfo_type [1/2]

◆ auxParamInfo_type [2/2]

◆ AuxParamList_type [1/2]

◆ AuxParamList_type [2/2]

◆ BW_type [1/2]

◆ BW_type [2/2]

◆ comment_type [1/2]

◆ comment_type [2/2]

◆ const_aux_iterator [1/2]

◆ const_aux_iterator [2/2]

◆ const_history_iterator [1/2]

◆ const_history_iterator [2/2]

◆ const_iterator [1/2]

◆ const_iterator [2/2]

◆ const_table_iterator [1/2]

◆ const_table_iterator [2/2]

◆ data_type [1/2]

◆ data_type [2/2]

◆ fRange_type [1/2]

◆ fRange_type [2/2]

◆ fShift_type [1/2]

◆ fShift_type [2/2]

◆ history_iterator [1/2]

◆ history_iterator [2/2]

◆ history_type [1/2]

◆ history_type [2/2]

◆ io_comment_type [1/2]

◆ io_comment_type [2/2]

◆ io_name_type [1/2]

◆ io_name_type [2/2]

◆ istream_type [1/2]

◆ istream_type [2/2]

◆ iterator [1/2]

◆ iterator [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ object_base_type

◆ ostream_type [1/2]

◆ ostream_type [2/2]

◆ phase_type [1/2]

◆ phase_type [2/2]

◆ self_type [1/2]

◆ self_type [2/2]

◆ string_2_type [1/2]

◆ string_2_type [2/2]

◆ struct_desc_type [1/2]

◆ struct_desc_type [2/2]

◆ struct_id_type [1/2]

◆ struct_id_type [2/2]

◆ struct_name_type [1/2]

◆ struct_name_type [2/2]

◆ subType_type [1/2]

◆ subType_type [2/2]

◆ table_iterator [1/2]

◆ table_iterator [2/2]

◆ table_type [1/2]

◆ table_type [2/2]

◆ table_value_type [1/2]

◆ table_value_type [2/2]

◆ timeOffset_type [1/2]

◆ timeOffset_type [2/2]