ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_3::FrameHNPS Class Reference

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

#include <FrameH.hh>

Inheritance diagram for FrameCPP::Version_3::FrameHNPS:
Inheritance graph
[legend]

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

Public Member Functions

 FrameHNPS ()
 Default constructor.
 FrameHNPS (const FrameHNPS &Source)
 Copy Constructor.
 FrameHNPS (const std::string &Name, run_type Run, frame_type Frame, const GTime_type &GTimeValue, ULeapS_type ULeapSValue, localTime_type LocalTime, const dt_type Dt)
 Constructor.
const std::string & GetName () const
run_type GetRun () const
frame_type GetFrame () const
const GTime_type & GetGTime () const
ULeapS_type GetULeapS () const
dt_type GetDt () const
localTime_type GetLocalTime () const
void SetRun (run_type Run)
void SetDt (dt_type Dt)
void SetGTime (const GTime_type &Value)
void SetULeapS (ULeapS_type Value)
 Establish leap second offset.
 FrameHNPS ()
 Default constructor.
 FrameHNPS (const FrameHNPS &Source)
 Copy Constructor.
 FrameHNPS (const std::string &Name, run_type Run, frame_type Frame, const GTime_type &GTimeValue, ULeapS_type ULeapSValue, localTime_type LocalTime, const dt_type Dt)
 Constructor.
const std::string & GetName () const
run_type GetRun () const
frame_type GetFrame () const
const GTime_type & GetGTime () const
ULeapS_type GetULeapS () const
dt_type GetDt () const
localTime_type GetLocalTime () const
void SetRun (run_type Run)
void SetDt (dt_type Dt)
void SetGTime (const GTime_type &Value)
void SetULeapS (ULeapS_type Value)
 Establish leap second offset.

Protected Types

typedef Common::IStringStream assign_stream_type
typedef Common::IStringStream assign_stream_type

Protected Member Functions

void assign (assign_stream_type &Stream)
 Assign the contents of the instance.
streamsize_type bytes () const
 Number of bytes required by this object.
bool compare_nps (const FrameHNPS &RHS) const
void read (istream_type &Stream)
void write (ostream_type &Stream) const
void assign (assign_stream_type &Stream)
 Assign the contents of the instance.
streamsize_type bytes () const
 Number of bytes required by this object.
bool compare_nps (const FrameHNPS &RHS) const
void read (istream_type &Stream)
void write (ostream_type &Stream) const

Static Protected Member Functions

static void dataDescription (Common::Description &Desc)
 Dictionary description of data.
static void dataDescription (Common::Description &Desc)
 Dictionary description of data.

Protected Attributes

name_type name
 Name of project or other experiment description.
run_type run
 Run number.
frame_type frame
 Frame number.
GTime_type GTime
 Frame start time.
ULeapS_type ULeapS
 The number of leap seconds.
localTime_type localTime
 Local seasonal time.
dt_type dt
 Frame length in seconds.

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_3::FrameHNPS::assign_stream_type
protected

◆ assign_stream_type [2/2]

typedef Common::IStringStream FrameCPP::Version_3::FrameHNPS::assign_stream_type
protected

◆ dt_type [1/2]

typedef FRAME_H_DT_TYPE FrameCPP::Version_3::FrameHNPS::dt_type

◆ dt_type [2/2]

typedef FRAME_H_DT_TYPE FrameCPP::Version_3::FrameHNPS::dt_type

◆ frame_type [1/2]

typedef FRAME_H_FRAME_TYPE FrameCPP::Version_3::FrameHNPS::frame_type

◆ frame_type [2/2]

typedef FRAME_H_FRAME_TYPE FrameCPP::Version_3::FrameHNPS::frame_type

◆ GTime_type [1/2]

typedef FRAME_H_G_TIME_TYPE FrameCPP::Version_3::FrameHNPS::GTime_type

◆ GTime_type [2/2]

typedef FRAME_H_G_TIME_TYPE FrameCPP::Version_3::FrameHNPS::GTime_type

◆ GTimeN_type [1/2]

typedef FRAME_H_G_TIME_N_TYPE FrameCPP::Version_3::FrameHNPS::GTimeN_type

◆ GTimeN_type [2/2]

typedef FRAME_H_G_TIME_N_TYPE FrameCPP::Version_3::FrameHNPS::GTimeN_type

◆ GTimeS_type [1/2]

typedef FRAME_H_G_TIME_S_TYPE FrameCPP::Version_3::FrameHNPS::GTimeS_type

◆ GTimeS_type [2/2]

typedef FRAME_H_G_TIME_S_TYPE FrameCPP::Version_3::FrameHNPS::GTimeS_type

◆ localTime_type [1/2]

typedef FRAME_H_LOCAL_TIME_TYPE FrameCPP::Version_3::FrameHNPS::localTime_type

◆ localTime_type [2/2]

typedef FRAME_H_LOCAL_TIME_TYPE FrameCPP::Version_3::FrameHNPS::localTime_type

◆ name_type [1/2]

typedef FRAME_H_NAME_TYPE FrameCPP::Version_3::FrameHNPS::name_type

◆ name_type [2/2]

typedef FRAME_H_NAME_TYPE FrameCPP::Version_3::FrameHNPS::name_type

◆ run_type [1/2]

typedef FRAME_H_RUN_TYPE FrameCPP::Version_3::FrameHNPS::run_type

◆ run_type [2/2]

typedef FRAME_H_RUN_TYPE FrameCPP::Version_3::FrameHNPS::run_type

◆ ULeapS_type [1/2]

typedef FRAME_H_U_LEAP_S_TYPE FrameCPP::Version_3::FrameHNPS::ULeapS_type

◆ ULeapS_type [2/2]

typedef FRAME_H_U_LEAP_S_TYPE FrameCPP::Version_3::FrameHNPS::ULeapS_type

Constructor & Destructor Documentation

◆ FrameHNPS() [1/6]

FrameHNPS::FrameHNPS ( )

Default constructor.

◆ FrameHNPS() [2/6]

FrameHNPS::FrameHNPS ( const FrameHNPS & Source)

Copy Constructor.

Parameters
[in]SourceThe

◆ FrameHNPS() [3/6]

FrameHNPS::FrameHNPS ( const std::string & Name,
run_type Run,
frame_type Frame,
const GTime_type & GTimeValue,
ULeapS_type ULeapSValue,
localTime_type LocalTime,
const dt_type Dt )

Constructor.

◆ FrameHNPS() [4/6]

FrameCPP::Version_3::FrameHNPS::FrameHNPS ( )

Default constructor.

◆ FrameHNPS() [5/6]

FrameCPP::Version_3::FrameHNPS::FrameHNPS ( const FrameHNPS & Source)

Copy Constructor.

Parameters
[in]SourceThe

◆ FrameHNPS() [6/6]

FrameCPP::Version_3::FrameHNPS::FrameHNPS ( const std::string & Name,
run_type Run,
frame_type Frame,
const GTime_type & GTimeValue,
ULeapS_type ULeapSValue,
localTime_type LocalTime,
const dt_type Dt )

Constructor.

Member Function Documentation

◆ assign() [1/2]

void FrameHNPS::assign ( assign_stream_type & Stream)
protected

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.

◆ assign() [2/2]

void FrameCPP::Version_3::FrameHNPS::assign ( assign_stream_type & Stream)
protected

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.

◆ bytes() [1/2]

streamsize_type FrameHNPS::bytes ( ) const
inlineprotected

Number of bytes required by this object.

Returns
The number of bytes need to read or write this object to a stream.

◆ bytes() [2/2]

streamsize_type FrameCPP::Version_3::FrameHNPS::bytes ( ) const
protected

Number of bytes required by this object.

Returns
The number of bytes need to read or write this object to a stream.

◆ compare_nps() [1/2]

bool FrameHNPS::compare_nps ( const FrameHNPS & RHS) const
inlineprotected

◆ compare_nps() [2/2]

bool FrameCPP::Version_3::FrameHNPS::compare_nps ( const FrameHNPS & RHS) const
protected

◆ dataDescription() [1/2]

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

Dictionary description of data.

Parameters
[out]DescThe handle to a dictionary description to which this type of object is to be added.

◆ dataDescription() [2/2]

void FrameCPP::Version_3::FrameHNPS::dataDescription ( Common::Description & Desc)
staticprotected

Dictionary description of data.

Parameters
[out]DescThe handle to a dictionary description to which this type of object is to be added.

◆ GetDt() [1/2]

FrameHNPS::dt_type FrameHNPS::GetDt ( ) const
inline

◆ GetDt() [2/2]

dt_type FrameCPP::Version_3::FrameHNPS::GetDt ( ) const

◆ GetFrame() [1/2]

FrameHNPS::frame_type FrameHNPS::GetFrame ( ) const
inline

◆ GetFrame() [2/2]

frame_type FrameCPP::Version_3::FrameHNPS::GetFrame ( ) const

◆ GetGTime() [1/2]

const FrameHNPS::GTime_type & FrameHNPS::GetGTime ( ) const
inline

◆ GetGTime() [2/2]

const GTime_type & FrameCPP::Version_3::FrameHNPS::GetGTime ( ) const

◆ GetLocalTime() [1/2]

FrameHNPS::localTime_type FrameHNPS::GetLocalTime ( ) const
inline

◆ GetLocalTime() [2/2]

localTime_type FrameCPP::Version_3::FrameHNPS::GetLocalTime ( ) const

◆ GetName() [1/2]

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

◆ GetName() [2/2]

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

◆ GetRun() [1/2]

FrameHNPS::run_type FrameHNPS::GetRun ( ) const
inline

◆ GetRun() [2/2]

run_type FrameCPP::Version_3::FrameHNPS::GetRun ( ) const

◆ GetULeapS() [1/2]

FrameHNPS::ULeapS_type FrameHNPS::GetULeapS ( ) const
inline

◆ GetULeapS() [2/2]

ULeapS_type FrameCPP::Version_3::FrameHNPS::GetULeapS ( ) const

◆ read() [1/2]

void FrameHNPS::read ( istream_type & Stream)
inlineprotected

◆ read() [2/2]

void FrameCPP::Version_3::FrameHNPS::read ( istream_type & Stream)
protected

◆ SetDt() [1/2]

void FrameHNPS::SetDt ( dt_type Dt)
inline

◆ SetDt() [2/2]

void FrameCPP::Version_3::FrameHNPS::SetDt ( dt_type Dt)

◆ SetGTime() [1/2]

void FrameHNPS::SetGTime ( const GTime_type & Value)
inline

◆ SetGTime() [2/2]

void FrameCPP::Version_3::FrameHNPS::SetGTime ( const GTime_type & Value)

◆ SetRun() [1/2]

void FrameHNPS::SetRun ( run_type Run)
inline

◆ SetRun() [2/2]

void FrameCPP::Version_3::FrameHNPS::SetRun ( run_type 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]ValueNumber of leap seconds since GPS epoc.

◆ SetULeapS() [2/2]

void FrameCPP::Version_3::FrameHNPS::SetULeapS ( ULeapS_type Value)

Establish leap second offset.

Parameters
[in]ValueNumber of leap seconds since GPS epoc.

◆ write() [1/2]

void FrameHNPS::write ( ostream_type & Stream) const
inlineprotected

◆ write() [2/2]

void FrameCPP::Version_3::FrameHNPS::write ( ostream_type & Stream) const
protected

Member Data Documentation

◆ dt

dt_type FrameHNPS::dt
protected

Frame length in seconds.

◆ frame

frame_type FrameHNPS::frame
protected

Frame number.

This value is monotonically increasing until the end of the run.

◆ GTime

GTime_type FrameHNPS::GTime
protected

Frame start time.

The GPS time since GPS standard epoch.

◆ localTime

localTime_type FrameHNPS::localTime
protected

Local seasonal time.

UTC in seconds [integer multiple of 1800 seconds].

◆ name

name_type FrameHNPS::name
protected

Name of project or other experiment description.

Name of project or other experiment description. (e.g., GEO; LIGO; VIRGO; TAMA; ...)

◆ run

run_type FrameHNPS::run
protected

Run number.

◆ ULeapS

ULeapS_type FrameHNPS::ULeapS
protected

The number of leap seconds.

The integer number of leap seconds between GPS\/TAI and UTC in the epoch when the frame is written: ULeapS = Int[TAI - UTC].

The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version3/FrameH.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version3/FrameH.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version3/FrameH.cc