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

#include <FrProcDataNPS.hh>

Inheritance diagram for FrameCPP::Version_6::FrProcDataNPS:
FrameCPP::Version_6::FrProcData

Classes

struct  AuxParam_type
 

Public Types

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
 

Public Member Functions

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
 
tRange_type GetTRange () const
 
fShift_type GetFShift () const
 
phase_type GetPhase () const
 
fRange_type GetFRange () 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)
 

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 = FrProcDataNPS::UNKNOWN_TYPE
 
static const FrProcDataNPS::subType_type DEFAULT_VALUE_SUB_TYPE = FrProcDataNPS::UNKNOWN_SUB_TYPE
 
static const FrProcDataNPS::tRange_type DEFAULT_VALUE_TRANGE = FR_PROC_DATA_DEFAULT_TRANGE
 
static const FrProcDataNPS::fShift_type DEFAULT_VALUE_FSHIFT = FR_PROC_DATA_DEFAULT_FSHIFT
 
static const FrProcDataNPS::phase_type DEFAULT_VALUE_PHASE = FR_PROC_DATA_DEFAULT_PHASE
 
static const FrProcDataNPS::fRange_type DEFAULT_VALUE_FRANGE = FR_PROC_DATA_DEFAULT_FRANGE
 
static const FrProcDataNPS::BW_type DEFAULT_VALUE_BW = FR_PROC_DATA_DEFAULT_BW
 

Protected Member Functions

 FrProcDataNPS ()
 
 FrProcDataNPS (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)
 
 FrProcDataNPS (const FrProcDataNPS &Source)
 
 FrProcDataNPS (istream_type &Stream)
 
 FrProcDataNPS (const Previous::FrProcData &Source)
 
cmn_streamsize_type bytes () const
 
void write (ostream_type &Stream) const
 
FrProcDataNPSoperator= (const FrProcDataNPS &RHS)
 
bool operator== (const FrProcDataNPS &RHS) const
 

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
 

Member Typedef Documentation

◆ AuxParamList_type

◆ BW_type

◆ comment_type

◆ fRange_type

◆ fShift_type

◆ name_type

◆ phase_type

◆ subType_type

◆ timeOffset_type

◆ tRange_type

◆ type_type

Member Enumeration Documentation

◆ 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

◆ FrProcDataNPS() [1/5]

FrameCPP::Version_6::FrProcDataNPS::FrProcDataNPS ( )
inlineprotected

◆ FrProcDataNPS() [2/5]

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

◆ FrProcDataNPS() [3/5]

FrameCPP::Version_6::FrProcDataNPS::FrProcDataNPS ( const FrProcDataNPS Source)
inlineprotected

◆ FrProcDataNPS() [4/5]

FrameCPP::Version_6::FrProcDataNPS::FrProcDataNPS ( istream_type Stream)
inlineprotected

◆ FrProcDataNPS() [5/5]

FrameCPP::Version_6::FrProcDataNPS::FrProcDataNPS ( const Previous::FrProcData &  Source)
inlineprotected

Member Function Documentation

◆ AppendAuxParam()

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

◆ AppendComment()

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

◆ bytes()

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

◆ GetAuxParam() [1/2]

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

◆ GetAuxParam() [2/2]

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

◆ GetBW()

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

◆ GetComment()

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

◆ GetFRange()

FrProcDataNPS::fRange_type FrameCPP::Version_6::FrProcDataNPS::GetFRange ( ) const
inline

◆ GetFShift()

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

◆ GetName()

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

◆ GetPhase()

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

◆ GetSubType()

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

◆ GetTimeOffset()

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

◆ GetTRange()

FrProcDataNPS::tRange_type FrameCPP::Version_6::FrProcDataNPS::GetTRange ( ) const
inline

◆ GetType()

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

◆ operator=()

FrProcDataNPS & FrameCPP::Version_6::FrProcDataNPS::operator= ( const FrProcDataNPS RHS)
inlineprotected

◆ operator==()

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

◆ SetAuxParam()

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

◆ SetComment()

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

◆ SetFRange()

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

◆ SetFShift()

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

◆ SetTimeOffset()

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

◆ SetTRange()

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

◆ write()

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

Member Data Documentation

◆ auxParams

AuxParamList_type FrameCPP::Version_6::FrProcDataNPS::auxParams
protected

◆ BW

BW_type FrameCPP::Version_6::FrProcDataNPS::BW
protected

◆ BW_UNKNOWN

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

◆ comment

comment_type FrameCPP::Version_6::FrProcDataNPS::comment
protected

◆ DEFAULT_VALUE_BW

const FrProcDataNPS::BW_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_BW = FR_PROC_DATA_DEFAULT_BW
static

◆ DEFAULT_VALUE_FRANGE

const FrProcDataNPS::fRange_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_FRANGE = FR_PROC_DATA_DEFAULT_FRANGE
static

◆ DEFAULT_VALUE_FSHIFT

const FrProcDataNPS::fShift_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_FSHIFT = FR_PROC_DATA_DEFAULT_FSHIFT
static

◆ DEFAULT_VALUE_PHASE

const FrProcDataNPS::phase_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_PHASE = FR_PROC_DATA_DEFAULT_PHASE
static

◆ DEFAULT_VALUE_SUB_TYPE

const FrProcDataNPS::subType_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_SUB_TYPE = FrProcDataNPS::UNKNOWN_SUB_TYPE
static

◆ DEFAULT_VALUE_TRANGE

const FrProcDataNPS::tRange_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_TRANGE = FR_PROC_DATA_DEFAULT_TRANGE
static

◆ DEFAULT_VALUE_TYPE

const FrProcDataNPS::type_type FrameCPP::Version_6::FrProcDataNPS::DEFAULT_VALUE_TYPE = FrProcDataNPS::UNKNOWN_TYPE
static

◆ fRange

fRange_type FrameCPP::Version_6::FrProcDataNPS::fRange
protected

◆ FRANGE_UNKNOWN

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

◆ fShift

fShift_type FrameCPP::Version_6::FrProcDataNPS::fShift
protected

◆ name

name_type FrameCPP::Version_6::FrProcDataNPS::name
protected

◆ phase

phase_type FrameCPP::Version_6::FrProcDataNPS::phase
protected

◆ PHASE_UNKNOWN

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

◆ subType

subType_type FrameCPP::Version_6::FrProcDataNPS::subType
protected

◆ timeOffset

timeOffset_type FrameCPP::Version_6::FrProcDataNPS::timeOffset
protected

◆ tRange

tRange_type FrameCPP::Version_6::FrProcDataNPS::tRange
protected

◆ type

type_type FrameCPP::Version_6::FrProcDataNPS::type
protected

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