ldas-tools-framecpp
2.5.8
|
Post-Processed Data Structure Definition. More...
#include <FrProcData.hh>
Public Types | |
typedef LDASTools::AL::SharedPtr< FrProcData > | subset_ret_type |
typedef ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | self_type |
typedef IStream | istream_type |
typedef OStream | ostream_type |
typedef FrameSpec::version_type | frame_spec_version_type |
typedef std::unique_ptr< Object > | unique_object_type |
typedef object_type | demote_arg_type |
typedef object_type | demote_ret_type |
typedef object_type | promote_arg_type |
typedef object_type | promote_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 } |
typedef STRING< INT_2U > | string_2_type |
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. More... | |
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 self_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
class_type | GetClass () const |
Retrieve the class identifier. More... | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. More... | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. More... | |
virtual Object * | Clone () const |
constructor - virtual copy constructor More... | |
template<typename PreviousType , typename CurrentType > | |
FrameSpec::ObjectInterface::promote_ret_type | PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream) |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. More... | |
void | TOCQuery (int InfoClass,...) const |
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 const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. More... | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. More... | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream) |
Down grade an object. More... | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. More... | |
template<typename PreviousType , typename CurrentType > | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. More... | |
template<class T > | |
static int | DataType (const T *Data) |
template<class T > | |
static int | DataType (const T &Data) |
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 class_type | getClass () const |
Retrieve the class identifier. More... | |
Post-Processed Data Structure Definition.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef LDASTools::AL::SharedPtr< FrProcData > FrameCPP::Version_8::FrProcData::subset_ret_type |
|
inherited |
|
inherited |
|
inherited |
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 | ( | ) |
Destructor.
|
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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
virtualinherited |
constructor - virtual copy constructor
Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrStatData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, and FrameCPP::Version_3::FrHeader.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
|
staticinherited |
|
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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
inlineinherited |
Retrieve the class identifier.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlinevirtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
Retrieve the frequency range.
const std::string & FrameCPP::Version_8::FrProcData::GetNameSlow | ( | ) | const |
Return the name associate with the FrProcData structure.
|
inline |
Retrieve the time range.
|
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. |
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.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
inequality operator
[in] | RHS | The FrProcData object to be compared. |
|
inline |
equality operator
[in] | RHS | The FrProcData object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | Obj | The object to be compared. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
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< Common::FrameSpec::Object, 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< Common::FrameSpec::Object, 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. |
|
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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
inherited |
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.
|
static |
The description of structure.
|
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. |
|
inlineinherited |
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The stream that is being used to read the object. |
Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_4::FrEndOfFile, and FrameCPP::Version_3::FrEndOfFile.
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
virtualinherited |
Write object to the stream.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |