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>

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_type & GetNameSlow () const
 Return the name associate with the FrProcData structure.
 
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_type & GetNameSlow () const
 Return the name associate with the FrProcData structure.
 
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::Description * GetDescription (ostream_type &Stream) const
 The data structure description.
 
virtual const Common::Description * GetDescription (ostream_type &Stream) const
 The data structure description.
 
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 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_type & GetName () const
 Return the name associate with the FrProcData structure.
 
const comment_type & GetComment () const
 A brief description of the FrProcData structure.
 
fRange_type GetFRange () const
 Retrieve the frequency range.
 
tRange_type GetTRange () const
 Retrieve the time range.
 
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::Description * StructDescription ()
 The description of structure.
 
static const Common::Description * StructDescription ()
 The description of structure.
 
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.
 

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.
 

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.
 

Detailed Description

Post-Processed Data Structure Definition.

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() [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

Member Function Documentation

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

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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

◆ 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/2]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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() [2/2]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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.

◆ demote() [1/2]

template<typename T >
virtual demote_ret_type FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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]

template<typename T >
virtual demote_ret_type FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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

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

template<typename T >
virtual const Common::Description * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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]

template<typename T >
virtual const Common::Description * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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.

◆ 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

◆ GetTRange()

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

Retrieve the time range.

Returns
The time range.

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

template<typename T >
virtual const char * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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]

template<typename T >
virtual const char * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ operator==() [1/3]

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/3]

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/3]

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]

template<typename T >
cmn_streamsize_type FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedinherited

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.

◆ pBytes() [2/2]

template<typename T >
cmn_streamsize_type FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedinherited

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.

◆ pCreate() [1/2]

template<typename T >
virtual self_type * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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.

◆ pCreate() [2/2]

template<typename T >
virtual self_type * FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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.

◆ Promote() [1/2]

template<typename T >
static promote_ret_type FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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]

template<typename T >
static promote_ret_type FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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]

template<typename T >
virtual promote_ret_type FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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]

template<typename T >
virtual promote_ret_type FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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]

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

Virtual constructor.

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

◆ pWrite() [2/2]

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

Virtual constructor.

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

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

◆ StructDescription() [1/2]

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

The description of structure.

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

◆ StructDescription() [2/2]

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

The description of structure.

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

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

◆ vTOCQuery() [1/2]

template<typename T >
virtual void FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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.

◆ vTOCQuery() [2/2]

template<typename T >
virtual void FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >::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.

Member Data Documentation

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

◆ 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

◆ phase

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

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

◆ timeOffset

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

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


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