Frame Header. More...

#include <FrameH.hh>

Inheritance diagram for FrameCPP::Version_8::FrameH:

Collaboration diagram for FrameCPP::Version_8::FrameH:

Public Member Functions
	FrameH ()
	Default constructor.

	FrameH (const FrameH &frame)

	FrameH (const std::string &name, INT_4S run, INT_4U frame, const GPSTime &time, INT_2U uLeapS, const REAL_8 dt, INT_4U dqual=0)
	Explicate construction. More...

	FrameH (const FrameHNPS &Source)
	Copy constructor. More...

	FrameH (const Previous::FrameH &Source, istream_type *Stream)
	Upconvert constructor. More...

	~FrameH ()
	Destructor.

virtual FrameH *	Clone () const
	Virtual constructor.

virtual const char *	ObjectStructName () const
	The name structure name of this object. More...

bool	operator== (const FrameH &RHS) const
	equality operator More...

virtual bool	operator== (const Common::FrameSpec::Object &RHS) const
	equality operator for abstract data type More...

	FrameH ()
	Default constructor.

	FrameH (const FrameH &frame)

	FrameH (const std::string &name, INT_4S run, INT_4U frame, const GPSTime &time, INT_2U uLeapS, const REAL_8 dt, INT_4U dqual=0)
	Explicate construction. More...

	FrameH (const FrameHNPS &Source)
	Copy constructor. More...

	FrameH (const Previous::FrameH &Source, istream_type *Stream)
	Upconvert constructor. More...

	~FrameH ()
	Destructor.

virtual FrameH *	Clone () const
	Virtual constructor.

virtual const char *	ObjectStructName () const
	The name structure name of this object. More...

bool	operator== (const FrameH &RHS) const
	equality operator More...

virtual bool	operator== (const Common::FrameSpec::Object &RHS) const
	equality operator for abstract data type More...

virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object. More...

virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object. More...

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor. More...

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor. More...

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

rawData_type	GetRawData () const
	Retrieve the raw data reference. More...

rawData_type	GetRawData ()
	Retrieve the raw data reference. More...

rawData_type	GetRawData () const
	Retrieve the raw data reference. More...

rawData_type	GetRawData ()
	Retrieve the raw data reference. More...

Static Public Member Functions
static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
	Promote previous version of object to this version. More...

static const char *	StructName ()
	The name structure name of this object. More...

static const Common::Description *	StructDescription ()
	The description of structure. More...

static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
	Promote previous version of object to this version. More...

static const char *	StructName ()
	The name structure name of this object. More...

static const Common::Description *	StructDescription ()
	The description of structure. More...

static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.

static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.

static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.

static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.

Protected Member Functions
virtual void	assign (assign_stream_type &Stream)
	Assign the contents of the instance. More...

virtual void	readSubset (istream_type &Stream, INT_4U ElementMask)
	Limitted reading of the object. More...

virtual start_time_normalized_type	normalizedStartTime () const
	Frame start time in seconds.

virtual delta_t_normalized_type	normalizedDeltaT () const
	Duration of the frame.

cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...

virtual FrameH *	pCreate (istream_type &Stream) const
	Virtual constructor. More...

virtual void	pWrite (ostream_type &Stream) const
	Write the structure to the stream. More...

virtual void	VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
	Verify the object as being valid. More...

virtual void	assign (assign_stream_type &Stream)
	Assign the contents of the instance. More...

virtual void	readSubset (istream_type &Stream, INT_4U ElementMask)
	Limitted reading of the object. More...

virtual start_time_normalized_type	normalizedStartTime () const
	Frame start time in seconds.

virtual delta_t_normalized_type	normalizedDeltaT () const
	Duration of the frame.

cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...

virtual FrameH *	pCreate (istream_type &Stream) const
	Virtual constructor. More...

virtual void	pWrite (ostream_type &Stream) const
	Write the structure to the stream. More...

virtual void	VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
	Verify the object as being valid. More...

virtual void	pWrite (ostream_type &Stream) const=0
	Write the structure to the stream. More...

Detailed Description

Frame Header.

Constructor & Destructor Documentation

◆ FrameH() [1/8]

FrameH::FrameH ( const FrameH & frame )

Parameters

[in] frame Frame to use as the base

◆ FrameH() [2/8]

FrameH::FrameH	(	const std::string &	name,
		INT_4S	run,
		INT_4U	frame,
		const GPSTime &	time,
		INT_2U	uLeapS,
		const REAL_8	dt,
		INT_4U	dqual = `0`
	)

Explicate construction.

Parameters

[in]	name	Name of project or other experiment description
[in]	run	Run number (number < 0 reserved for simulated data); monotonic for experimental runs.
[in]	frame	Frame number, monotonically increasing until end of run, re-starting from 0 with each new run.
[in]	time	Frame start time in GPS units.
[in]	uLeapS	The integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written.
[in]	dt	Frame length in seconds
[in]	dqual	Data quality flag

Returns: A new instance of this object.

◆ FrameH() [3/8]

FrameH::FrameH ( const FrameHNPS & Source )

Copy constructor.

Parameters

[in] Source The non-pointer portion of the frame header.

◆ FrameH() [4/8]

FrameH::FrameH	(	const Previous::FrameH &	Source,
		istream_type *	Stream
	)

inline

Upconvert constructor.

Parameters

[in]	Source	An instance of a similiar object from a previous version of the frame specification.
[in]	Stream	The stream from which the origional object was read.

◆ FrameH() [5/8]

FrameCPP::Version_8::FrameH::FrameH ( const FrameH & frame )

Parameters

[in] frame Frame to use as the base

◆ FrameH() [6/8]

FrameCPP::Version_8::FrameH::FrameH	(	const std::string &	name,
		INT_4S	run,
		INT_4U	frame,
		const GPSTime &	time,
		INT_2U	uLeapS,
		const REAL_8	dt,
		INT_4U	dqual = `0`
	)

Explicate construction.

Parameters

[in]	name	Name of project or other experiment description
[in]	run	Run number (number < 0 reserved for simulated data); monotonic for experimental runs.
[in]	frame	Frame number, monotonically increasing until end of run, re-starting from 0 with each new run.
[in]	time	Frame start time in GPS units.
[in]	uLeapS	The integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written.
[in]	dt	Frame length in seconds
[in]	dqual	Data quality flag

Returns: A new instance of this object.

◆ FrameH() [7/8]

FrameCPP::Version_8::FrameH::FrameH ( const FrameHNPS & Source )

Copy constructor.

Parameters

[in] Source The non-pointer portion of the frame header.

◆ FrameH() [8/8]

FrameCPP::Version_8::FrameH::FrameH	(	const Previous::FrameH &	Source,
		istream_type *	Stream
	)

Upconvert constructor.

Parameters

[in]	Source	An instance of a similiar object from a previous version of the frame specification.
[in]	Stream	The stream from which the origional object was read.

Member Function Documentation

◆ assign() [1/2]

virtual void FrameCPP::Version_8::FrameH::assign ( assign_stream_type & Stream )

protectedvirtual

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 FrameH::assign ( assign_stream_type & Stream )

protectedvirtual

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]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in] Stream Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns: The number of bytes for this object

◆ Bytes() [2/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in] Stream Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns: The number of bytes for this object

◆ Create() [1/2]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [2/2]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ GetRawData() [1/4]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >

rawData_type FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::GetRawData ( ) const

inlineinherited

Retrieve the raw data reference.

Returns: A pointer to the raw data structure.

◆ GetRawData() [2/4]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >

rawData_type FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::GetRawData ( ) const

inlineinherited

Retrieve the raw data reference.

Returns: A pointer to the raw data structure.

◆ GetRawData() [3/4]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >

rawData_type FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::GetRawData ( )

inlineinherited

Retrieve the raw data reference.

Returns: A pointer to the raw data structure.

◆ GetRawData() [4/4]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >

rawData_type FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::GetRawData ( )

inlineinherited

Retrieve the raw data reference.

Returns: A pointer to the raw data structure.

◆ ObjectStructName() [1/2]

const char * FrameH::ObjectStructName ( ) const

virtual

The name structure name of this object.

Returns: The name of the structure as specified by the frame specification.

◆ ObjectStructName() [2/2]

virtual const char* FrameCPP::Version_8::FrameH::ObjectStructName ( ) const

virtual

The name structure name of this object.

Returns: The name of the structure as specified by the frame specification.

◆ operator==() [1/4]

bool FrameCPP::Version_8::FrameH::operator== ( const FrameH & RHS ) const

equality operator

Parameters

[in] RHS The FrameH object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/4]

bool FrameH::operator== ( const FrameH & RHS ) const

inline

equality operator

Parameters

[in] RHS The FrameH object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/4]

virtual bool FrameCPP::Version_8::FrameH::operator== ( const Common::FrameSpec::Object & RHS ) const

virtual

equality operator for abstract data type

Parameters

[in] RHS The object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [4/4]

bool FrameH::operator== ( const Common::FrameSpec::Object & RHS ) const

virtual

equality operator for abstract data type

Parameters

[in] RHS The object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ pBytes() [1/2]

FrameCPP::cmn_streamsize_type FrameH::pBytes ( const Common::StreamBase & Stream ) const

protectedvirtual

Number of bytes needed to write this structure.

Parameters

[in] Stream The stream from which to the object is being read or written.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::FrameH::pBytes ( const Common::StreamBase & Stream ) const

protectedvirtual

Number of bytes needed to write this structure.

Parameters

[in] Stream The stream from which to the object is being read or written.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pCreate() [1/2]

FrameH * FrameH::pCreate ( istream_type & Stream ) const

protectedvirtual

Virtual constructor.

Parameters

[in] Stream The input stream from which to read the object.

Returns: A new instance of this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pCreate() [2/2]

virtual FrameH* FrameCPP::Version_8::FrameH::pCreate ( istream_type & Stream ) const

protectedvirtual

Virtual constructor.

Parameters

[in] Stream The input stream from which to read the object.

Returns: A new instance of this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ Promote() [1/2]

static promote_ret_type FrameCPP::Version_8::FrameH::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		istream_type *	Stream
	)

static

Promote previous version of object to this version.

Parameters

[in]	Source	The frame specification version of the object.
[in]	Obj	The previous version of the object.
[in]	Stream	Stream from which the origional object was created.

Returns: A new instance of FrameH based on Obj

◆ Promote() [2/2]

FrameH::promote_ret_type FrameH::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		istream_type *	Stream
	)

inlinestatic

Promote previous version of object to this version.

Parameters

[in]	Source	The frame specification version of the object.
[in]	Obj	The previous version of the object.
[in]	Stream	Stream from which the origional object was created.

Returns: A new instance of FrameH based on Obj

◆ pWrite() [1/3]

void FrameH::pWrite ( ostream_type & Stream ) const

protectedvirtual

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

◆ pWrite() [2/3]

virtual void FrameCPP::Version_8::FrameH::pWrite ( ostream_type & Stream ) const

protectedvirtual

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

◆ pWrite() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pWrite ( ostream_type & Stream ) const

protectedpure virtualinherited

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

◆ readSubset() [1/2]

void FrameH::readSubset	(	istream_type &	Stream,
		INT_4U	ElementMask
	)

protectedvirtual

Limitted reading of the object.

Parameters

[in]	Stream	The input stream from which to read the object.
[in]	ElementMask	Mask of elements to read from the Stream

◆ readSubset() [2/2]

virtual void FrameCPP::Version_8::FrameH::readSubset	(	istream_type &	Stream,
		INT_4U	ElementMask
	)

protectedvirtual

Limitted reading of the object.

Parameters

[in]	Stream	The input stream from which to read the object.
[in]	ElementMask	Mask of elements to read from the Stream

◆ StructDescription() [1/2]

const Description * FrameH::StructDescription ( )

static

The description of structure.

Returns: A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

static const Common::Description* FrameCPP::Version_8::FrameH::StructDescription ( )

static

The description of structure.

Returns: A Description object which describes this structure as specified by the frame specification.

◆ StructName() [1/2]

static const char* FrameCPP::Version_8::FrameH::StructName ( )

static

The name structure name of this object.

Returns: The name of the structure as specified by the frame specification.

◆ StructName() [2/2]

const char * FrameH::StructName ( )

inlinestatic

The name structure name of this object.

Returns: The name of the structure as specified by the frame specification.

◆ VerifyObject() [1/2]

void FrameH::VerifyObject	(	Common::Verify &	Verifier,
		Common::IFrameStream &	Stream
	)		const

protectedvirtual

Verify the object as being valid.

Parameters

[in]	Verifier	The instance of the Verify object where state information is stored.
[in]	Stream	The input stream from which the object is being read.

◆ VerifyObject() [2/2]

virtual void FrameCPP::Version_8::FrameH::VerifyObject	(	Common::Verify &	Verifier,
		Common::IFrameStream &	Stream
	)		const

protectedvirtual

Verify the object as being valid.

Parameters

[in]	Verifier	The instance of the Verify object where state information is stored.
[in]	Stream	The input stream from which the object is being read.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FrameH() [1/8]

◆ FrameH() [2/8]

◆ FrameH() [3/8]

◆ FrameH() [4/8]

◆ FrameH() [5/8]

◆ FrameH() [6/8]

◆ FrameH() [7/8]

◆ FrameH() [8/8]

Member Function Documentation

◆ assign() [1/2]

◆ assign() [2/2]

◆ Bytes() [1/2]

◆ Bytes() [2/2]

◆ Create() [1/2]

◆ Create() [2/2]

◆ GetRawData() [1/4]

◆ GetRawData() [2/4]

◆ GetRawData() [3/4]

◆ GetRawData() [4/4]

◆ ObjectStructName() [1/2]

◆ ObjectStructName() [2/2]

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ pBytes() [1/2]

◆ pBytes() [2/2]

◆ pCreate() [1/2]

◆ pCreate() [2/2]

◆ Promote() [1/2]

◆ Promote() [2/2]

◆ pWrite() [1/3]

◆ pWrite() [2/3]

◆ pWrite() [3/3]

◆ readSubset() [1/2]

◆ readSubset() [2/2]

◆ StructDescription() [1/2]

◆ StructDescription() [2/2]

◆ StructName() [1/2]

◆ StructName() [2/2]

◆ VerifyObject() [1/2]

◆ VerifyObject() [2/2]