ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrProcData Class Reference

Post-Processed Data Structure Definition. More...

#include <FrProcData.hh>

Inheritance diagram for FrameCPP::Version_9::FrProcData:
Collaboration diagram for FrameCPP::Version_9::FrProcData:

Public Types

typedef boost::shared_ptr< FrProcDatasubset_ret_type
 
typedef boost::shared_ptr< FrProcDatasubset_ret_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
 
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 , MIME = 7 ,
  UNKNOWN_TYPE = 0 , TIME_SERIES = 1 , FREQUENCY_SERIES = 2 , OTHER_1D_SERIES_DATA = 3 ,
  TIME_FREQUENCY = 4 , WAVELETS = 5 , MULTI_DIMENSIONAL = 6 , MIME = 7
}
 
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_9::FrProcDataImpl::Data::auxParamInfo auxParamInfo_type
 
typedef FR_PROC_DATA_NAME_TYPE name_type
 
typedef FR_PROC_DATA_COMMENT_TYPE comment_type
 
typedef FR_PROC_DATA_TYPE_TYPE type_type
 
typedef FR_PROC_DATA_SUB_TYPE_TYPE subType_type
 
typedef FR_PROC_DATA_TIME_OFFSET_TYPE timeOffset_type
 
typedef FR_PROC_DATA_T_RANGE_TYPE tRange_type
 
typedef FR_PROC_DATA_F_SHIFT_TYPE fShift_type
 
typedef FR_PROC_DATA_PHASE_TYPE phase_type
 
typedef FR_PROC_DATA_F_RANGE_TYPE fRange_type
 
typedef FR_PROC_DATA_BW_TYPE BW_type
 
typedef std::vector< auxParamInfo_typeauxParam_type
 
typedef FR_PROC_DATA_MIME_TYPE mime_type
 
typedef FR_PROC_DATA_MIME_DATA_TYPE mime_data_type
 
typedef Common::Container< FrVectdata_type
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::iterator iterator
 
typedef Common::Container< FrVectaux_type
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef aux_type::iterator aux_iterator
 
typedef Common::Container< FrTabletable_type
 
typedef FrTable table_value_type
 
typedef table_type::const_iterator const_table_iterator
 
typedef table_type::iterator table_iterator
 
typedef Common::Container< FrHistoryhistory_type
 
typedef history_type::const_iterator const_history_iterator
 
typedef history_type::iterator history_iterator
 
typedef REAL_8 sampleRate_v3_type
 
typedef INT_4U timeOffsetS_v3_type
 
typedef INT_4U timeOffsetN_v3_type
 
typedef auxParam_type AuxParamList_type
 
typedef auxParam_type::value_type AuxParam_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 

Public Member Functions

 FrProcData ()=default
 Default constructor.
 
 FrProcData (const FrProcData &Source)=default
 Copy Constructor.
 
 FrProcData (const name_type &Name, const comment_type &Comment, type_type Type, subType_type SubType, timeOffset_type TimeOffset, tRange_type TRange, fShift_type FShift, phase_type Phase, fRange_type FRange, BW_type BW)
 Constructor.
 
 FrProcData (Previous::FrProcData &Source, stream_base_type *Stream)
 Promotion Constructor.
 
 ~FrProcData ()
 Destructor.
 
const name_typeGetNameSlow () const
 Return the name associate with the FrProcData structure.
 
bool operator== (const FrProcData &RHS) const
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator for abstract data type
 
FrProcDataMerge (const FrProcData &RHS)
 Merge with another FrProcData.
 
subset_ret_type Subset (REAL_8 Offset, REAL_8 Dt) const
 Request a subset of the data.
 
 FrProcData ()=default
 Default constructor.
 
 FrProcData (const FrProcData &Source)=default
 Copy Constructor.
 
 FrProcData (const name_type &Name, const comment_type &Comment, type_type Type, subType_type SubType, timeOffset_type TimeOffset, tRange_type TRange, fShift_type FShift, phase_type Phase, fRange_type FRange, BW_type BW)
 Constructor.
 
 FrProcData (Previous::FrProcData &Source, stream_base_type *Stream)
 Promotion Constructor.
 
 ~FrProcData ()
 Destructor.
 
const name_typeGetNameSlow () const
 Return the name associate with the FrProcData structure.
 
bool operator== (const FrProcData &RHS) const
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator for abstract data type
 
FrProcDataMerge (const FrProcData &RHS)
 Merge with another FrProcData.
 
subset_ret_type Subset (REAL_8 Offset, REAL_8 Dt) const
 Request a subset of the data.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const Common::DescriptionGetDescription (ostream_type &Stream) const
 The data structure description.
 
virtual const Common::DescriptionGetDescription (ostream_type &Stream) const
 The data structure description.
 
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_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (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.
 
void AppendComment (const std::string &Comment)
 
void AppendAuxParam (const auxParam_type::value_type &Param)
 
void AppendMIME (const mime_type &Type, mime_data_type *Data, std::size_t Size, const name_type &Name="")
 Append MIME data to the FrProData structure.
 
const name_typeGetName () const
 Return the name associate with the FrProcData structure.
 
const comment_typeGetComment () const
 A brief description of the FrProcData structure.
 
type_type GetType () const
 
subType_type GetSubType () const
 
timeOffset_type GetTimeOffset () const
 
fShift_type GetFShift () const
 
phase_type GetPhase () const
 
BW_type GetBW () const
 
const auxParam_typeGetAuxParam () const
 
auxParam_typeGetAuxParam ()
 
fRange_type GetFRange () const
 Retrieve the frequency range.
 
tRange_type GetTRange () const
 Retrieve the time range.
 
void SetAuxParam (const auxParam_type &AuxParams)
 
void SetComment (const comment_type &Comment)
 
void SetFRange (fRange_type FRange)
 
void SetFShift (fShift_type FShift)
 
void SetTimeOffset (timeOffset_type TimeOffset)
 
void SetTRange (tRange_type TRange)
 
const aux_typeRefAux () const
 Identifier for vector for auxilliary data.
 
aux_typeRefAux ()
 Identifier for vector for auxilliary data.
 
const data_typeRefData () const
 Identifier for vector for data vector.
 
data_typeRefData ()
 Identifier for vector for data vector.
 
const table_typeRefTable () const
 Identifier for parameter table.
 
table_typeRefTable ()
 Identifier for parameter table.
 
const history_typeRefHistory () const
 Identifier for channel history.
 
history_typeRefHistory ()
 Identifier for channel history.
 
bool operator== (const Data &RHS) const
 equality operator
 

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 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::DescriptionStructDescription ()
 The description of structure.
 
static const Common::DescriptionStructDescription ()
 The description of 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 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 struct_name_type FrameSpecName ()
 
static struct_name_type StructName ()
 
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 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 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 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.
 
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.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Virtual constructor.
 
void copy_core (const Data &Source)
 Copy core data.
 
void sync () const
 
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 ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data.
 
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data.
 
typedef STRING io_name_type
 
typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef STRING io_comment_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 

Private Member Functions

subset_ret_type sub_time_series (REAL_8 Offset, REAL_8 Dt) const
 Retrieve a time series subset.
 
subset_ret_type sub_time_series (REAL_8 Offset, REAL_8 Dt) const
 Retrieve a time series subset.
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 

Private Attributes

ChecksumType m_chkSum
 Structure checksum.
 

Detailed Description

Post-Processed Data Structure Definition.

Member Typedef Documentation

◆ aux_iterator

◆ aux_type

◆ AuxParam_type

typedef auxParam_type::value_type FrameCPP::Version_9::FrProcDataImpl::Data::AuxParam_type
inherited

◆ auxParam_type

◆ auxParamInfo_type

◆ AuxParamList_type

◆ BW_type

◆ comment_type

◆ const_aux_iterator

◆ const_history_iterator

◆ const_iterator

◆ const_table_iterator

◆ data_type

◆ fRange_type

◆ fShift_type

◆ history_iterator

◆ history_type

◆ io_comment_type [1/2]

typedef STRING FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::io_comment_type
privateinherited

◆ io_comment_type [2/2]

typedef STRING FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::io_comment_type
privateinherited

◆ io_name_type [1/2]

typedef STRING FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::io_name_type
privateinherited

◆ io_name_type [2/2]

typedef STRING FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::io_name_type
privateinherited

◆ 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

◆ mime_data_type

◆ mime_type

◆ name_type

◆ object_base_type [1/3]

◆ object_base_type [2/3]

◆ object_base_type [3/3]

◆ object_type [1/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_9::FrProcData::object_type
private

Object with checksum data.

◆ object_type [2/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_9::FrProcData::object_type
private

Object with checksum data.

◆ 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

◆ sampleRate_v3_type

◆ 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

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

◆ struct_id_type

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type

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

◆ subset_ret_type [1/2]

typedef boost::shared_ptr< FrProcData > FrameCPP::Version_9::FrProcData::subset_ret_type

◆ subset_ret_type [2/2]

typedef boost::shared_ptr< FrProcData > FrameCPP::Version_9::FrProcData::subset_ret_type

◆ subType_type

◆ table_iterator

◆ table_type

◆ table_value_type

◆ timeOffset_type

◆ timeOffsetN_v3_type

◆ timeOffsetS_v3_type

◆ tRange_type

◆ type_type

Member Enumeration Documentation

◆ 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 

◆ 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 

◆ e_subType_type

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

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

Constructor & Destructor Documentation

◆ FrProcData() [1/8]

FrameCPP::Version_9::FrProcData::FrProcData ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrProcData() [2/8]

FrameCPP::Version_9::FrProcData::FrProcData ( const FrProcData & Source)
default

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrProcData() [3/8]

FrameCPP::Version_9::FrProcData::FrProcData ( const name_type & Name,
const comment_type & Comment,
type_type Type,
subType_type SubType,
timeOffset_type TimeOffset,
tRange_type TRange,
fShift_type FShift,
phase_type Phase,
fRange_type FRange,
BW_type BW )

Constructor.

Parameters
[in]NameData or channel name
[in]CommentComment
[in]TypeType of data object.
[in]SubTypeSubtype of f-Series.
[in]TimeOffsetOfset of 1st sample relative to the frame start time.
[in]TRangeDuration of sampled data.
[in]FShiftThe frequency in the original data that corresponds to zero Hz in the heterodyned series.
[in]PhasePhase of heterodyning signal at start of dataset.
[in]FRangeFrequency range.
[in]BWResolution bandwidth.
Returns
A new instance of this object.

◆ FrProcData() [4/8]

FrameCPP::Version_9::FrProcData::FrProcData ( Previous::FrProcData & Source,
stream_base_type * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrProcData structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrProcData structure was read.
Returns
A new instance of an FrProcData object

◆ ~FrProcData() [1/2]

FrameCPP::Version_9::FrProcData::~FrProcData ( )

Destructor.

◆ FrProcData() [5/8]

FrameCPP::Version_9::FrProcData::FrProcData ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrProcData() [6/8]

FrameCPP::Version_9::FrProcData::FrProcData ( const FrProcData & Source)
default

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrProcData() [7/8]

FrameCPP::Version_9::FrProcData::FrProcData ( const name_type & Name,
const comment_type & Comment,
type_type Type,
subType_type SubType,
timeOffset_type TimeOffset,
tRange_type TRange,
fShift_type FShift,
phase_type Phase,
fRange_type FRange,
BW_type BW )

Constructor.

Parameters
[in]NameData or channel name
[in]CommentComment
[in]TypeType of data object.
[in]SubTypeSubtype of f-Series.
[in]TimeOffsetOfset of 1st sample relative to the frame start time.
[in]TRangeDuration of sampled data.
[in]FShiftThe frequency in the original data that corresponds to zero Hz in the heterodyned series.
[in]PhasePhase of heterodyning signal at start of dataset.
[in]FRangeFrequency range.
[in]BWResolution bandwidth.
Returns
A new instance of this object.

◆ FrProcData() [8/8]

FrameCPP::Version_9::FrProcData::FrProcData ( Previous::FrProcData & Source,
stream_base_type * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrProcData structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrProcData structure was read.
Returns
A new instance of an FrProcData object

◆ ~FrProcData() [2/2]

FrameCPP::Version_9::FrProcData::~FrProcData ( )

Destructor.

Member Function Documentation

◆ AppendAuxParam()

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

◆ AppendComment()

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

◆ AppendMIME()

void FrameCPP::Version_9::FrProcDataImpl::Data::AppendMIME ( const mime_type & Type,
mime_data_type * Data,
std::size_t Size,
const name_type & Name = "" )
inlineinherited

Append MIME data to the FrProData structure.

Create or append to list of MIME data associated with the FrProcData structure.

Parameters
[in]TypeMIME type as a character string (ex: text/plain)
[in]DataOpeque blob of MIME content @paran[in] Size Size of Data
[in]NameName for the FrVect (Default: Same as the name for the FrProcData)
Note
  • This library does not supply any native support for interpretation of MIME types or associated data
  • A list of MIME types can be found here

◆ 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]StreamStream 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]StreamStream 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>
static 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>
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ copy_core()

void FrameCPP::Version_9::FrProcDataImpl::Data::copy_core ( const Data & Source)
inlineprotectedinherited

Copy core data.

Parameters
[in]SourceThe 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

◆ Create() [2/6]

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

◆ 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]StreamThe 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]StreamThe 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>
static int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [2/4]

template<class T>
static int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [3/4]

template<class T>
static int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ DataType() [4/4]

template<class T>
static int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ demote() [1/2]

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

Down grade an object.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe 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]

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

Down grade an object.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe 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()

template<typename Object_T>
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId()

template<typename Object_T>
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName()

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ GetAuxParam() [1/2]

auxParam_type & FrameCPP::Version_9::FrProcDataImpl::Data::GetAuxParam ( )
inlineinherited

◆ GetAuxParam() [2/2]

const auxParam_type & FrameCPP::Version_9::FrProcDataImpl::Data::GetAuxParam ( ) const
inlineinherited

◆ GetBW()

BW_type FrameCPP::Version_9::FrProcDataImpl::Data::GetBW ( ) const
inlineinherited

◆ GetComment()

const comment_type & FrameCPP::Version_9::FrProcDataImpl::Data::GetComment ( ) const
inlineinherited

A brief description of the FrProcData structure.

Returns
A brief description of the FrProcData structure

◆ GetDescription() [1/2]

virtual const Common::Description * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::GetDescription ( ostream_type & Stream) const
inlinevirtualinherited

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

◆ GetDescription() [2/2]

virtual const Common::Description * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::GetDescription ( ostream_type & Stream) const
inlinevirtualinherited

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

◆ GetFRange()

fRange_type FrameCPP::Version_9::FrProcDataImpl::Data::GetFRange ( ) const
inlineinherited

Retrieve the frequency range.

Returns
The frequency range.

◆ GetFShift()

fShift_type FrameCPP::Version_9::FrProcDataImpl::Data::GetFShift ( ) const
inlineinherited

◆ GetName()

const name_type & FrameCPP::Version_9::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 name_type & FrameCPP::Version_9::FrProcData::GetNameSlow ( ) const
inline

Return the name associate with the FrProcData structure.

Returns
The name associated with the FrProcData structure

◆ GetNameSlow() [2/2]

const name_type & FrameCPP::Version_9::FrProcData::GetNameSlow ( ) const
inline

Return the name associate with the FrProcData structure.

Returns
The name associated with the FrProcData structure

◆ GetPhase()

phase_type FrameCPP::Version_9::FrProcDataImpl::Data::GetPhase ( ) const
inlineinherited

◆ GetSubType()

subType_type FrameCPP::Version_9::FrProcDataImpl::Data::GetSubType ( ) const
inlineinherited

◆ GetTimeOffset()

timeOffset_type FrameCPP::Version_9::FrProcDataImpl::Data::GetTimeOffset ( ) const
inlineinherited

◆ GetTRange()

tRange_type FrameCPP::Version_9::FrProcDataImpl::Data::GetTRange ( ) const
inlineinherited

Retrieve the time range.

Returns
The time range.

◆ GetType()

type_type FrameCPP::Version_9::FrProcDataImpl::Data::GetType ( ) const
inlineinherited

◆ IDSubTypeToString()

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

Convert numeric sub-types to string representation.

Parameters
[in]TypeNumeric type.
[in]SubTypeNumeric sub-type.
Returns
The string representation of SubType of Type.

◆ IDTypeToString()

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

Convert numeric types to string representation.

Parameters
[in]TypeNumeric type.
Returns
The string representation of Type.

◆ Merge() [1/2]

FrProcData & FrameCPP::Version_9::FrProcData::Merge ( const FrProcData & RHS)

Merge with another FrProcData.

Parameters
[in]RHSThe source of the information to append to this FrProcData structure.
Returns
A reference to this object
Todo
Need to implement Merge routine

◆ Merge() [2/2]

FrProcData & FrameCPP::Version_9::FrProcData::Merge ( const FrProcData & RHS)

Merge with another FrProcData.

Parameters
[in]RHSThe source of the information to append to this FrProcData structure.
Returns
A reference to this object

◆ ObjectStructName() [1/2]

virtual const char * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ operator==() [1/5]

bool FrameCPP::Version_9::FrProcData::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

equality operator for abstract data type

Parameters
[in]ObjThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/5]

virtual bool FrameCPP::Version_9::FrProcData::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

equality operator for abstract data type

Parameters
[in]ObjThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/5]

bool FrameCPP::Version_9::FrProcData::operator== ( const FrProcData & RHS) const
inline

◆ operator==() [4/5]

bool FrameCPP::Version_9::FrProcData::operator== ( const FrProcData & RHS) const
inline

◆ operator==() [5/5]

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

equality operator

Parameters
[in]RHSThe 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]

cmn_streamsize_type FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

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

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

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

◆ pCreate() [1/2]

virtual self_type * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

Parameters
[in]StreamThe 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]

virtual self_type * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

Parameters
[in]StreamThe 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]

static promote_ret_type FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestaticinherited

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestaticinherited

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ promote() [1/2]

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

Upgrade an object.

Parameters
[in]TargetThe version of the frame specification to promote too.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object of this class.

◆ promote() [2/2]

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

Upgrade an object.

Parameters
[in]TargetThe version of the frame specification to promote too.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object of this class.

◆ pWrite() [1/2]

virtual void FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

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

◆ pWrite() [2/2]

virtual void FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

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

◆ RefAux() [1/2]

aux_type & FrameCPP::Version_9::FrProcDataImpl::Data::RefAux ( )
inlineinherited

Identifier for vector for auxilliary data.

Returns
A reference to the auxilliary data.

◆ RefAux() [2/2]

const aux_type & FrameCPP::Version_9::FrProcDataImpl::Data::RefAux ( ) const
inlineinherited

Identifier for vector for auxilliary data.

Returns
A constant reference to the auxilliary data.

◆ RefData() [1/2]

data_type & FrameCPP::Version_9::FrProcDataImpl::Data::RefData ( )
inlineinherited

Identifier for vector for data vector.

Returns
A reference to the data vector.

◆ RefData() [2/2]

const data_type & FrameCPP::Version_9::FrProcDataImpl::Data::RefData ( ) const
inlineinherited

Identifier for vector for data vector.

Returns
A constant reference to the data vector.

◆ RefHistory() [1/2]

history_type & FrameCPP::Version_9::FrProcDataImpl::Data::RefHistory ( )
inlineinherited

Identifier for channel history.

Returns
A reference to the channel history.

◆ RefHistory() [2/2]

const history_type & FrameCPP::Version_9::FrProcDataImpl::Data::RefHistory ( ) const
inlineinherited

Identifier for channel history.

Returns
A constant reference to the channel history.

◆ RefTable() [1/2]

table_type & FrameCPP::Version_9::FrProcDataImpl::Data::RefTable ( )
inlineinherited

Identifier for parameter table.

Returns
A reference to the parameter table.

◆ RefTable() [2/2]

const table_type & FrameCPP::Version_9::FrProcDataImpl::Data::RefTable ( ) const
inlineinherited

Identifier for parameter table.

Returns
A constant reference to the parameter table.

◆ SetAuxParam()

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

◆ SetComment()

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

◆ SetFRange()

void FrameCPP::Version_9::FrProcDataImpl::Data::SetFRange ( fRange_type FRange)
inlineinherited

◆ SetFShift()

void FrameCPP::Version_9::FrProcDataImpl::Data::SetFShift ( fShift_type FShift)
inlineinherited

◆ SetTimeOffset()

void FrameCPP::Version_9::FrProcDataImpl::Data::SetTimeOffset ( timeOffset_type TimeOffset)
inlineinherited

◆ SetTRange()

void FrameCPP::Version_9::FrProcDataImpl::Data::SetTRange ( tRange_type TRange)
inlineinherited

◆ StructDescription() [1/2]

static const Common::Description * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructName()

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ sub_time_series() [1/2]

FrProcData::subset_ret_type FrameCPP::Version_9::FrProcData::sub_time_series ( REAL_8 Offset,
REAL_8 Dt ) const
private

Retrieve a time series subset.

Parameters
[in]OffsetThe number of seconds from the start of the FrProcData object from which to start extracting data.
[in]DtThe number of seconds of data in the resulting FrProcData strucutre.
Returns
A FrProcData structure which contains Dt seconds of data starting at Offset of this FrProcData structure.
Todo
Ensure the dimension of the FrVect is 1
Todo
Ensure the requested range is valid
Todo
Get the slice of FrVect

◆ sub_time_series() [2/2]

subset_ret_type FrameCPP::Version_9::FrProcData::sub_time_series ( REAL_8 Offset,
REAL_8 Dt ) const
private

Retrieve a time series subset.

Parameters
[in]OffsetThe number of seconds from the start of the FrProcData object from which to start extracting data.
[in]DtThe number of seconds of data in the resulting FrProcData strucutre.
Returns
A FrProcData structure which contains Dt seconds of data starting at Offset of this FrProcData structure.

◆ Subset() [1/2]

FrProcData::subset_ret_type FrameCPP::Version_9::FrProcData::Subset ( REAL_8 Offset,
REAL_8 Dt ) const

Request a subset of the data.

Parameters
[in]OffsetThe number of seconds from the start of the FrProcData object from which to start extracting data.
[in]DtThe number of seconds of data in the resulting FrProcData strucutre.
Returns
A FrProcData structure which contains Dt seconds of data starting at Offset of this FrProcData structure.

◆ Subset() [2/2]

subset_ret_type FrameCPP::Version_9::FrProcData::Subset ( REAL_8 Offset,
REAL_8 Dt ) const

Request a subset of the data.

Parameters
[in]OffsetThe number of seconds from the start of the FrProcData object from which to start extracting data.
[in]DtThe number of seconds of data in the resulting FrProcData strucutre.
Returns
A FrProcData structure which contains Dt seconds of data starting at Offset of this FrProcData structure.

◆ sync()

void FrameCPP::Version_9::FrProcDataImpl::Data::sync ( ) const
inlineprotectedinherited

◆ sync_with_vector()

void FrameCPP::Version_9::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]

virtual void FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::vTOCQuery ( int InfoClass,
va_list vl ) const
inlineprotectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [2/2]

virtual void FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >::vTOCQuery ( int InfoClass,
va_list vl ) const
inlineprotectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable 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_9::FrProcDataImpl::Data::aux
protectedinherited

Auxiliary data; use is generic.

◆ auxParam

auxParam_type FrameCPP::Version_9::FrProcDataImpl::Data::auxParam
protectedinherited

Auxiliary parameters.

◆ BW

BW_type FrameCPP::Version_9::FrProcDataImpl::Data::BW
protectedinherited

Resolution bandwidth.

◆ BW_UNKNOWN

static constexpr BW_type FrameCPP::Version_9::FrProcDataImpl::Data::BW_UNKNOWN { 0 }
staticconstexprinherited

◆ comment

comment_type FrameCPP::Version_9::FrProcDataImpl::Data::comment
protectedinherited

Comment.

◆ data

data_type FrameCPP::Version_9::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_9::FrProcDataImpl::Data::fRange
protectedinherited

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

◆ FRANGE_UNKNOWN

static constexpr fRange_type FrameCPP::Version_9::FrProcDataImpl::Data::FRANGE_UNKNOWN { 0 }
staticconstexprinherited

◆ fShift

fShift_type FrameCPP::Version_9::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_9::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

static constexpr unsigned int FrameCPP::Version_9::FrProcDataImpl::Data::MAX_REF { 4 }
staticconstexprprotectedinherited

◆ name

name_type FrameCPP::Version_9::FrProcDataImpl::Data::name
protectedinherited

Channel name – must be unique with the frame.

◆ phase

phase_type FrameCPP::Version_9::FrProcDataImpl::Data::phase
protectedinherited

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

◆ PHASE_UNKNOWN

static constexpr phase_type FrameCPP::Version_9::FrProcDataImpl::Data::PHASE_UNKNOWN { 0 }
staticconstexprinherited

◆ struct_desc

template<typename Object_T>
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T>
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

◆ subType

subType_type FrameCPP::Version_9::FrProcDataImpl::Data::subType
protectedinherited

Subtype for f-Series (TBD for other types)

◆ synced_with_vector_

bool FrameCPP::Version_9::FrProcDataImpl::Data::synced_with_vector_
protectedinherited

◆ table

table_type FrameCPP::Version_9::FrProcDataImpl::Data::table
protectedinherited

Parameter table.

◆ timeOffset

timeOffset_type FrameCPP::Version_9::FrProcDataImpl::Data::timeOffset
protectedinherited

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

◆ tRange

tRange_type FrameCPP::Version_9::FrProcDataImpl::Data::tRange
protectedinherited

Duration of sampled data (tStop-tStart)

◆ type

type_type FrameCPP::Version_9::FrProcDataImpl::Data::type
protectedinherited

Type of data object.


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