ldas-tools-framecpp  2.6.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_4::FrameHNPS Class Reference

Non-PTR_STRUCT elements of the FrameH structure. More...

#include <FrameH.hh>

Inheritance diagram for FrameCPP::Version_4::FrameHNPS:
FrameCPP::Common::TOCInfo FrameCPP::Version_4::FrameH

Classes

struct  data_type
 

Public Types

typedef FRAME_H_NAME_TYPE name_type
 
typedef FRAME_H_RUN_TYPE run_type
 
typedef FRAME_H_FRAME_TYPE frame_type
 
typedef FRAME_H_G_TIME_S_TYPE GTimeS_type
 
typedef FRAME_H_G_TIME_N_TYPE GTimeN_type
 
typedef FRAME_H_G_TIME_TYPE GTime_type
 
typedef FRAME_H_U_LEAP_S_TYPE ULeapS_type
 
typedef FRAME_H_LOCAL_TIME_TYPE localTime_type
 
typedef FRAME_H_DT_TYPE dt_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

 FrameHNPS ()
 Default constructor. More...
 
 FrameHNPS (const FrameHNPS &Source)
 Copy Constructor. More...
 
 FrameHNPS (const std::string &name, INT_4S run, INT_4U frame, const GPSTime &time, INT_2U uLeapS, INT_4S LocalTime, const REAL_8 dt, INT_4U dqual)
 Constructor. More...
 
const std::string & GetName () const
 
INT_4S GetRun () const
 
INT_4U GetFrame () const
 
INT_4U GetDataQuality () const
 
const GPSTimeGetGTime () const
 
INT_2U GetULeapS () const
 
REAL_8 GetDt () const
 
INT_4S GetLocalTime () const
 
void SetRun (INT_4S Run)
 
void SetDataQuality (INT_4U DataQuality)
 
void SetDt (REAL_8 Dt)
 
void SetGTime (const GPSTime &GTime)
 
void SetULeapS (ULeapS_type Value)
 Establish leap second offset. More...
 
void TOCQuery (int InfoClass,...) const
 

Static Public Member Functions

template<class T >
static int DataType (const T *Data)
 
template<class T >
static int DataType (const T &Data)
 

Protected Types

typedef Common::IStringStream assign_stream_type
 

Protected Member Functions

 FrameHNPS (const Previous::FrameHNPS &Source)
 Copy Constructor. More...
 
void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 

Static Protected Member Functions

static void dataDescription (Common::Description &Desc)
 

Protected Attributes

data_type m_data
 

Detailed Description

Non-PTR_STRUCT elements of the FrameH structure.

This class contains the data members of the FrameH structure that are not refernced by a pointer. This allows for easier migration into future frame specifications.

Member Typedef Documentation

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

Member Enumeration Documentation

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
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 

Constructor & Destructor Documentation

FrameHNPS::FrameHNPS ( )

Default constructor.

FrameHNPS::FrameHNPS ( const FrameHNPS Source)

Copy Constructor.

FrameHNPS::FrameHNPS ( const std::string &  name,
INT_4S  run,
INT_4U  frame,
const GPSTime time,
INT_2U  uLeapS,
INT_4S  LocalTime,
const REAL_8  dt,
INT_4U  dqual 
)

Constructor.

FrameHNPS::FrameHNPS ( const Previous::FrameHNPS Source)
inlineprotected

Copy Constructor.

Member Function Documentation

void FrameHNPS::assign ( assign_stream_type Stream)
inlineprotected

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.
void FrameHNPS::dataDescription ( Common::Description Desc)
inlinestaticprotected
template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited
template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited
INT_4U FrameHNPS::GetDataQuality ( ) const
inline
REAL_8 FrameHNPS::GetDt ( ) const
inline
INT_4U FrameHNPS::GetFrame ( ) const
inline
const GPSTime & FrameHNPS::GetGTime ( ) const
inline
INT_4S FrameHNPS::GetLocalTime ( ) const
inline
const std::string & FrameHNPS::GetName ( ) const
inline
INT_4S FrameHNPS::GetRun ( ) const
inline
INT_2U FrameHNPS::GetULeapS ( ) const
inline
void FrameHNPS::SetDataQuality ( INT_4U  DataQuality)
inline
void FrameHNPS::SetDt ( REAL_8  Dt)
inline
void FrameHNPS::SetGTime ( const GPSTime GTime)
inline
void FrameHNPS::SetRun ( INT_4S  Run)
inline
void FrameHNPS::SetULeapS ( ULeapS_type  Value)
inline

Establish leap second offset.

Set the number of leap seconds since GPS epoc.

Parameters
[in]ValueNumber of leap seconds since GPS epoc.
void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inlineinherited
void FrameHNPS::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

Member Data Documentation

data_type FrameCPP::Version_4::FrameHNPS::m_data
protected

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