ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType > Class Template Reference

ADC Data that does reference a pointer. More...

#include <FrAdcDataPST.hh>

Collaboration diagram for FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >:
Collaboration graph
[legend]

Public Member Functions

const aux_type & RefAux () const
 Identifier for vector for user-provided information.
aux_type & RefAux ()
 Identifier for vector for user-provided information.
const data_type & RefData () const
 Identifier for vector of sampled data.
data_type & RefData ()
 Identifier for vector of sampled data.
const aux_type & RefAux () const
 Identifier for vector for user-provided information.
aux_type & RefAux ()
 Identifier for vector for user-provided information.
const data_type & RefData () const
 Identifier for vector of sampled data.
data_type & RefData ()
 Identifier for vector of sampled data.

Protected Member Functions

 FrAdcDataPST ()
 Default constructor.
 FrAdcDataPST (Common::IStream &Stream)
 Initialzie the instance from an input stream.
template<typename PreviousType>
 FrAdcDataPST (const PreviousType &Source, stream_base_type *Stream)
 Initialzie the instance from an input stream.
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
void copyCore (const FrAdcDataPST &Source)
 Copy key pieces when duplicating the object.
void write (Common::OStream &Stream) const
 Write contents to the stream.
bool operator== (const FrAdcDataPST &RHS) const
 Comparison operator.
 FrAdcDataPST ()
 Default constructor.
 FrAdcDataPST (Common::IStream &Stream)
 Initialzie the instance from an input stream.
template<typename PreviousType>
 FrAdcDataPST (const PreviousType &Source, stream_base_type *Stream)
 Initialzie the instance from an input stream.
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
void copyCore (const FrAdcDataPST &Source)
 Copy key pieces when duplicating the object.
void write (Common::OStream &Stream) const
 Write contents to the stream.
bool operator== (const FrAdcDataPST &RHS) const
 Comparison operator.

Static Protected Member Functions

template<typename DescriptionType, typename FrSEType>
static void structDescription (DescriptionType &Desc, const std::string &FrVectStructName)
 Provide a description of object.
template<typename DescriptionType, typename FrSEType>
static void structDescription (DescriptionType &Desc, const std::string &FrVectStructName)
 Provide a description of object.

Protected Attributes

data_type data
aux_type aux

Detailed Description

template<typename DataType, typename AuxType>
class FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >

ADC Data that does reference a pointer.

Constructor & Destructor Documentation

◆ FrAdcDataPST() [1/2]

template<typename DataType, typename AuxType>
FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::FrAdcDataPST ( )
inlineprotected

Default constructor.

The object is contructed using default rules.

◆ FrAdcDataPST() [2/2]

template<typename DataType, typename AuxType>
FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::FrAdcDataPST ( Common::IStream & Stream)
inlineprotected

Initialzie the instance from an input stream.

Initialzie the instance from an input stream

Member Function Documentation

◆ Bytes() [1/2]

template<typename DataType, typename AuxType>
cmn_streamsize_type FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::Bytes ( const Common::StreamBase & Stream) const
inlineprotected

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ Bytes() [2/2]

template<typename DataType, typename AuxType>
cmn_streamsize_type FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::Bytes ( const Common::StreamBase & Stream) const
protected

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ copyCore() [1/2]

template<typename DataType, typename AuxType>
void FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::copyCore ( const FrAdcDataPST< DataType, AuxType > & Source)
inlineprotected

Copy key pieces when duplicating the object.

Parameters
[in]SourceThe refence to use as the pattern of information to copied.

◆ copyCore() [2/2]

template<typename DataType, typename AuxType>
void FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::copyCore ( const FrAdcDataPST< DataType, AuxType > & Source)
protected

Copy key pieces when duplicating the object.

Parameters
[in]SourceThe refence to use as the pattern of information to copied.

◆ RefAux() [1/4]

template<typename DataType, typename AuxType>
FrAdcDataPST< DataType, AuxType >::aux_type & FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::RefAux ( )
inline

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.

◆ RefAux() [2/4]

template<typename DataType, typename AuxType>
aux_type & FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::RefAux ( )

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.

◆ RefAux() [3/4]

template<typename DataType, typename AuxType>
const FrAdcDataPST< DataType, AuxType >::aux_type & FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::RefAux ( ) const
inline

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefAux() [4/4]

template<typename DataType, typename AuxType>
const aux_type & FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::RefAux ( ) const

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefData() [1/4]

template<typename DataType, typename AuxType>
FrAdcDataPST< DataType, AuxType >::data_type & FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::RefData ( )
inline

Identifier for vector of sampled data.

Returns
A reference to the sampled data.

◆ RefData() [2/4]

template<typename DataType, typename AuxType>
data_type & FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::RefData ( )

Identifier for vector of sampled data.

Returns
A reference to the sampled data.

◆ RefData() [3/4]

template<typename DataType, typename AuxType>
const FrAdcDataPST< DataType, AuxType >::data_type & FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::RefData ( ) const
inline

Identifier for vector of sampled data.

Returns
A constant reference to the sampled data.

◆ RefData() [4/4]

template<typename DataType, typename AuxType>
const data_type & FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::RefData ( ) const

Identifier for vector of sampled data.

Returns
A constant reference to the sampled data.

Member Data Documentation

◆ aux

template<typename DataType, typename AuxType>
aux_type FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::aux
protected

Identifier fro vector for user-provided information. Its use is generic.

◆ data

template<typename DataType, typename AuxType>
data_type FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::data
protected

Identifier for vector of sampled data.

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