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:

Collaboration diagram for FrameCPP::Version_4::FrameHNPS:

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
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 }
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
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 GPSTime &	GetGTime () 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...
	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 GPSTime &	GetGTime () 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
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)
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
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
	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)
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

assign_stream_type [1/2]

typedef Common::IStringStream FrameCPP::Version_4::FrameHNPS::assign_stream_type

protected

assign_stream_type [2/2]

typedef Common::IStringStream FrameCPP::Version_4::FrameHNPS::assign_stream_type

protected

dt_type [1/2]

typedef FRAME_H_DT_TYPE FrameCPP::Version_4::FrameHNPS::dt_type

dt_type [2/2]

typedef FRAME_H_DT_TYPE FrameCPP::Version_4::FrameHNPS::dt_type

frame_type [1/2]

typedef FRAME_H_FRAME_TYPE FrameCPP::Version_4::FrameHNPS::frame_type

frame_type [2/2]

typedef FRAME_H_FRAME_TYPE FrameCPP::Version_4::FrameHNPS::frame_type

GTime_type [1/2]

typedef FRAME_H_G_TIME_TYPE FrameCPP::Version_4::FrameHNPS::GTime_type

GTime_type [2/2]

typedef FRAME_H_G_TIME_TYPE FrameCPP::Version_4::FrameHNPS::GTime_type

GTimeN_type [1/2]

typedef FRAME_H_G_TIME_N_TYPE FrameCPP::Version_4::FrameHNPS::GTimeN_type

GTimeN_type [2/2]

typedef FRAME_H_G_TIME_N_TYPE FrameCPP::Version_4::FrameHNPS::GTimeN_type

GTimeS_type [1/2]

typedef FRAME_H_G_TIME_S_TYPE FrameCPP::Version_4::FrameHNPS::GTimeS_type

GTimeS_type [2/2]

typedef FRAME_H_G_TIME_S_TYPE FrameCPP::Version_4::FrameHNPS::GTimeS_type

localTime_type [1/2]

typedef FRAME_H_LOCAL_TIME_TYPE FrameCPP::Version_4::FrameHNPS::localTime_type

localTime_type [2/2]

typedef FRAME_H_LOCAL_TIME_TYPE FrameCPP::Version_4::FrameHNPS::localTime_type

name_type [1/2]

typedef FRAME_H_NAME_TYPE FrameCPP::Version_4::FrameHNPS::name_type

name_type [2/2]

typedef FRAME_H_NAME_TYPE FrameCPP::Version_4::FrameHNPS::name_type

run_type [1/2]

typedef FRAME_H_RUN_TYPE FrameCPP::Version_4::FrameHNPS::run_type

run_type [2/2]

typedef FRAME_H_RUN_TYPE FrameCPP::Version_4::FrameHNPS::run_type

string_2_type [1/2]

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

inherited

string_2_type [2/2]

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

inherited

ULeapS_type [1/2]

typedef FRAME_H_U_LEAP_S_TYPE FrameCPP::Version_4::FrameHNPS::ULeapS_type

ULeapS_type [2/2]

typedef FRAME_H_U_LEAP_S_TYPE FrameCPP::Version_4::FrameHNPS::ULeapS_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

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

Constructor & Destructor Documentation

FrameHNPS() [1/8]

FrameHNPS::FrameHNPS

(

)

Default constructor.

FrameHNPS() [2/8]

FrameHNPS::FrameHNPS

(

const FrameHNPS &

Source

)

Copy Constructor.

FrameHNPS() [3/8]

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() [4/8]

FrameHNPS::FrameHNPS ( const Previous::FrameHNPS &  Source )

inlineprotected

Copy Constructor.

FrameHNPS() [5/8]

FrameCPP::Version_4::FrameHNPS::FrameHNPS

(

)

Default constructor.

FrameHNPS() [6/8]

FrameCPP::Version_4::FrameHNPS::FrameHNPS

(

const FrameHNPS &

Source

)

Copy Constructor.

FrameHNPS() [7/8]

FrameCPP::Version_4::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() [8/8]

FrameCPP::Version_4::FrameHNPS::FrameHNPS ( const Previous::FrameHNPS &  Source )

protected

Copy Constructor.

Member Function Documentation

assign() [1/2]

void FrameHNPS::assign ( assign_stream_type &  Stream )

inlineprotected

Assign the contents of the instance.

Parameters

[in]

Stream

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

assign() [2/2]

void FrameCPP::Version_4::FrameHNPS::assign ( assign_stream_type &  Stream )

protected

Assign the contents of the instance.

Parameters

[in]

Stream

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

dataDescription() [1/2]

void FrameHNPS::dataDescription ( Common::Description &  Desc )

inlinestaticprotected

dataDescription() [2/2]

static void FrameCPP::Version_4::FrameHNPS::dataDescription ( Common::Description &  Desc )

staticprotected

DataType() [1/4]

template<class T >

static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data )

staticinherited

DataType() [2/4]

template<class T >

static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data )

staticinherited

DataType() [3/4]

template<class T >

static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data )

staticinherited

DataType() [4/4]

template<class T >

static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data )

staticinherited

GetDataQuality() [1/2]

INT_4U FrameCPP::Version_4::FrameHNPS::GetDataQuality

(

)

const

GetDataQuality() [2/2]

INT_4U FrameHNPS::GetDataQuality ( ) const

inline

GetDt() [1/2]

REAL_8 FrameCPP::Version_4::FrameHNPS::GetDt

(

)

const

GetDt() [2/2]

REAL_8 FrameHNPS::GetDt ( ) const

inline

GetFrame() [1/2]

INT_4U FrameCPP::Version_4::FrameHNPS::GetFrame

(

)

const

GetFrame() [2/2]

INT_4U FrameHNPS::GetFrame ( ) const

inline

GetGTime() [1/2]

const GPSTime & FrameHNPS::GetGTime ( ) const

inline

GetGTime() [2/2]

const GPSTime& FrameCPP::Version_4::FrameHNPS::GetGTime

(

)

const

GetLocalTime() [1/2]

INT_4S FrameCPP::Version_4::FrameHNPS::GetLocalTime

(

)

const

GetLocalTime() [2/2]

INT_4S FrameHNPS::GetLocalTime ( ) const

inline

GetName() [1/2]

const std::string& FrameCPP::Version_4::FrameHNPS::GetName

(

)

const

GetName() [2/2]

const std::string & FrameHNPS::GetName ( ) const

inline

GetRun() [1/2]

INT_4S FrameHNPS::GetRun ( ) const

inline

GetRun() [2/2]

INT_4S FrameCPP::Version_4::FrameHNPS::GetRun

(

)

const

GetULeapS() [1/2]

INT_2U FrameCPP::Version_4::FrameHNPS::GetULeapS

(

)

const

GetULeapS() [2/2]

INT_2U FrameHNPS::GetULeapS ( ) const

inline

SetDataQuality() [1/2]

void FrameHNPS::SetDataQuality ( INT_4U  DataQuality )

inline

SetDataQuality() [2/2]

void FrameCPP::Version_4::FrameHNPS::SetDataQuality

(

INT_4U

DataQuality

)

SetDt() [1/2]

void FrameCPP::Version_4::FrameHNPS::SetDt

(

REAL_8

Dt

)

SetDt() [2/2]

void FrameHNPS::SetDt ( REAL_8  Dt )

inline

SetGTime() [1/2]

void FrameHNPS::SetGTime ( const GPSTime &  GTime )

inline

SetGTime() [2/2]

void FrameCPP::Version_4::FrameHNPS::SetGTime

(

const GPSTime &

GTime

)

SetRun() [1/2]

void FrameHNPS::SetRun ( INT_4S  Run )

inline

SetRun() [2/2]

void FrameCPP::Version_4::FrameHNPS::SetRun

(

INT_4S

Run

)

SetULeapS() [1/2]

void FrameHNPS::SetULeapS ( ULeapS_type  Value )

inline

Establish leap second offset.

Set the number of leap seconds since GPS epoc.

Parameters

[in]

Value

Number of leap seconds since GPS epoc.

SetULeapS() [2/2]

void FrameCPP::Version_4::FrameHNPS::SetULeapS

(

ULeapS_type

Value

)

Establish leap second offset.

Parameters

[in]

Value

Number of leap seconds since GPS epoc.

TOCQuery() [1/2]

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

inherited

TOCQuery() [2/2]

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

inlineinherited

vTOCQuery() [1/2]

virtual void FrameCPP::Version_4::FrameHNPS::vTOCQuery ( int  InfoClass, va_list  vl  ) const

protectedvirtual

Implements FrameCPP::Common::TOCInfo.

vTOCQuery() [2/2]

void FrameHNPS::vTOCQuery ( int  InfoClass, va_list  vl  ) const

protectedvirtual

Implements FrameCPP::Common::TOCInfo.

Member Data Documentation

m_data

data_type FrameHNPS::m_data

protected

---

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

• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version4/FrameH.hh
• Version4/FrameH.cc