ldas-tools-framecpp 3.0.4
|
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 | |
FrProcData & | Merge (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 | |
FrProcData & | Merge (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 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 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 streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
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_type & | RefAux () const |
Identifier for vector for auxilliary data. | |
aux_type & | RefAux () |
Identifier for vector for auxilliary data. | |
const data_type & | RefData () const |
Identifier for vector for data vector. | |
data_type & | RefData () |
Identifier for vector for data vector. | |
const table_type & | RefTable () const |
Identifier for parameter table. | |
table_type & | RefTable () |
Identifier for parameter table. | |
const history_type & | RefHistory () const |
Identifier for channel history. | |
history_type & | RefHistory () |
Identifier for channel history. | |
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 * | 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 * | 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 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 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_desc_type | FrameSpecDescription () |
Return the dictionary name of the structure. | |
static struct_id_type | FrameSpecId () |
Return the dictionary name of the structure. |
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_type * | pCreate (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | pCreate (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. |
Post-Processed Data Structure Definition.
|
default |
Default constructor.
|
default |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
FrameCPP::Version_8::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.
[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, |
stream_base_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. |
|
default |
Default constructor.
|
default |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
FrameCPP::Version_8::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.
[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, |
stream_base_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 |
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 |
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. |
|
inlineprotectedinherited |
Copy core data.
[in] | Source | The source from which to copy the data |
|
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. |
|
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. |
|
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. |
|
inlineprotectedvirtualinherited |
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. |
|
inlineprotectedvirtualinherited |
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. |
|
inlineinherited |
A brief description of the FrProcData structure.
|
inlineinherited |
Retrieve the frequency range.
|
inlineinherited |
Return the name associate with the FrProcData structure.
|
inline |
Return the name associate with the FrProcData structure.
|
inline |
Return the name associate with the FrProcData structure.
|
inlineinherited |
Retrieve the time range.
|
staticinherited |
Convert numeric sub-types to string representation.
[in] | Type | Numeric type. |
[in] | SubType | Numeric sub-type. |
|
staticinherited |
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. |
|
inlinevirtualinherited |
The name structure name of this object.
|
inlinevirtualinherited |
The name structure name of this object.
|
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. |
|
inlineinherited |
equality operator
[in] | RHS | The FrProcData object to be compared. |
|
inlineprotectedinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
inlineprotectedinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The stream from which the earliest version of the FrProcData structure was read. |
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The stream from which the earliest version of the FrProcData structure was read. |
|
inlinestaticinherited |
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. |
|
inlinestaticinherited |
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. |
|
inlineprotectedvirtualinherited |
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. |
|
inlineprotectedvirtualinherited |
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. |
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
inlineinherited |
Identifier for vector for auxilliary data.
|
inlineinherited |
Identifier for vector for auxilliary data.
|
inlineinherited |
Identifier for vector for data vector.
|
inlineinherited |
Identifier for vector for data vector.
|
inlineinherited |
Identifier for channel history.
|
inlineinherited |
Identifier for channel history.
|
inlineinherited |
Identifier for parameter table.
|
inlineinherited |
Identifier for parameter table.
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
The description of structure.
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. |
|
inlineprotectedvirtualinherited |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
|
inlineprotectedvirtualinherited |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
|
protectedinherited |
Data vector. The data vector fro single dimensional types (t-Series and f-Series) must have a single dimension.
|
protectedinherited |
fShift is the frequency in the original data that corresponds to 0 Hz in the heterodyned series
|
protectedinherited |
Phase of heterodyning signal at start of dataset (radians, 0 if unknown)
|
protectedinherited |
Offset of 1st sample relative to the frame start time (seconds)