ldas-tools-framecpp
2.7.0
|
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... | |
FrProcData & | Merge (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... | |
FrProcData & | Merge (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_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual self_type * | Create (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 FrProcData * | pCreate (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 FrProcData * | pCreate (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... | |
Post-Processed Data Structure Definition.
FrameCPP::Version_8::FrProcData::FrProcData | ( | ) |
Default constructor.
FrameCPP::Version_8::FrProcData::FrProcData | ( | const FrProcData & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
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.
[in] | Name | Data or channel name |
[in] | Comment | Comment |
[in] | Type | Type of data object. |
[in] | SubType | Subtype of f-Series. |
[in] | TimeOffset | Ofset of 1st sample relative to the frame start time. |
[in] | TRange | Duration of sampled data. |
[in] | FShift | The frequency in the original data that corresponds to zero Hz in the heterodyned series. |
[in] | Phase | Phase of heterodyning signal at start of dataset. |
[in] | FRange | Frequency range. |
[in] | BW | Resolution bandwidth. |
FrameCPP::Version_8::FrProcData::FrProcData | ( | Previous::FrProcData & | Source, |
istream_type * | Stream | ||
) |
Promotion Constructor.
[in] | Source | An FrProcData structure from a previous frame specification. |
[in] | Stream | The stream from which the earliest version of the FrProcData structure was read. |
FrameCPP::Version_8::FrProcData::FrProcData | ( | ) |
Default constructor.
FrameCPP::Version_8::FrProcData::FrProcData | ( | const FrProcData & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
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.
[in] | Name | Data or channel name |
[in] | Comment | Comment |
[in] | Type | Type of data object. |
[in] | SubType | Subtype of f-Series. |
[in] | TimeOffset | Ofset of 1st sample relative to the frame start time. |
[in] | TRange | Duration of sampled data. |
[in] | FShift | The frequency in the original data that corresponds to zero Hz in the heterodyned series. |
[in] | Phase | Phase of heterodyning signal at start of dataset. |
[in] | FRange | Frequency range. |
[in] | BW | Resolution bandwidth. |
FrameCPP::Version_8::FrProcData::FrProcData | ( | Previous::FrProcData & | Source, |
istream_type * | Stream | ||
) |
Promotion Constructor.
[in] | Source | An FrProcData structure from a previous frame specification. |
[in] | Stream | The stream from which the earliest version of the FrProcData structure was read. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
protectedvirtual |
Down grade an object.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
|
protectedvirtual |
Down grade an object.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
fRange_type FrameCPP::Version_8::FrProcData::GetFRange | ( | ) | const |
Retrieve the frequency range.
|
inline |
Retrieve the frequency range.
const std::string & FrameCPP::Version_8::FrProcData::GetNameSlow | ( | ) | const |
Return the name associate with the FrProcData structure.
const std::string& FrameCPP::Version_8::FrProcData::GetNameSlow | ( | ) | const |
Return the name associate with the FrProcData structure.
|
inline |
Retrieve the time range.
tRange_type FrameCPP::Version_8::FrProcData::GetTRange | ( | ) | const |
Retrieve the time range.
|
static |
Convert numeric sub-types to string representation.
[in] | Type | Numeric type. |
[in] | SubType | Numeric sub-type. |
|
static |
Convert numeric sub-types to string representation.
[in] | Type | Numeric type. |
[in] | SubType | Numeric sub-type. |
|
static |
Convert numeric types to string representation.
[in] | Type | Numeric type. |
|
static |
Convert numeric types to string representation.
[in] | Type | Numeric type. |
FrProcData & FrameCPP::Version_8::FrProcData::Merge | ( | const FrProcData & | RHS | ) |
Merge with another FrProcData.
[in] | RHS | The source of the information to append to this FrProcData structure. |
FrProcData& FrameCPP::Version_8::FrProcData::Merge | ( | const FrProcData & | RHS | ) |
Merge with another FrProcData.
[in] | RHS | The source of the information to append to this FrProcData structure. |
|
virtual |
The name structure name of this object.
|
virtual |
The name structure name of this object.
|
inline |
inequality operator
[in] | RHS | The FrProcData object to be compared. |
bool FrameCPP::Version_8::FrProcData::operator!= | ( | const FrProcData & | RHS | ) | const |
inequality operator
[in] | RHS | The FrProcData object to be compared. |
|
inline |
equality operator
[in] | RHS | The FrProcData object to be compared. |
bool FrameCPP::Version_8::FrProcData::operator== | ( | const FrProcData & | RHS | ) | const |
equality operator
[in] | RHS | The FrProcData object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | Obj | The object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | Obj | The object to be compared. |
|
protectedvirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
protectedvirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The stream from which the earliest version of the FrProcData structure was read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The stream from which the earliest version of the FrProcData structure was read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
inlinestatic |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
static |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
protectedvirtual |
Upgrade an object.
[in] | Target | The version of the frame specification to promote too. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
protectedvirtual |
Upgrade an object.
[in] | Target | The version of the frame specification to promote too. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
protectedpure virtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implemented in FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, and FrameCPP::Version_8::FrSE.
|
static |
The description of structure.
|
static |
The description of structure.
|
static |
The name structure name of this object.
|
inlinestatic |
The name structure name of this object.
FrProcData::subset_ret_type FrameCPP::Version_8::FrProcData::Subset | ( | REAL_8 | Offset, |
REAL_8 | Dt | ||
) | const |
Request a subset of the data.
[in] | Offset | The number of seconds from the start of the FrProcData object from which to start extracting data. |
[in] | Dt | The number of seconds of data in the resulting FrProcData strucutre. |
subset_ret_type FrameCPP::Version_8::FrProcData::Subset | ( | REAL_8 | Offset, |
REAL_8 | Dt | ||
) | const |
Request a subset of the data.
[in] | Offset | The number of seconds from the start of the FrProcData object from which to start extracting data. |
[in] | Dt | The number of seconds of data in the resulting FrProcData strucutre. |
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |