ldas-tools-framecpp  2.5.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType > Class Template Reference

Post-Processed Data Structure Definition. More...

#include <FrProcDataPST.hh>

Inheritance diagram for FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >:
FrameCPP::Version_6::FrProcData

Public Types

typedef AuxType aux_value_type
 
typedef Common::Container
< aux_value_type
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_type
data_type
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::iterator iterator
 
typedef TableType table_value_type
 
typedef Common::Container
< table_value_type
table_type
 
typedef table_type::const_iterator const_table_iterator
 
typedef table_type::iterator table_iterator
 
typedef HistoryType history_value_type
 
typedef Common::Container
< history_value_type
history_type
 
typedef
history_type::const_iterator 
const_history_iterator
 
typedef history_type::iterator history_iterator
 

Public Member Functions

const aux_typeRefAux () const
 Identifier for vector for auxilliary data. More...
 
aux_typeRefAux ()
 Identifier for vector for auxilliary data. More...
 
const data_typeRefData () const
 Identifier for vector for data vector. More...
 
data_typeRefData ()
 Identifier for vector for data vector. More...
 
const table_typeRefTable () const
 Identifier for parameter table. More...
 
table_typeRefTable ()
 Identifier for parameter table. More...
 
const history_typeRefHistory () const
 Identifier for channel history. More...
 
history_typeRefHistory ()
 Identifier for channel history. More...
 

Protected Member Functions

 FrProcDataPST ()
 Default constructor. More...
 
template<typename PreviousType >
 FrProcDataPST (const PreviousType &Source, istream_type *Stream)
 Copy Constructor. More...
 
 FrProcDataPST (const FrProcDataPST &Source)
 Copy Constructor. More...
 
 FrProcDataPST (istream_type &Stream)
 Stream Constructor. More...
 
cmn_streamsize_type bytes (const stream_base_type &Stream) const
 Number of bytes needed to write this structure. More...
 
void write (ostream_type &Stream) const
 Write the structure to the stream. More...
 
void copy_core (const FrProcDataPST &Source)
 Copy core data. More...
 
bool operator== (const FrProcDataPST &RHS) const
 equality operator More...
 
template<>
 FrProcDataPST (const Version_4::FrProcData &Source, IStream *Stream)
 

Protected Attributes

data_type data
 
aux_type aux
 Aux vector. More...
 
table_type table
 Parameter table. More...
 
history_type history
 

Static Protected Attributes

static const INT_2U MAX_REF = 4
 

Detailed Description

template<typename DataType, typename AuxType, typename TableType, typename HistoryType>
class FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >

Post-Processed Data Structure Definition.

Member Typedef Documentation

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef aux_type::iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::aux_iterator
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef Common::Container< aux_value_type > FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::aux_type
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef AuxType FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::aux_value_type
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef aux_type::const_iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::const_aux_iterator
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef history_type::const_iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::const_history_iterator
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef data_type::const_iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::const_iterator
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef table_type::const_iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::const_table_iterator
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef Common::Container< data_value_type > FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::data_type
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef DataType FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::data_value_type
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef history_type::iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::history_iterator
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef Common::Container< history_value_type > FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::history_type
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef HistoryType FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::history_value_type
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef data_type::iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::iterator
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef table_type::iterator FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::table_iterator
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef Common::Container< table_value_type > FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::table_type
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
typedef TableType FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::table_value_type

Constructor & Destructor Documentation

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::FrProcDataPST ( )
inlineprotected

Default constructor.

Returns
A new instance of this object.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
template<typename PreviousType >
FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::FrProcDataPST ( const PreviousType &  Source,
istream_type Stream 
)
protected

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::FrProcDataPST ( const FrProcDataPST< DataType, AuxType, TableType, HistoryType > &  Source)
inlineprotected

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::FrProcDataPST ( istream_type Stream)
inlineprotected

Stream Constructor.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.
template<>
FrameCPP::Version_6::FrProcDataPST< FrVect, FrVect, FrTable, FrHistory >::FrProcDataPST ( const Version_4::FrProcData Source,
IStream *  Stream 
)
protected

Member Function Documentation

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
cmn_streamsize_type FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::bytes ( const stream_base_type 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.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
void FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::copy_core ( const FrProcDataPST< DataType, AuxType, TableType, HistoryType > &  Source)
inlineprotected

Copy core data.

Parameters
[in]SourceThe source from which to copy the data
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
bool FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::operator== ( const FrProcDataPST< DataType, AuxType, TableType, HistoryType > &  RHS) const
inlineprotected

equality operator

Parameters
[in]RHSThe FrProcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
const FrProcDataPST< DataType, AuxType, TableType, HistoryType >::aux_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefAux ( ) const
inline

Identifier for vector for auxilliary data.

Returns
A constant reference to the auxilliary data.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
FrProcDataPST< DataType, AuxType, TableType, HistoryType >::aux_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefAux ( )
inline

Identifier for vector for auxilliary data.

Returns
A reference to the auxilliary data.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
const FrProcDataPST< DataType, AuxType, TableType, HistoryType >::data_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefData ( ) const
inline

Identifier for vector for data vector.

Returns
A constant reference to the data vector.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
FrProcDataPST< DataType, AuxType, TableType, HistoryType >::data_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefData ( )
inline

Identifier for vector for data vector.

Returns
A reference to the data vector.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
const FrProcDataPST< DataType, AuxType, TableType, HistoryType >::history_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefHistory ( ) const
inline

Identifier for channel history.

Returns
A constant reference to the channel history.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
FrProcDataPST< DataType, AuxType, TableType, HistoryType >::history_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefHistory ( )
inline

Identifier for channel history.

Returns
A reference to the channel history.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
const FrProcDataPST< DataType, AuxType, TableType, HistoryType >::table_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefTable ( ) const
inline

Identifier for parameter table.

Returns
A constant reference to the parameter table.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
FrProcDataPST< DataType, AuxType, TableType, HistoryType >::table_type & FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::RefTable ( )
inline

Identifier for parameter table.

Returns
A reference to the parameter table.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
void FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::write ( ostream_type Stream) const
inlineprotected

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Member Data Documentation

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
aux_type FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::aux
protected

Aux vector.

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
data_type FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::data
protected

Data vector. The data vector for single dimensional types (t-Series and f-Series) must have a single dimension.

template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
history_type FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::history
protected

Channel history.

Note
The first FrHistory should describe the processing used to build this FrProcData channel. Its name variable should be the FrProcData name. If the channel(s) used to produce this FrProcData have prior FrHistory structures, then in order to not lose this history, these structures should be copied to the FrHistory linked list.
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
const INT_2U FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::MAX_REF = 4
staticprotected
template<typename DataType , typename AuxType , typename TableType , typename HistoryType >
table_type FrameCPP::Version_6::FrProcDataPST< DataType, AuxType, TableType, HistoryType >::table
protected

Parameter table.


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