ldas-tools-framecpp  2.8.1
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
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 Types

typedef DataType data_value_type
 
typedef Common::Container< data_value_typedata_type
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::iterator iterator
 
typedef Common::Container< AuxType > aux_type
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef aux_type::iterator aux_iterator
 
typedef DataType data_value_type
 
typedef Common::Container< data_value_typedata_type
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::iterator iterator
 
typedef Common::Container< AuxType > aux_type
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef aux_type::iterator aux_iterator
 
typedef DataType data_value_type
 
typedef Common::Container< data_value_typedata_type
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::iterator iterator
 
typedef Common::Container< AuxType > aux_type
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef aux_type::iterator aux_iterator
 

Public Member Functions

const aux_typeRefAux () const
 Identifier for vector for user-provided information. More...
 
aux_typeRefAux ()
 Identifier for vector for user-provided information. More...
 
const data_typeRefData () const
 Identifier for vector of sampled data. More...
 
data_typeRefData ()
 Identifier for vector of sampled data. More...
 
const aux_typeRefAux () const
 Identifier for vector for user-provided information. More...
 
aux_typeRefAux ()
 Identifier for vector for user-provided information. More...
 
const data_typeRefData () const
 Identifier for vector of sampled data. More...
 
data_typeRefData ()
 Identifier for vector of sampled data. More...
 
const aux_typeRefAux () const
 Identifier for vector for user-provided information. More...
 
aux_typeRefAux ()
 Identifier for vector for user-provided information. More...
 
const data_typeRefData () const
 Identifier for vector of sampled data. More...
 
data_typeRefData ()
 Identifier for vector of sampled data. More...
 

Static Public Attributes

static const INT_2U MAX_REF = 2
 

Protected Member Functions

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

Static Protected Member Functions

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

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.

Member Typedef Documentation

◆ aux_iterator [1/3]

template<typename DataType , typename AuxType >
typedef aux_type::iterator FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::aux_iterator

◆ aux_iterator [2/3]

template<typename DataType , typename AuxType >
typedef aux_type::iterator FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::aux_iterator

◆ aux_iterator [3/3]

template<typename DataType , typename AuxType >
typedef aux_type::iterator FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::aux_iterator

◆ aux_type [1/3]

template<typename DataType , typename AuxType >
typedef Common::Container< AuxType > FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::aux_type

◆ aux_type [2/3]

template<typename DataType , typename AuxType >
typedef Common::Container< AuxType > FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::aux_type

◆ aux_type [3/3]

template<typename DataType , typename AuxType >
typedef Common::Container< AuxType > FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::aux_type

◆ const_aux_iterator [1/3]

template<typename DataType , typename AuxType >
typedef aux_type::const_iterator FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::const_aux_iterator

◆ const_aux_iterator [2/3]

template<typename DataType , typename AuxType >
typedef aux_type::const_iterator FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::const_aux_iterator

◆ const_aux_iterator [3/3]

template<typename DataType , typename AuxType >
typedef aux_type::const_iterator FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::const_aux_iterator

◆ const_iterator [1/3]

template<typename DataType , typename AuxType >
typedef data_type::const_iterator FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::const_iterator

◆ const_iterator [2/3]

template<typename DataType , typename AuxType >
typedef data_type::const_iterator FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::const_iterator

◆ const_iterator [3/3]

template<typename DataType , typename AuxType >
typedef data_type::const_iterator FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::const_iterator

◆ data_type [1/3]

template<typename DataType , typename AuxType >
typedef Common::Container< data_value_type > FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::data_type

◆ data_type [2/3]

template<typename DataType , typename AuxType >
typedef Common::Container< data_value_type > FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::data_type

◆ data_type [3/3]

template<typename DataType , typename AuxType >
typedef Common::Container< data_value_type > FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::data_type

◆ data_value_type [1/3]

template<typename DataType , typename AuxType >
typedef DataType FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::data_value_type

◆ data_value_type [2/3]

template<typename DataType , typename AuxType >
typedef DataType FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::data_value_type

◆ data_value_type [3/3]

template<typename DataType , typename AuxType >
typedef DataType FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::data_value_type

◆ iterator [1/3]

template<typename DataType , typename AuxType >
typedef data_type::iterator FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::iterator

◆ iterator [2/3]

template<typename DataType , typename AuxType >
typedef data_type::iterator FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::iterator

◆ iterator [3/3]

template<typename DataType , typename AuxType >
typedef data_type::iterator FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::iterator

Constructor & Destructor Documentation

◆ FrAdcDataPST() [1/9]

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

Default constructor.

The object is contructed using default rules.

◆ FrAdcDataPST() [2/9]

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

◆ FrAdcDataPST() [3/9]

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

Initialzie the instance from an input stream.

◆ FrAdcDataPST() [4/9]

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

Default constructor.

◆ FrAdcDataPST() [5/9]

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

Initialzie the instance from an input stream.

◆ FrAdcDataPST() [6/9]

template<typename DataType , typename AuxType >
template<typename PreviousType >
FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::FrAdcDataPST ( const PreviousType &  Source,
Common::IStream Stream 
)
protected

Initialzie the instance from an input stream.

◆ FrAdcDataPST() [7/9]

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

Default constructor.

◆ FrAdcDataPST() [8/9]

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

Initialzie the instance from an input stream.

◆ FrAdcDataPST() [9/9]

template<typename DataType , typename AuxType >
template<typename PreviousType >
FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::FrAdcDataPST ( const PreviousType &  Source,
Common::IStream Stream 
)
protected

Initialzie the instance from an input stream.

Member Function Documentation

◆ Bytes() [1/3]

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/3]

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.

◆ Bytes() [3/3]

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/3]

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/3]

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.

◆ copyCore() [3/3]

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.

◆ operator==() [1/3]

template<typename DataType , typename AuxType >
bool FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::operator== ( const FrAdcDataPST< DataType, AuxType > &  RHS) const
inlineprotected

Comparison operator.

◆ operator==() [2/3]

template<typename DataType , typename AuxType >
bool FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::operator== ( const FrAdcDataPST< DataType, AuxType > &  RHS) const
protected

Comparison operator.

◆ operator==() [3/3]

template<typename DataType , typename AuxType >
bool FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::operator== ( const FrAdcDataPST< DataType, AuxType > &  RHS) const
protected

Comparison operator.

◆ RefAux() [1/6]

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/6]

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/6]

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() [4/6]

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

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefAux() [5/6]

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.

◆ RefAux() [6/6]

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/6]

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/6]

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/6]

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() [4/6]

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

Identifier for vector of sampled data.

Returns
A constant reference to the sampled data.

◆ RefData() [5/6]

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.

◆ RefData() [6/6]

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.

◆ structDescription() [1/3]

template<typename DataType , typename AuxType >
template<typename DescriptionType , typename FrSEType >
void FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::structDescription ( DescriptionType &  Desc,
const std::string &  FrVectStructName 
)
inlinestaticprotected

Provide a description of object.

◆ structDescription() [2/3]

template<typename DataType , typename AuxType >
template<typename DescriptionType , typename FrSEType >
static void FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::structDescription ( DescriptionType &  Desc,
const std::string &  FrVectStructName 
)
staticprotected

Provide a description of object.

◆ structDescription() [3/3]

template<typename DataType , typename AuxType >
template<typename DescriptionType , typename FrSEType >
static void FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::structDescription ( DescriptionType &  Desc,
const std::string &  FrVectStructName 
)
staticprotected

Provide a description of object.

◆ write() [1/3]

template<typename DataType , typename AuxType >
void FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::write ( Common::OStream Stream) const
inlineprotected

Write contents to the stream.

◆ write() [2/3]

template<typename DataType , typename AuxType >
void FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::write ( Common::OStream Stream) const
protected

Write contents to the stream.

◆ write() [3/3]

template<typename DataType , typename AuxType >
void FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::write ( Common::OStream Stream) const
protected

Write contents to the stream.

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.

◆ MAX_REF

template<typename DataType , typename AuxType >
static const INT_2U FrameCPP::Version_3::FrAdcDataPST< DataType, AuxType >::MAX_REF = 2
static

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