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:

Public Member Functions
	FrameHNPS ()
	Default constructor.
	FrameHNPS (const FrameHNPS &Source)
	Copy Constructor. More...
	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.
void	SetULeapS (ULeapS_type Value)
	Establish leap second offset. More...
	FrameHNPS ()
	Default constructor.
	FrameHNPS (const FrameHNPS &Source)
	Copy Constructor. More...
	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.
void	SetULeapS (ULeapS_type Value)
	Establish leap second offset. More...

Protected Member Functions
void	assign (assign_stream_type &Stream)
	Assign the contents of the instance. More...
streamsize_type	bytes () const
	Number of bytes required by this object. More...
void	assign (assign_stream_type &Stream)
	Assign the contents of the instance. More...
streamsize_type	bytes () const
	Number of bytes required by this object. More...

Static Protected Member Functions
static void	dataDescription (Common::Description &Desc)
	Dictionary description of data. More...
static void	dataDescription (Common::Description &Desc)
	Dictionary description of data. More...

Protected Attributes
name_type	name
	Name of project or other experiment description. More...
run_type	run
	Run number.
frame_type	frame
	Frame number. More...
GTime_type	GTime
	Frame start time. More...
ULeapS_type	ULeapS
	The number of leap seconds. More...
localTime_type	localTime
	Local seasonal time. More...
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.

Constructor & Destructor Documentation

FrameHNPS() [1/2]

FrameHNPS::FrameHNPS

(

const FrameHNPS &

Source

)

Copy Constructor.

Parameters

[in]

Source

The

FrameHNPS() [2/2]

FrameCPP::Version_3::FrameHNPS::FrameHNPS

(

const FrameHNPS &

Source

)

Copy Constructor.

Parameters

[in]

Source

The

Member Function Documentation

assign() [1/2]

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

assign() [2/2]

void FrameCPP::Version_3::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.

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.

dataDescription() [1/2]

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

staticprotected

Dictionary description of data.

Parameters

[out]

Desc

The handle to a dictionary description to which this type of object is to be added.

dataDescription() [2/2]

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

inlinestaticprotected

Dictionary description of data.

Parameters

[out]

Desc

The handle to a dictionary description to which this type of object is to be added.

SetULeapS() [1/2]

void FrameCPP::Version_3::FrameHNPS::SetULeapS

(

ULeapS_type

Value

)

Establish leap second offset.

Parameters

[in]

Value

Number of leap seconds since GPS epoc.

SetULeapS() [2/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.

Member Data Documentation

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; ...)

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-2.7.0/include/framecpp/Version3/FrameH.hh
• Version3/FrameH.cc