ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
FrameCPP::Version_9::FrEventImpl::Data Class Reference

#include <FrEventData.hh>

Inheritance diagram for FrameCPP::Version_9::FrEventImpl::Data:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_9::FrEventImpl::Data:
Collaboration graph
[legend]

Public Types

typedef FR_EVENT_N_PARAM_TYPE nParam_type
 
typedef FR_EVENT_PARAM_NAME_TYPE paramName_type
 
typedef FR_EVENT_PARAM_VALUE_TYPE paramValue_type
 
typedef std::pair< paramName_type, paramValue_type > Param_type
 
typedef std::vector< Param_type > ParamList_type
 
typedef std::string name_type
 
typedef std::string comment_type
 
typedef std::string inputs_type
 
typedef LDASTools::AL::GPSTime GTime_type
 
typedef FR_EVENT_TIME_BEFORE_TYPE timeBefore_type
 
typedef FR_EVENT_TIME_AFTER_TYPE timeAfter_type
 
typedef FR_EVENT_EVENT_STATUS_TYPE eventStatus_type
 
typedef FR_EVENT_AMPLITUDE_TYPE amplitude_type
 
typedef FR_EVENT_PROBABILITY_TYPE probability_type
 
typedef std::string statistics_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > data_type
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > table_type
 
typedef REAL_4 paramValue_v5_type
 
typedef std::pair< paramName_type, paramValue_v5_type > Param_v5_type
 
typedef std::vector< Param_v5_type > ParamList_v5_type
 

Public Member Functions

name_type const & GetName () const
 
comment_type const & GetComment () const
 
inputs_type const & GetInputs () const
 
GTime_type const & GetGTime () const
 
timeBefore_type GetTimeBefore () const
 
timeAfter_type GetTimeAfter () const
 
eventStatus_type GetEventStatus () const
 
amplitude_type GetAmplitude () const
 
probability_type GetProbability () const
 
statistics_type const & GetStatistics () const
 
ParamList_type const & GetParam () const
 
ParamList_type & GetParam ()
 
const data_type & RefData () const
 
data_type & RefData ()
 
const table_type & RefTable () const
 
table_type & RefTable ()
 
bool operator== (Data const &RHS) const
 
name_type const & GetName () const
 
comment_type const & GetComment () const
 
inputs_type const & GetInputs () const
 
GTime_type const & GetGTime () const
 
timeBefore_type GetTimeBefore () const
 
timeAfter_type GetTimeAfter () const
 
eventStatus_type GetEventStatus () const
 
amplitude_type GetAmplitude () const
 
probability_type GetProbability () const
 
statistics_type const & GetStatistics () const
 
ParamList_type const & GetParam () const
 
ParamList_type & GetParam ()
 
const data_type & RefData () const
 
data_type & RefData ()
 
const table_type & RefTable () const
 
table_type & RefTable ()
 
bool operator== (Data const &RHS) const
 

Static Public Member Functions

static constexpr unsigned int GetMaxRef ()
 
static constexpr unsigned int GetMaxRef ()
 

Protected Attributes

name_type name
 Name of event.
 
comment_type comment
 Descriptor of event.
 
inputs_type inputs
 Input channels and filter parameters to event process.
 
GTime_type GTime
 
timeBefore_type timeBefore
 Signal duration before (GTimeS.GTimeN)(seconds)
 
timeAfter_type timeAfter
 Signal duration after (GTimeS.GTimeN)(seconds)
 
eventStatus_type eventStatus
 Defined by event search algorithm.
 
amplitude_type amplitude
 Continuous output amplitude returned by event.
 
probability_type probability
 
statistics_type statistics
 
ParamList_type Params
 Array of parameters.
 
data_type data
 Container of additional event results.
 
table_type table
 Table containing additional event information.
 

Static Protected Attributes

static constexpr unsigned int MAX_REF { 2 }
 

Member Typedef Documentation

◆ amplitude_type

typedef FR_EVENT_AMPLITUDE_TYPE FrameCPP::Version_9::FrEventImpl::Data::amplitude_type

◆ comment_type

typedef std::string FrameCPP::Version_9::FrEventImpl::Data::comment_type

◆ data_type

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_9::FrEventImpl::Data::data_type

◆ eventStatus_type

typedef FR_EVENT_EVENT_STATUS_TYPE FrameCPP::Version_9::FrEventImpl::Data::eventStatus_type

◆ GTime_type

typedef LDASTools::AL::GPSTime FrameCPP::Version_9::FrEventImpl::Data::GTime_type

◆ inputs_type

typedef std::string FrameCPP::Version_9::FrEventImpl::Data::inputs_type

◆ name_type

typedef std::string FrameCPP::Version_9::FrEventImpl::Data::name_type

◆ nParam_type

typedef FR_EVENT_N_PARAM_TYPE FrameCPP::Version_9::FrEventImpl::Data::nParam_type

◆ Param_type

typedef std::pair< paramName_type, paramValue_type > FrameCPP::Version_9::FrEventImpl::Data::Param_type

◆ Param_v5_type

typedef std::pair< paramName_type, paramValue_v5_type > FrameCPP::Version_9::FrEventImpl::Data::Param_v5_type

◆ ParamList_type

typedef std::vector< Param_type > FrameCPP::Version_9::FrEventImpl::Data::ParamList_type

◆ ParamList_v5_type

typedef std::vector< Param_v5_type > FrameCPP::Version_9::FrEventImpl::Data::ParamList_v5_type

◆ paramName_type

typedef FR_EVENT_PARAM_NAME_TYPE FrameCPP::Version_9::FrEventImpl::Data::paramName_type

◆ paramValue_type

typedef FR_EVENT_PARAM_VALUE_TYPE FrameCPP::Version_9::FrEventImpl::Data::paramValue_type

◆ paramValue_v5_type

typedef REAL_4 FrameCPP::Version_9::FrEventImpl::Data::paramValue_v5_type

◆ probability_type

typedef FR_EVENT_PROBABILITY_TYPE FrameCPP::Version_9::FrEventImpl::Data::probability_type

◆ statistics_type

typedef std::string FrameCPP::Version_9::FrEventImpl::Data::statistics_type

◆ table_type

typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_9::FrEventImpl::Data::table_type

◆ timeAfter_type

typedef FR_EVENT_TIME_AFTER_TYPE FrameCPP::Version_9::FrEventImpl::Data::timeAfter_type

◆ timeBefore_type

typedef FR_EVENT_TIME_BEFORE_TYPE FrameCPP::Version_9::FrEventImpl::Data::timeBefore_type

Member Function Documentation

◆ GetAmplitude() [1/2]

amplitude_type FrameCPP::Version_9::FrEventImpl::Data::GetAmplitude ( ) const
inline

◆ GetAmplitude() [2/2]

amplitude_type FrameCPP::Version_9::FrEventImpl::Data::GetAmplitude ( ) const
inline

◆ GetComment() [1/2]

comment_type const & FrameCPP::Version_9::FrEventImpl::Data::GetComment ( ) const
inline

◆ GetComment() [2/2]

comment_type const & FrameCPP::Version_9::FrEventImpl::Data::GetComment ( ) const
inline

◆ GetEventStatus() [1/2]

eventStatus_type FrameCPP::Version_9::FrEventImpl::Data::GetEventStatus ( ) const
inline

◆ GetEventStatus() [2/2]

eventStatus_type FrameCPP::Version_9::FrEventImpl::Data::GetEventStatus ( ) const
inline

◆ GetGTime() [1/2]

GTime_type const & FrameCPP::Version_9::FrEventImpl::Data::GetGTime ( ) const
inline

◆ GetGTime() [2/2]

GTime_type const & FrameCPP::Version_9::FrEventImpl::Data::GetGTime ( ) const
inline

◆ GetInputs() [1/2]

inputs_type const & FrameCPP::Version_9::FrEventImpl::Data::GetInputs ( ) const
inline

◆ GetInputs() [2/2]

inputs_type const & FrameCPP::Version_9::FrEventImpl::Data::GetInputs ( ) const
inline

◆ GetMaxRef() [1/2]

static constexpr unsigned int FrameCPP::Version_9::FrEventImpl::Data::GetMaxRef ( )
inlinestaticconstexpr

◆ GetMaxRef() [2/2]

static constexpr unsigned int FrameCPP::Version_9::FrEventImpl::Data::GetMaxRef ( )
inlinestaticconstexpr

◆ GetName() [1/2]

name_type const & FrameCPP::Version_9::FrEventImpl::Data::GetName ( ) const
inline

◆ GetName() [2/2]

name_type const & FrameCPP::Version_9::FrEventImpl::Data::GetName ( ) const
inline

◆ GetParam() [1/4]

ParamList_type & FrameCPP::Version_9::FrEventImpl::Data::GetParam ( )
inline

◆ GetParam() [2/4]

ParamList_type & FrameCPP::Version_9::FrEventImpl::Data::GetParam ( )
inline

◆ GetParam() [3/4]

ParamList_type const & FrameCPP::Version_9::FrEventImpl::Data::GetParam ( ) const
inline

◆ GetParam() [4/4]

ParamList_type const & FrameCPP::Version_9::FrEventImpl::Data::GetParam ( ) const
inline

◆ GetProbability() [1/2]

probability_type FrameCPP::Version_9::FrEventImpl::Data::GetProbability ( ) const
inline

◆ GetProbability() [2/2]

probability_type FrameCPP::Version_9::FrEventImpl::Data::GetProbability ( ) const
inline

◆ GetStatistics() [1/2]

statistics_type const & FrameCPP::Version_9::FrEventImpl::Data::GetStatistics ( ) const
inline

◆ GetStatistics() [2/2]

statistics_type const & FrameCPP::Version_9::FrEventImpl::Data::GetStatistics ( ) const
inline

◆ GetTimeAfter() [1/2]

timeAfter_type FrameCPP::Version_9::FrEventImpl::Data::GetTimeAfter ( ) const
inline

◆ GetTimeAfter() [2/2]

timeAfter_type FrameCPP::Version_9::FrEventImpl::Data::GetTimeAfter ( ) const
inline

◆ GetTimeBefore() [1/2]

timeBefore_type FrameCPP::Version_9::FrEventImpl::Data::GetTimeBefore ( ) const
inline

◆ GetTimeBefore() [2/2]

timeBefore_type FrameCPP::Version_9::FrEventImpl::Data::GetTimeBefore ( ) const
inline

◆ operator==() [1/2]

bool FrameCPP::Version_9::FrEventImpl::Data::operator== ( Data const & RHS) const
inline

◆ operator==() [2/2]

bool FrameCPP::Version_9::FrEventImpl::Data::operator== ( Data const & RHS) const
inline

◆ RefData() [1/4]

data_type & FrameCPP::Version_9::FrEventImpl::Data::RefData ( )
inline

◆ RefData() [2/4]

data_type & FrameCPP::Version_9::FrEventImpl::Data::RefData ( )
inline

◆ RefData() [3/4]

const data_type & FrameCPP::Version_9::FrEventImpl::Data::RefData ( ) const
inline

◆ RefData() [4/4]

const data_type & FrameCPP::Version_9::FrEventImpl::Data::RefData ( ) const
inline

◆ RefTable() [1/4]

table_type & FrameCPP::Version_9::FrEventImpl::Data::RefTable ( )
inline

◆ RefTable() [2/4]

table_type & FrameCPP::Version_9::FrEventImpl::Data::RefTable ( )
inline

◆ RefTable() [3/4]

const table_type & FrameCPP::Version_9::FrEventImpl::Data::RefTable ( ) const
inline

◆ RefTable() [4/4]

const table_type & FrameCPP::Version_9::FrEventImpl::Data::RefTable ( ) const
inline

Member Data Documentation

◆ amplitude

amplitude_type FrameCPP::Version_9::FrEventImpl::Data::amplitude
protected

Continuous output amplitude returned by event.

◆ comment

comment_type FrameCPP::Version_9::FrEventImpl::Data::comment
protected

Descriptor of event.

◆ data

data_type FrameCPP::Version_9::FrEventImpl::Data::data
protected

Container of additional event results.

◆ eventStatus

eventStatus_type FrameCPP::Version_9::FrEventImpl::Data::eventStatus
protected

Defined by event search algorithm.

◆ GTime

GTime_type FrameCPP::Version_9::FrEventImpl::Data::GTime
protected

GPS time corresponding to reference value of event, as defined by the search algorithm.

◆ inputs

inputs_type FrameCPP::Version_9::FrEventImpl::Data::inputs
protected

Input channels and filter parameters to event process.

◆ MAX_REF

static constexpr unsigned int FrameCPP::Version_9::FrEventImpl::Data::MAX_REF { 2 }
staticconstexprprotected

◆ name

name_type FrameCPP::Version_9::FrEventImpl::Data::name
protected

Name of event.

◆ Params

ParamList_type FrameCPP::Version_9::FrEventImpl::Data::Params
protected

Array of parameters.

◆ probability

probability_type FrameCPP::Version_9::FrEventImpl::Data::probability
protected

Likelihood estimate of event, if available (probability = -1 if cannot be estimated)

◆ statistics

statistics_type FrameCPP::Version_9::FrEventImpl::Data::statistics
protected

Statistical description of event, if relevant or available.

◆ table

table_type FrameCPP::Version_9::FrEventImpl::Data::table
protected

Table containing additional event information.

◆ timeAfter

timeAfter_type FrameCPP::Version_9::FrEventImpl::Data::timeAfter
protected

Signal duration after (GTimeS.GTimeN)(seconds)

◆ timeBefore

timeBefore_type FrameCPP::Version_9::FrEventImpl::Data::timeBefore
protected

Signal duration before (GTimeS.GTimeN)(seconds)

The documentation for this class was generated from the following files:
Generated by doxygen 1.12.0