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

#include <FrSummary.hh>

Inheritance diagram for FrameCPP::Version_3::FrSummary:
Collaboration diagram for FrameCPP::Version_3::FrSummary:

Classes

struct  fr_summary_data_type

Public Types

typedef Common::SearchContainer< FrVect, &FrVect::GetName > moments_type
typedef moments_type::iterator iterator
typedef moments_type::const_iterator const_iterator
typedef Common::SearchContainer< FrVect, &FrVect::GetName > moments_type
typedef moments_type::iterator iterator
typedef moments_type::const_iterator const_iterator
typedef FrameSpec::version_type frame_spec_version_type
typedef FrameSpec::version_type frame_spec_version_type
typedef boost::shared_ptr< Objectobject_type
typedef boost::shared_ptr< Objectobject_type
typedef std::unique_ptr< Objectunique_object_type
typedef std::unique_ptr< Objectunique_object_type
typedef object_type demote_arg_type
typedef object_type demote_arg_type
typedef object_type demote_ret_type
typedef object_type demote_ret_type
typedef stream_base_type demote_stream_type
typedef stream_base_type demote_stream_type
typedef object_type promote_arg_type
typedef object_type promote_arg_type
typedef object_type promote_ret_type
typedef object_type promote_ret_type
typedef stream_base_type promote_stream_type
typedef stream_base_type promote_stream_type

Public Member Functions

 FrSummary ()
 Default constructor.
 FrSummary (const FrSummary &Summary)
 FrSummary (const std::string &name, const std::string &comment, const std::string &test)
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
virtual FrSummaryCreate (istream_type &Stream) const
 constructor - virtual
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
const std::string & GetName () const
const std::string & GetComment () const
const std::string & GetTest () const
const moments_typeRefMoments () const
moments_typeRefMoments ()
FrSummaryMerge (const FrSummary &RHS)
 Merge with another FrAdcData.
bool operator== (const FrSummary &RHS) const
 comparison operator
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 FrSummary ()
 Default constructor.
 FrSummary (const FrSummary &Summary)
 FrSummary (const std::string &name, const std::string &comment, const std::string &test)
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
virtual FrSummaryCreate (istream_type &Stream) const
 constructor - virtual
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
const std::string & GetName () const
const std::string & GetComment () const
const std::string & GetTest () const
const moments_typeRefMoments () const
moments_typeRefMoments ()
FrSummaryMerge (const FrSummary &RHS)
 Merge with another FrAdcData.
bool operator== (const FrSummary &RHS) const
 comparison operator
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
class_type GetClass () const
 Retrieve the class identifier.
class_type GetClass () const
 Retrieve the class identifier.
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
virtual const DescriptionGetDescription (ostream_type &Stream) const
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
virtual const DescriptionGetDescription (ostream_type &Stream) const
frame_spec_version_type FrameSpecVersion () const
frame_spec_version_type FrameSpecVersion () const
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
virtual ObjectCreate () const
 constructor - virtual
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
virtual ObjectClone () const
 constructor - virtual copy constructor
virtual ObjectClone () const
 constructor - virtual copy constructor
template<typename PreviousType, typename CurrentType>
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream)
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
static const char * StructName ()
static const Common::DescriptionStructDescription ()
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
static const char * StructName ()
static const Common::DescriptionStructDescription ()
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
template<typename PreviousType, typename CurrentType>
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
template<typename PreviousType, typename CurrentType>
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
virtual class_type getClass () const
 Retrieve the class identifier.
virtual class_type getClass () const
 Retrieve the class identifier.

Private Member Functions

 FrSummary (istream_type &Stream)
 FrSummary (istream_type &Stream)

Private Attributes

fr_summary_data_type m_data
const class_type m_class
 Storage for the class identifier.
const Description *const m_desc
 Description for parent class.
const frame_spec_version_type frame_spec_version
 Version of the frame specification.

Member Typedef Documentation

◆ const_iterator [1/2]

typedef moments_type::const_iterator FrameCPP::Version_3::FrSummary::const_iterator

◆ const_iterator [2/2]

typedef moments_type::const_iterator FrameCPP::Version_3::FrSummary::const_iterator

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ demote_stream_type [1/2]

◆ demote_stream_type [2/2]

◆ frame_spec_version_type [1/2]

◆ frame_spec_version_type [2/2]

◆ iterator [1/2]

typedef moments_type::iterator FrameCPP::Version_3::FrSummary::iterator

◆ iterator [2/2]

typedef moments_type::iterator FrameCPP::Version_3::FrSummary::iterator

◆ moments_type [1/2]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_3::FrSummary::moments_type

◆ moments_type [2/2]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_3::FrSummary::moments_type

◆ object_type [1/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ object_type [2/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ promote_arg_type [1/2]

◆ promote_arg_type [2/2]

◆ promote_ret_type [1/2]

◆ promote_ret_type [2/2]

◆ promote_stream_type [1/2]

◆ promote_stream_type [2/2]

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

Constructor & Destructor Documentation

◆ FrSummary() [1/8]

FrameCPP::Version_3::FrSummary::FrSummary ( )

Default constructor.

◆ FrSummary() [2/8]

FrameCPP::Version_3::FrSummary::FrSummary ( const FrSummary & Summary)

◆ FrSummary() [3/8]

FrameCPP::Version_3::FrSummary::FrSummary ( const std::string & name,
const std::string & comment,
const std::string & test )

◆ FrSummary() [4/8]

FrameCPP::Version_3::FrSummary::FrSummary ( istream_type & Stream)
private

◆ FrSummary() [5/8]

FrameCPP::Version_3::FrSummary::FrSummary ( )

Default constructor.

◆ FrSummary() [6/8]

FrameCPP::Version_3::FrSummary::FrSummary ( const FrSummary & Summary)

◆ FrSummary() [7/8]

FrameCPP::Version_3::FrSummary::FrSummary ( const std::string & name,
const std::string & comment,
const std::string & test )

◆ FrSummary() [8/8]

FrameCPP::Version_3::FrSummary::FrSummary ( istream_type & Stream)
private

Member Function Documentation

◆ Bytes() [1/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_3::FrSummary::Bytes ( const Common::StreamBase & Stream) const
virtual

Number of bytes needed to write this structure.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Bytes() [2/2]

cmn_streamsize_type FrameCPP::Version_3::FrSummary::Bytes ( const Common::StreamBase & Stream) const
virtual

Number of bytes needed to write this structure.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Clone() [1/2]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ Clone() [2/2]

virtual Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ Create() [1/4]

◆ Create() [2/4]

◆ Create() [3/4]

FrSummary * FrameCPP::Version_3::FrSummary::Create ( istream_type & Stream) const
virtual

constructor - virtual

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [4/4]

virtual FrSummary * FrameCPP::Version_3::FrSummary::Create ( istream_type & Stream) const
virtual

constructor - virtual

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ demote() [1/2]

FrSummary::demote_ret_type FrameCPP::Version_3::FrSummary::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
protectedvirtual

Down grade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_3::FrSummary::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
protectedvirtual

Down grade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DemoteObject() [1/2]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_type * Stream )
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ DemoteObject() [2/2]

object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_type * Stream )
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ FrameSpecVersion() [1/2]

FrameSpec::Object::frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inlineinherited

◆ FrameSpecVersion() [2/2]

frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inherited

◆ GetClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ getClass() [2/2]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetComment() [1/2]

const std::string & FrameCPP::Version_3::FrSummary::GetComment ( ) const
inline

◆ GetComment() [2/2]

const std::string & FrameCPP::Version_3::FrSummary::GetComment ( ) const

◆ GetDescription() [1/4]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [2/4]

virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
virtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [3/4]

◆ GetDescription() [4/4]

◆ GetName() [1/2]

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

◆ GetName() [2/2]

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

◆ GetTest() [1/2]

const std::string & FrameCPP::Version_3::FrSummary::GetTest ( ) const
inline

◆ GetTest() [2/2]

const std::string & FrameCPP::Version_3::FrSummary::GetTest ( ) const

◆ Merge() [1/2]

FrSummary & FrameCPP::Version_3::FrSummary::Merge ( const FrSummary & RHS)

Merge with another FrAdcData.

Todo
Need to implement Merge routine

◆ Merge() [2/2]

FrSummary & FrameCPP::Version_3::FrSummary::Merge ( const FrSummary & RHS)

Merge with another FrAdcData.

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_3::FrSummary::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_3::FrSummary::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [1/4]

bool FrameCPP::Version_3::FrSummary::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

comparison operator

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [2/4]

virtual bool FrameCPP::Version_3::FrSummary::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

comparison operator

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [3/4]

bool FrameCPP::Version_3::FrSummary::operator== ( const FrSummary & RHS) const
inline

comparison operator

◆ operator==() [4/4]

bool FrameCPP::Version_3::FrSummary::operator== ( const FrSummary & RHS) const

comparison operator

◆ Promote() [1/2]

FrSummary::promote_ret_type FrameCPP::Version_3::FrSummary::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestatic

◆ Promote() [2/2]

promote_ret_type FrameCPP::Version_3::FrSummary::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
static

◆ promote() [1/2]

FrSummary::promote_ret_type FrameCPP::Version_3::FrSummary::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
protectedvirtual

Upgrade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_3::FrSummary::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
protectedvirtual

Upgrade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ PromoteObject() [1/5]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/5]

template<typename PreviousType, typename CurrentType>
object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/5]

object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [4/5]

template<typename PreviousType, typename CurrentType>
object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [5/5]

template<typename PreviousType, typename CurrentType>
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type Target,
FrameSpec::ObjectInterface::frame_spec_version_type Source,
FrameSpec::ObjectInterface::promote_arg_type Obj,
promote_stream_type * Stream )
inherited

◆ RefMoments() [1/4]

FrSummary::moments_type & FrameCPP::Version_3::FrSummary::RefMoments ( )
inline

◆ RefMoments() [2/4]

moments_type & FrameCPP::Version_3::FrSummary::RefMoments ( )

◆ RefMoments() [3/4]

const FrSummary::moments_type & FrameCPP::Version_3::FrSummary::RefMoments ( ) const
inline

◆ RefMoments() [4/4]

const moments_type & FrameCPP::Version_3::FrSummary::RefMoments ( ) const

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_3::FrSummary::StructDescription ( )
static

◆ StructDescription() [2/2]

const Common::Description * FrameCPP::Version_3::FrSummary::StructDescription ( )
static

◆ StructName() [1/2]

const char * FrameCPP::Version_3::FrSummary::StructName ( )
inlinestatic

◆ StructName() [2/2]

const char * FrameCPP::Version_3::FrSummary::StructName ( )
static

◆ VerifyObject() [1/2]

◆ VerifyObject() [2/2]

◆ Write() [1/2]

void FrameCPP::Version_3::FrSummary::Write ( ostream_type & Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Write() [2/2]

virtual void FrameCPP::Version_3::FrSummary::Write ( ostream_type & Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext() [1/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

◆ WriteNext() [2/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

Member Data Documentation

◆ frame_spec_version

const frame_spec_version_type FrameCPP::Common::FrameSpec::Object::frame_spec_version
privateinherited

Version of the frame specification.

The version of the frame specification for which this object was created.

◆ m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class
privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

◆ m_data

fr_summary_data_type FrameCPP::Version_3::FrSummary::m_data
private

◆ m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc
privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.


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/FrSummary.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version3/FrSummary.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version3/FrSummary.cc