ldas-tools-framecpp  2.6.5
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
FrameCPP::Version_6::FrProcData Class Reference

#include <FrProcData.hh>

Inheritance diagram for FrameCPP::Version_6::FrProcData:
FrameCPP::Common::FrameSpec::Object FrameCPP::Common::TOCInfo FrameCPP::Version_6::FrProcDataNPS FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType > FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

typedef std::unique_ptr< FrProcDatasubset_ret_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_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
 
enum  e_type_type {
  UNKNOWN_TYPE = 0, TIME_SERIES = 1, FREQUENCY_SERIES = 2, OTHER_1D_SERIES_DATA = 3,
  TIME_FREQUENCY = 4, WAVELETS = 5, MULTI_DIMENSIONAL = 6
}
 
enum  e_subType_type {
  UNKNOWN_SUB_TYPE = 0, DFT = 1, AMPLITUDE_SPECTRAL_DENSITY = 2, POWER_SPECTRAL_DENSITY = 3,
  CROSS_SPECTRAL_DENSITY = 4, COHERENCE = 5, TRANSFER_FUNCTION = 6
}
 
typedef FR_PROC_DATA_NAME_TYPE name_type
 
typedef FR_PROC_DATA_COMMENT_TYPE comment_type
 
typedef FR_PROC_DATA_TYPE_TYPE type_type
 
typedef FR_PROC_DATA_SUB_TYPE_TYPE subType_type
 
typedef FR_PROC_DATA_TIME_OFFSET_TYPE timeOffset_type
 
typedef FR_PROC_DATA_T_RANGE_TYPE tRange_type
 
typedef FR_PROC_DATA_F_SHIFT_TYPE fShift_type
 
typedef FR_PROC_DATA_PHASE_TYPE phase_type
 
typedef FR_PROC_DATA_F_RANGE_TYPE fRange_type
 
typedef FR_PROC_DATA_BW_TYPE BW_type
 
typedef Common::Array< INT_2U, AuxParam_typeAuxParamList_type
 
typedef AuxType aux_value_type
 
typedef Common::Container< aux_value_typeaux_type
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef aux_type::iterator aux_iterator
 
typedef DataType data_value_type
 
typedef Common::Container< data_value_typedata_type
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::iterator iterator
 
typedef TableType table_value_type
 
typedef Common::Container< table_value_typetable_type
 
typedef table_type::const_iterator const_table_iterator
 
typedef table_type::iterator table_iterator
 
typedef HistoryType history_value_type
 
typedef Common::Container< history_value_typehistory_type
 
typedef history_type::const_iterator const_history_iterator
 
typedef history_type::iterator history_iterator
 

Public Member Functions

 FrProcData ()
 Default constructor. More...
 
 FrProcData (const FrProcData &Source)
 Copy Constructor. More...
 
 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. 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...
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. 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 SubFrProcData (REAL_8 Offset, REAL_8 Dt) const
 Request a subset of the data. More...
 
virtual FrProcDataCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual void Write (ostream_type &Stream) const
 Virtual constructor. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectClone () 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
 
void AppendComment (const std::string &Comment)
 
void AppendAuxParam (const AuxParam_type &Param)
 
const name_typeGetName () const
 
const comment_typeGetComment () const
 
type_type GetType () const
 
subType_type GetSubType () const
 
timeOffset_type GetTimeOffset () const
 
fShift_type GetFShift () const
 
phase_type GetPhase () const
 
BW_type GetBW () const
 
const AuxParamList_typeGetAuxParam () const
 
AuxParamList_typeGetAuxParam ()
 
void SetAuxParam (const AuxParamList_type &AuxParams)
 
void SetComment (const comment_type &Comment)
 
void SetFRange (fRange_type FRange)
 
void SetFShift (fShift_type FShift)
 
void SetTimeOffset (timeOffset_type time)
 
void SetTRange (tRange_type TRange)
 
const aux_typeRefAux () const
 Identifier for vector for auxilliary data. More...
 
aux_typeRefAux ()
 Identifier for vector for auxilliary data. More...
 
const data_typeRefData () const
 Identifier for vector for data vector. More...
 
data_typeRefData ()
 Identifier for vector for data vector. More...
 
const table_typeRefTable () const
 Identifier for parameter table. More...
 
table_typeRefTable ()
 Identifier for parameter table. More...
 
const history_typeRefHistory () const
 Identifier for channel history. More...
 
history_typeRefHistory ()
 Identifier for channel history. More...
 

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::DescriptionStructDescription ()
 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 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)
 

Static Public Attributes

static const phase_type PHASE_UNKNOWN = 0.0
 
static const fRange_type FRANGE_UNKNOWN = 0.0
 
static const BW_type BW_UNKNOWN = 0
 
static const FrProcDataNPS::type_type DEFAULT_VALUE_TYPE
 
static const FrProcDataNPS::subType_type DEFAULT_VALUE_SUB_TYPE
 
static const FrProcDataNPS::tRange_type DEFAULT_VALUE_TRANGE
 
static const FrProcDataNPS::fShift_type DEFAULT_VALUE_FSHIFT
 
static const FrProcDataNPS::phase_type DEFAULT_VALUE_PHASE
 
static const FrProcDataNPS::fRange_type DEFAULT_VALUE_FRANGE
 
static const FrProcDataNPS::BW_type DEFAULT_VALUE_BW
 

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...
 
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...
 
cmn_streamsize_type bytes () const
 
void write (ostream_type &Stream) const
 
bool operator== (const FrProcDataNPS &RHS) const
 
cmn_streamsize_type bytes (const stream_base_type &Stream) const
 Number of bytes needed to write this structure. More...
 
void write (ostream_type &Stream) const
 Write the structure to the stream. More...
 
void copy_core (const FrProcDataPST &Source)
 Copy core data. More...
 
bool operator== (const FrProcDataPST &RHS) const
 equality operator More...
 

Protected Attributes

name_type name
 
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
 
AuxParamList_type auxParams
 
data_type data
 
aux_type aux
 
table_type table
 
history_type history
 

Static Protected Attributes

static const INT_2U MAX_REF = 4
 

Member Typedef Documentation

◆ aux_iterator

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef aux_type::iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::aux_iterator
inherited

◆ aux_type

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef Common::Container< aux_value_type > FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::aux_type
inherited

◆ aux_value_type

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef AuxType FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::aux_value_type
inherited

◆ AuxParamList_type

◆ BW_type

◆ comment_type

◆ const_aux_iterator

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef aux_type::const_iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::const_aux_iterator
inherited

◆ const_history_iterator

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef history_type::const_iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::const_history_iterator
inherited

◆ const_iterator

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef data_type::const_iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::const_iterator
inherited

◆ const_table_iterator

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef table_type::const_iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::const_table_iterator
inherited

◆ data_type

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef Common::Container< data_value_type > FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::data_type
inherited

◆ data_value_type

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef DataType FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::data_value_type
inherited

◆ demote_arg_type

◆ demote_ret_type

◆ frame_spec_version_type

◆ fRange_type

◆ fShift_type

◆ history_iterator

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef history_type::iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::history_iterator
inherited

◆ history_type

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef Common::Container< history_value_type > FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::history_type
inherited

◆ history_value_type

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef HistoryType FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::history_value_type
inherited

◆ iterator

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef data_type::iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::iterator
inherited

◆ name_type

◆ object_type

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ phase_type

◆ promote_arg_type

◆ promote_ret_type

◆ string_2_type

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ subset_ret_type

◆ subType_type

◆ table_iterator

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef table_type::iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::table_iterator
inherited

◆ table_type

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef Common::Container< table_value_type > FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::table_type
inherited

◆ table_value_type

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef TableType FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::table_value_type
inherited

◆ timeOffset_type

◆ tRange_type

◆ type_type

◆ unique_object_type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
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 

◆ anonymous enum

anonymous enum
inherited
Enumerator
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 

◆ e_subType_type

Enumerator
UNKNOWN_SUB_TYPE 
DFT 
AMPLITUDE_SPECTRAL_DENSITY 
POWER_SPECTRAL_DENSITY 
CROSS_SPECTRAL_DENSITY 
COHERENCE 
TRANSFER_FUNCTION 

◆ e_type_type

Enumerator
UNKNOWN_TYPE 
TIME_SERIES 
FREQUENCY_SERIES 
OTHER_1D_SERIES_DATA 
TIME_FREQUENCY 
WAVELETS 
MULTI_DIMENSIONAL 

Constructor & Destructor Documentation

◆ FrProcData() [1/4]

FrameCPP::Version_6::FrProcData::FrProcData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrProcData() [2/4]

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

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

FrameCPP::Version_6::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()

FrameCPP::Version_6::FrProcData::~FrProcData ( )

Destructor.

Member Function Documentation

◆ AppendAuxParam()

void FrameCPP::Version_6::FrProcDataNPS::AppendAuxParam ( const AuxParam_type Param)
inlineinherited

◆ AppendComment()

void FrameCPP::Version_6::FrProcDataNPS::AppendComment ( const std::string &  Comment)
inlineinherited

◆ bytes() [1/2]

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
cmn_streamsize_type FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::bytes ( const stream_base_type 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.

◆ bytes() [2/2]

cmn_streamsize_type FrameCPP::Version_6::FrProcDataNPS::bytes ( ) const
inlineprotectedinherited

◆ Bytes()

FrameCPP::cmn_streamsize_type FrameCPP::Version_6::FrProcData::Bytes ( const Common::StreamBase Stream) const
virtual

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::ObjectInterface.

◆ Clone()

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

◆ copy_core()

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
void FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::copy_core ( const FrProcDataPST< DataType, AuxType, TableType, HistoryType > &  Source)
inlineprotectedinherited

Copy core data.

Parameters
[in]SourceThe source from which to copy the data

◆ Create() [1/3]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( ) const
virtualinherited

◆ Create() [2/3]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream &  Buffer) const
virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.

◆ Create() [3/3]

FrProcData * FrameCPP::Version_6::FrProcData::Create ( istream_type Stream) const
virtual

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::ObjectInterface.

◆ DataType() [1/2]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited

◆ DataType() [2/2]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited

◆ demote()

FrProcData::demote_ret_type FrameCPP::Version_6::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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DemoteObject()

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ GetAuxParam() [1/2]

const FrProcDataNPS::AuxParamList_type & FrameCPP::Version_6::FrProcDataNPS::GetAuxParam ( ) const
inlineinherited

◆ GetAuxParam() [2/2]

FrProcDataNPS::AuxParamList_type & FrameCPP::Version_6::FrProcDataNPS::GetAuxParam ( )
inlineinherited

◆ GetBW()

FrProcDataNPS::BW_type FrameCPP::Version_6::FrProcDataNPS::GetBW ( ) const
inlineinherited

◆ GetClass()

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass()

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetComment()

const FrProcDataNPS::comment_type & FrameCPP::Version_6::FrProcDataNPS::GetComment ( ) const
inlineinherited

◆ GetDescription()

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetFRange()

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

Retrieve the frequency range.

Returns
The frequency range.

◆ GetFShift()

FrProcDataNPS::fShift_type FrameCPP::Version_6::FrProcDataNPS::GetFShift ( ) const
inlineinherited

◆ GetName()

const FrProcDataNPS::name_type & FrameCPP::Version_6::FrProcDataNPS::GetName ( ) const
inlineinherited

◆ GetNameSlow()

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

Return the name associate with the FrProcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetPhase()

FrProcDataNPS::phase_type FrameCPP::Version_6::FrProcDataNPS::GetPhase ( ) const
inlineinherited

◆ GetSubType()

FrProcDataNPS::subType_type FrameCPP::Version_6::FrProcDataNPS::GetSubType ( ) const
inlineinherited

◆ GetTimeOffset()

FrProcDataNPS::timeOffset_type FrameCPP::Version_6::FrProcDataNPS::GetTimeOffset ( ) const
inlineinherited

◆ GetTRange()

REAL_8 FrameCPP::Version_6::FrProcData::GetTRange ( ) const
inline

Retrieve the time range.

Returns
The time range.

◆ GetType()

FrProcDataNPS::type_type FrameCPP::Version_6::FrProcDataNPS::GetType ( ) const
inlineinherited

◆ IDSubTypeToString()

const std::string & FrameCPP::Version_6::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()

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

Convert numeric types to string representation.

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

◆ Merge()

FrProcData & FrameCPP::Version_6::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()

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

The name structure name of this object.

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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator!=()

bool FrameCPP::Version_6::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==() [1/4]

bool FrameCPP::Version_6::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==() [2/4]

bool FrameCPP::Version_6::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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [3/4]

bool FrameCPP::Version_6::FrProcDataNPS::operator== ( const FrProcDataNPS RHS) const
inlineprotectedinherited

◆ operator==() [4/4]

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
bool FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::operator== ( const FrProcDataPST< DataType, AuxType, TableType, HistoryType > &  RHS) const
inlineprotectedinherited

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.

◆ Promote()

FrProcData::promote_ret_type FrameCPP::Version_6::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()

FrProcData::promote_ret_type FrameCPP::Version_6::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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ PromoteObject() [1/3]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/3]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/3]

template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited

◆ RefAux() [1/2]

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
const FrProcDataPST< DataType, AuxType, TableType, HistoryType >::aux_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefAux ( ) const
inlineinherited

Identifier for vector for auxilliary data.

Returns
A constant reference to the auxilliary data.

◆ RefAux() [2/2]

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
FrProcDataPST< DataType, AuxType, TableType, HistoryType >::aux_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefAux ( )
inlineinherited

Identifier for vector for auxilliary data.

Returns
A reference to the auxilliary data.

◆ RefData() [1/2]

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
const FrProcDataPST< DataType, AuxType, TableType, HistoryType >::data_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefData ( ) const
inlineinherited

Identifier for vector for data vector.

Returns
A constant reference to the data vector.

◆ RefData() [2/2]

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
FrProcDataPST< DataType, AuxType, TableType, HistoryType >::data_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefData ( )
inlineinherited

Identifier for vector for data vector.

Returns
A reference to the data vector.

◆ RefHistory() [1/2]

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
const FrProcDataPST< DataType, AuxType, TableType, HistoryType >::history_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefHistory ( ) const
inlineinherited

Identifier for channel history.

Returns
A constant reference to the channel history.

◆ RefHistory() [2/2]

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
FrProcDataPST< DataType, AuxType, TableType, HistoryType >::history_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefHistory ( )
inlineinherited

Identifier for channel history.

Returns
A reference to the channel history.

◆ RefTable() [1/2]

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
const FrProcDataPST< DataType, AuxType, TableType, HistoryType >::table_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefTable ( ) const
inlineinherited

Identifier for parameter table.

Returns
A constant reference to the parameter table.

◆ RefTable() [2/2]

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
FrProcDataPST< DataType, AuxType, TableType, HistoryType >::table_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefTable ( )
inlineinherited

Identifier for parameter table.

Returns
A reference to the parameter table.

◆ SetAuxParam()

void FrameCPP::Version_6::FrProcDataNPS::SetAuxParam ( const AuxParamList_type AuxParams)
inlineinherited

◆ SetComment()

void FrameCPP::Version_6::FrProcDataNPS::SetComment ( const comment_type Comment)
inlineinherited

◆ SetFRange()

void FrameCPP::Version_6::FrProcDataNPS::SetFRange ( fRange_type  FRange)
inlineinherited

◆ SetFShift()

void FrameCPP::Version_6::FrProcDataNPS::SetFShift ( fShift_type  FShift)
inlineinherited

◆ SetTimeOffset()

void FrameCPP::Version_6::FrProcDataNPS::SetTimeOffset ( timeOffset_type  time)
inlineinherited

◆ SetTRange()

void FrameCPP::Version_6::FrProcDataNPS::SetTRange ( tRange_type  TRange)
inlineinherited

◆ StructDescription()

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

The description of structure.

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

◆ StructName()

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

The name structure name of this object.

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

◆ SubFrProcData()

FrProcData::subset_ret_type FrameCPP::Version_6::FrProcData::SubFrProcData ( 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.

◆ TOCQuery()

void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inlineinherited

◆ VerifyObject()

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

◆ vTOCQuery()

void FrameCPP::Version_6::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.

Implements FrameCPP::Common::TOCInfo.

◆ write() [1/2]

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
void FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::write ( ostream_type Stream) const
inlineprotectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [2/2]

void FrameCPP::Version_6::FrProcDataNPS::write ( ostream_type Stream) const
inlineprotectedinherited

◆ Write()

void FrameCPP::Version_6::FrProcData::Write ( ostream_type Stream) const
virtual

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext()

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

Member Data Documentation

◆ aux

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
aux_type FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::aux
protectedinherited

Aux vector.

◆ auxParams

AuxParamList_type FrameCPP::Version_6::FrProcDataNPS::auxParams
protectedinherited

◆ BW

BW_type FrameCPP::Version_6::FrProcDataNPS::BW
protectedinherited

◆ BW_UNKNOWN

const FrProcDataNPS::BW_type FrameCPP::Version_6::FrProcDataNPS::BW_UNKNOWN = 0
staticinherited

◆ comment

comment_type FrameCPP::Version_6::FrProcDataNPS::comment
protectedinherited

◆ data

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
data_type FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::data
protectedinherited

Data vector. The data vector for single dimensional types (t-Series and f-Series) must have a single dimension.

◆ DEFAULT_VALUE_BW

const FrProcDataNPS::BW_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_BW
staticinherited
Initial value:

◆ DEFAULT_VALUE_FRANGE

const FrProcDataNPS::fRange_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_FRANGE
staticinherited
Initial value:

◆ DEFAULT_VALUE_FSHIFT

const FrProcDataNPS::fShift_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_FSHIFT
staticinherited
Initial value:

◆ DEFAULT_VALUE_PHASE

const FrProcDataNPS::phase_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_PHASE
staticinherited
Initial value:

◆ DEFAULT_VALUE_SUB_TYPE

const FrProcDataNPS::subType_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_SUB_TYPE
staticinherited

◆ DEFAULT_VALUE_TRANGE

const FrProcDataNPS::tRange_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_TRANGE
staticinherited
Initial value:

◆ DEFAULT_VALUE_TYPE

const FrProcDataNPS::type_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_TYPE
staticinherited
Initial value:

◆ fRange

fRange_type FrameCPP::Version_6::FrProcDataNPS::fRange
protectedinherited

◆ FRANGE_UNKNOWN

const FrProcDataNPS::fRange_type FrameCPP::Version_6::FrProcDataNPS::FRANGE_UNKNOWN = 0.0
staticinherited

◆ fShift

fShift_type FrameCPP::Version_6::FrProcDataNPS::fShift
protectedinherited

◆ history

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
history_type FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::history
protectedinherited

Channel history.

Note
The first FrHistory should describe the processing used to build this FrProcData channel. Its name variable should be the FrProcData name. If the channel(s) used to produce this FrProcData have prior FrHistory structures, then in order to not lose this history, these structures should be copied to the FrHistory linked list.

◆ MAX_REF

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
const INT_2U FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::MAX_REF = 4
staticprotectedinherited

◆ name

name_type FrameCPP::Version_6::FrProcDataNPS::name
protectedinherited

◆ phase

phase_type FrameCPP::Version_6::FrProcDataNPS::phase
protectedinherited

◆ PHASE_UNKNOWN

const FrProcDataNPS::phase_type FrameCPP::Version_6::FrProcDataNPS::PHASE_UNKNOWN = 0.0
staticinherited

◆ subType

subType_type FrameCPP::Version_6::FrProcDataNPS::subType
protectedinherited

◆ table

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
table_type FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::table
protectedinherited

Parameter table.

◆ timeOffset

timeOffset_type FrameCPP::Version_6::FrProcDataNPS::timeOffset
protectedinherited

◆ tRange

tRange_type FrameCPP::Version_6::FrProcDataNPS::tRange
protectedinherited

◆ type

type_type FrameCPP::Version_6::FrProcDataNPS::type
protectedinherited

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