ldas-tools-framecpp  2.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::FrProcData Class Referenceabstract

Post-Processed Data Structure Definition. More...

#include <FrProcData.hh>

Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrameCPP::Common::TOCInfo, FrProcDataNPS, FrProcDataPS, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrameCPP::Common::TOCInfo, FrProcDataNPS, and FrProcDataPS.

Public Member Functions

 FrProcData ()
 Default constructor. More...
 
 FrProcData (const FrProcData &Source)
 Copy Constructor. More...
 
 FrProcData (const std::string &Name, const std::string &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. More...
 
 FrProcData (Previous::FrProcData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
 ~FrProcData ()
 Destructor.
 
bool operator== (const FrProcData &RHS) const
 equality operator More...
 
bool operator!= (const FrProcData &RHS) const
 inequality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator for abstract data type More...
 
fRange_type GetFRange () const
 Retrieve the frequency range. More...
 
tRange_type GetTRange () const
 Retrieve the time range. More...
 
const std::string & GetNameSlow () const
 Return the name associate with the FrProcData structure. More...
 
FrProcDataMerge (const FrProcData &RHS)
 Merge with another FrProcData. More...
 
subset_ret_type Subset (REAL_8 Offset, REAL_8 Dt) const
 Request a subset of the data. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
 FrProcData ()
 Default constructor. More...
 
 FrProcData (const FrProcData &Source)
 Copy Constructor. More...
 
 FrProcData (const std::string &Name, const std::string &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. More...
 
 FrProcData (Previous::FrProcData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
 ~FrProcData ()
 Destructor.
 
bool operator== (const FrProcData &RHS) const
 equality operator More...
 
bool operator!= (const FrProcData &RHS) const
 inequality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator for abstract data type More...
 
fRange_type GetFRange () const
 Retrieve the frequency range. More...
 
tRange_type GetTRange () const
 Retrieve the time range. More...
 
const std::string & GetNameSlow () const
 Return the name associate with the FrProcData structure. More...
 
FrProcDataMerge (const FrProcData &RHS)
 Merge with another FrProcData. More...
 
subset_ret_type Subset (REAL_8 Offset, REAL_8 Dt) const
 Request a subset of the data. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
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, istream_type *Stream)
 Promote previous version of object to this version. More...
 
static const char * StructName ()
 The name structure name of this object. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static const std::string & IDTypeToString (type_type Type)
 Convert numeric types to string representation. More...
 
static const std::string & IDSubTypeToString (type_type Type, subType_type SubType)
 Convert numeric sub-types to string representation. More...
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version. More...
 
static const char * StructName ()
 The name structure name of this object. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static const std::string & IDTypeToString (type_type Type)
 Convert numeric types to string representation. More...
 
static const std::string & IDSubTypeToString (type_type Type, subType_type SubType)
 Convert numeric sub-types to string representation. More...
 
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.
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrProcDatapCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (ostream_type &Stream) const
 Virtual constructor. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrProcDatapCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (ostream_type &Stream) const
 Virtual constructor. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
virtual void pWrite (ostream_type &Stream) const=0
 Write the structure to the stream. More...
 

Detailed Description

Post-Processed Data Structure Definition.

Constructor & Destructor Documentation

◆ FrProcData() [1/8]

FrameCPP::Version_8::FrProcData::FrProcData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrProcData() [2/8]

FrameCPP::Version_8::FrProcData::FrProcData ( const FrProcData Source)

Copy Constructor.

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

◆ FrProcData() [3/8]

FrameCPP::Version_8::FrProcData::FrProcData ( const std::string &  Name,
const std::string &  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_8::FrProcData::FrProcData ( Previous::FrProcData &  Source,
istream_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_8::FrProcData::FrProcData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrProcData() [6/8]

FrameCPP::Version_8::FrProcData::FrProcData ( const FrProcData Source)

Copy Constructor.

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

◆ FrProcData() [7/8]

FrameCPP::Version_8::FrProcData::FrProcData ( const std::string &  Name,
const std::string &  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_8::FrProcData::FrProcData ( Previous::FrProcData &  Source,
istream_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

◆ 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

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

FrProcData::demote_ret_type FrameCPP::Version_8::FrProcData::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
protectedvirtual

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_8::FrProcData::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
protectedvirtual

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.

◆ GetFRange() [1/2]

REAL_8 FrameCPP::Version_8::FrProcData::GetFRange ( ) const
inline

Retrieve the frequency range.

Returns
The frequency range.

◆ GetFRange() [2/2]

fRange_type FrameCPP::Version_8::FrProcData::GetFRange ( ) const

Retrieve the frequency range.

Returns
The frequency range.

◆ GetNameSlow() [1/2]

const std::string & FrameCPP::Version_8::FrProcData::GetNameSlow ( ) const

Return the name associate with the FrProcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetNameSlow() [2/2]

const std::string& FrameCPP::Version_8::FrProcData::GetNameSlow ( ) const

Return the name associate with the FrProcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetTRange() [1/2]

FrProcData::tRange_type FrameCPP::Version_8::FrProcData::GetTRange ( ) const
inline

Retrieve the time range.

Returns
The time range.

◆ GetTRange() [2/2]

tRange_type FrameCPP::Version_8::FrProcData::GetTRange ( ) const

Retrieve the time range.

Returns
The time range.

◆ IDSubTypeToString() [1/2]

const std::string & FrameCPP::Version_8::FrProcData::IDSubTypeToString ( type_type  Type,
subType_type  SubType 
)
static

Convert numeric sub-types to string representation.

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

◆ IDSubTypeToString() [2/2]

static const std::string& FrameCPP::Version_8::FrProcData::IDSubTypeToString ( type_type  Type,
subType_type  SubType 
)
static

Convert numeric sub-types to string representation.

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

◆ IDTypeToString() [1/2]

const std::string & FrameCPP::Version_8::FrProcData::IDTypeToString ( type_type  Type)
static

Convert numeric types to string representation.

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

◆ IDTypeToString() [2/2]

static const std::string& FrameCPP::Version_8::FrProcData::IDTypeToString ( type_type  Type)
static

Convert numeric types to string representation.

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

◆ Merge() [1/2]

FrProcData & FrameCPP::Version_8::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_8::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]

const char * FrameCPP::Version_8::FrProcData::ObjectStructName ( ) const
virtual

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_8::FrProcData::ObjectStructName ( ) const
virtual

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::FrProcData::operator!= ( const FrProcData RHS) const
inline

inequality operator

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

◆ operator!=() [2/2]

bool FrameCPP::Version_8::FrProcData::operator!= ( const FrProcData RHS) const

inequality operator

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

◆ operator==() [1/4]

bool FrameCPP::Version_8::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/4]

virtual bool FrameCPP::Version_8::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/4]

bool FrameCPP::Version_8::FrProcData::operator== ( const FrProcData RHS) const
inline

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.

◆ operator==() [4/4]

bool FrameCPP::Version_8::FrProcData::operator== ( const FrProcData RHS) const

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]

FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrProcData::pBytes ( const Common::StreamBase &  Stream) const
protectedvirtual

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, checksum_type >.

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::FrProcData::pBytes ( const Common::StreamBase &  Stream) const
protectedvirtual

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, checksum_type >.

◆ pCreate() [1/2]

FrProcData * FrameCPP::Version_8::FrProcData::pCreate ( istream_type &  Stream) const
protectedvirtual

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, checksum_type >.

◆ pCreate() [2/2]

virtual FrProcData* FrameCPP::Version_8::FrProcData::pCreate ( istream_type &  Stream) const
protectedvirtual

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, checksum_type >.

◆ Promote() [1/2]

FrProcData::promote_ret_type FrameCPP::Version_8::FrProcData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
inlinestatic

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_8::FrProcData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
static

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]

FrProcData::promote_ret_type FrameCPP::Version_8::FrProcData::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
protectedvirtual

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_8::FrProcData::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
protectedvirtual

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

void FrameCPP::Version_8::FrProcData::pWrite ( ostream_type &  Stream) const
protectedvirtual

Virtual constructor.

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

◆ pWrite() [2/3]

virtual void FrameCPP::Version_8::FrProcData::pWrite ( ostream_type &  Stream) const
protectedvirtual

Virtual constructor.

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

◆ pWrite() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pWrite ( ostream_type &  Stream) const
protectedpure virtualinherited

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_8::FrProcData::StructDescription ( )
static

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_8::FrProcData::StructDescription ( )
static

The description of structure.

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

◆ StructName() [1/2]

const char * FrameCPP::Version_8::FrProcData::StructName ( )
inlinestatic

The name structure name of this object.

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

◆ StructName() [2/2]

static const char* FrameCPP::Version_8::FrProcData::StructName ( )
static

The name structure name of this object.

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

◆ Subset() [1/2]

FrProcData::subset_ret_type FrameCPP::Version_8::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_8::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]

void FrameCPP::Version_8::FrProcData::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

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]

virtual void FrameCPP::Version_8::FrProcData::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

Answer requests for information as needed by TOC.

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

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