ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T > Class Template Reference

#include <FrSimDataClassicIO.hh>

Inheritance diagram for FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >:
Collaboration graph
[legend]

Public Types

typedef FR_SIM_DATA_NAME_TYPE name_type
typedef FR_SIM_DATA_NAME_TYPE name_type
typedef FR_SIM_DATA_COMMENT_TYPE comment_type
typedef FR_SIM_DATA_COMMENT_TYPE comment_type
typedef FR_SIM_DATA_SAMPLERATE_TYPE sampleRate_type
typedef FR_SIM_DATA_SAMPLERATE_TYPE sampleRate_type
typedef FR_SIM_DATA_TIMEOFFSET_TYPE timeOffset_type
typedef FR_SIM_DATA_TIMEOFFSET_TYPE timeOffset_type
typedef FR_SIM_DATA_FSHIFT_TYPE fShift_type
typedef FR_SIM_DATA_FSHIFT_TYPE fShift_type
typedef FR_SIM_DATA_PHASE_TYPE phase_type
typedef FR_SIM_DATA_PHASE_TYPE phase_type
typedef Common::Container< FrVect > data_type
typedef Common::Container< FrVect > data_type
typedef data_type::iterator iterator
typedef data_type::iterator iterator
typedef data_type::const_iterator const_iterator
typedef data_type::const_iterator const_iterator
typedef Common::SearchContainer< FrVect, &FrVect::GetName > input_type
typedef Common::SearchContainer< FrVect, &FrVect::GetName > input_type
typedef input_type::iterator input_iterator
typedef input_type::iterator input_iterator
typedef input_type::const_iterator const_input_iterator
typedef input_type::const_iterator const_input_iterator
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > table_type
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > table_type
typedef table_type::iterator table_iterator
typedef table_type::iterator table_iterator
typedef table_type::const_iterator const_table_iterator
typedef table_type::const_iterator const_table_iterator
typedef const char *const struct_name_type
typedef const char *const struct_name_type
typedef const char *const struct_desc_type
typedef const char *const struct_desc_type
typedef INT_2U const struct_id_type
typedef INT_2U const struct_id_type
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
typedef STRING< INT_2U > string_2_type
typedef STRING< INT_2U > string_2_type
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
typedef IStream istream_type
typedef IStream istream_type
typedef OStream ostream_type
typedef OStream ostream_type

Public Member Functions

 ClassicIO ()
 ClassicIO (Previous::FrSimData &Source, stream_base_type *Stream)
virtual const char * ObjectStructName () const
 The name structure name of this object.
 ClassicIO ()
 ClassicIO (Previous::FrSimData &Source, stream_base_type *Stream)
virtual const char * ObjectStructName () const
 The name structure name of this object.
const name_type & GetName () const
const name_type & GetName () const
const comment_type & GetComment () const
const comment_type & GetComment () const
sampleRate_type GetSampleRate () const
sampleRate_type GetSampleRate () const
timeOffset_type GetTimeOffset () const
timeOffset_type GetTimeOffset () const
fShift_type GetFShift () const
fShift_type GetFShift () const
phase_type GetPhase () const
phase_type GetPhase () const
void SetComment (const comment_type &Comment)
 Establish the value of the comment field.
void SetComment (const comment_type &Comment)
 Establish the value of the comment field.
void SetSampleRate (sampleRate_type SampleRate)
 Establish the value of the sampleRate field.
void SetSampleRate (sampleRate_type SampleRate)
 Establish the value of the sampleRate field.
void SetTimeOffset (timeOffset_type TimeOffset)
 Establish the value of the timeOffset field.
void SetTimeOffset (timeOffset_type TimeOffset)
 Establish the value of the timeOffset field.
const data_type & RefData () const
data_type & RefData ()
const data_type & RefData () const
data_type & RefData ()
const input_type & RefInput () const
input_type & RefInput ()
const input_type & RefInput () const
input_type & RefInput ()
const table_type & RefTable () const
table_type & RefTable ()
const table_type & RefTable () const
table_type & RefTable ()
bool operator== (const Data &RHS) const
bool operator== (const Data &RHS) const
void TOCQuery (int InfoClass,...) const
void TOCQuery (int InfoClass,...) const
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
virtual self_type * Create (istream_type &Stream) const
 Virtual constructor.
virtual self_type * Create (istream_type &Stream) const
 Virtual constructor.
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
virtual void Write (ostream_type &Stream) const
 Write object to the stream.

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
static const Common::Description * StructDescription ()
 The description of structure.
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
static const Common::Description * StructDescription ()
 The description of structure.
static struct_name_type FrameSpecName ()
static struct_name_type FrameSpecName ()
static struct_name_type StructName ()
static struct_name_type StructName ()
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
template<class T>
static int DataType (const T *Data)
template<class T>
static int DataType (const T &Data)
template<class T>
static int DataType (const T *Data)
template<class T>
static int DataType (const T &Data)
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.

Static Public Attributes

static constexpr timeOffset_type DEFAULT_TIME_OFFSET { 0 }
static struct_name_type struct_name
static struct_desc_type struct_desc
static struct_id_type struct_id

Protected Member Functions

virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
virtual self_type * pCreate (istream_type &Stream) const
 Virtual constructor.
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
virtual self_type * pCreate (istream_type &Stream) const
 Virtual constructor.
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.

Protected Attributes

name_type name
 Name of simulated data.
comment_type comment
 Comment.
sampleRate_type sampleRate
 Simulated data sample rate, samples/s.
timeOffset_type timeOffset
 Offset of 1st sample relative to the frame start time.
fShift_type fShift
 fShift is the frequency in the original data
phase_type phase
 Phase of hetrodyning signal at start of dataset.
data_type data
input_type input
table_type table

Static Protected Attributes

static constexpr unsigned int MAX_REF { 3 }

Private Types

typedef STRING io_name_type
typedef STRING io_comment_type
typedef STRING io_name_type
typedef STRING io_comment_type
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > object_base_type

Private Member Functions

virtual Object * Create () const
virtual Object * Create (std::istream &Buffer) const
 constructor - virtual
virtual Object * Create () const
virtual Object * Create (std::istream &Buffer) const
 constructor - virtual

Private Attributes

ChecksumType m_chkSum
 Structure checksum.

Member Typedef Documentation

◆ comment_type [1/2]

typedef FR_SIM_DATA_COMMENT_TYPE FrameCPP::Version_8::FrSimDataImpl::Data::comment_type
inherited

◆ comment_type [2/2]

typedef FR_SIM_DATA_COMMENT_TYPE FrameCPP::Version_8::FrSimDataImpl::Data::comment_type
inherited

◆ const_input_iterator [1/2]

typedef input_type::const_iterator FrameCPP::Version_8::FrSimDataImpl::Data::const_input_iterator
inherited

◆ const_input_iterator [2/2]

typedef input_type::const_iterator FrameCPP::Version_8::FrSimDataImpl::Data::const_input_iterator
inherited

◆ const_iterator [1/2]

typedef data_type::const_iterator FrameCPP::Version_8::FrSimDataImpl::Data::const_iterator
inherited

◆ const_iterator [2/2]

typedef data_type::const_iterator FrameCPP::Version_8::FrSimDataImpl::Data::const_iterator
inherited

◆ const_table_iterator [1/2]

typedef table_type::const_iterator FrameCPP::Version_8::FrSimDataImpl::Data::const_table_iterator
inherited

◆ const_table_iterator [2/2]

typedef table_type::const_iterator FrameCPP::Version_8::FrSimDataImpl::Data::const_table_iterator
inherited

◆ data_type [1/2]

typedef Common::Container< FrVect > FrameCPP::Version_8::FrSimDataImpl::Data::data_type
inherited

◆ data_type [2/2]

typedef Common::Container< FrVect > FrameCPP::Version_8::FrSimDataImpl::Data::data_type
inherited

◆ fShift_type [1/2]

typedef FR_SIM_DATA_FSHIFT_TYPE FrameCPP::Version_8::FrSimDataImpl::Data::fShift_type
inherited

◆ fShift_type [2/2]

typedef FR_SIM_DATA_FSHIFT_TYPE FrameCPP::Version_8::FrSimDataImpl::Data::fShift_type
inherited

◆ input_iterator [1/2]

typedef input_type::iterator FrameCPP::Version_8::FrSimDataImpl::Data::input_iterator
inherited

◆ input_iterator [2/2]

typedef input_type::iterator FrameCPP::Version_8::FrSimDataImpl::Data::input_iterator
inherited

◆ input_type [1/2]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_8::FrSimDataImpl::Data::input_type
inherited

◆ input_type [2/2]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_8::FrSimDataImpl::Data::input_type
inherited

◆ io_comment_type [1/2]

template<typename T>
typedef STRING FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::io_comment_type
private

◆ io_comment_type [2/2]

template<typename T>
typedef STRING FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::io_comment_type
private

◆ io_name_type [1/2]

template<typename T>
typedef STRING FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::io_name_type
private

◆ io_name_type [2/2]

template<typename T>
typedef STRING FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::io_name_type
private

◆ istream_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ iterator [1/2]

typedef data_type::iterator FrameCPP::Version_8::FrSimDataImpl::Data::iterator
inherited

◆ iterator [2/2]

typedef data_type::iterator FrameCPP::Version_8::FrSimDataImpl::Data::iterator
inherited

◆ name_type [1/2]

typedef FR_SIM_DATA_NAME_TYPE FrameCPP::Version_8::FrSimDataImpl::Data::name_type
inherited

◆ name_type [2/2]

typedef FR_SIM_DATA_NAME_TYPE FrameCPP::Version_8::FrSimDataImpl::Data::name_type
inherited

◆ object_base_type

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Version_8::ObjectWithChecksum< Common::FrameSpec::Object >::object_base_type
privateinherited

◆ ostream_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ phase_type [1/2]

typedef FR_SIM_DATA_PHASE_TYPE FrameCPP::Version_8::FrSimDataImpl::Data::phase_type
inherited

◆ phase_type [2/2]

typedef FR_SIM_DATA_PHASE_TYPE FrameCPP::Version_8::FrSimDataImpl::Data::phase_type
inherited

◆ sampleRate_type [1/2]

typedef FR_SIM_DATA_SAMPLERATE_TYPE FrameCPP::Version_8::FrSimDataImpl::Data::sampleRate_type
inherited

◆ sampleRate_type [2/2]

typedef FR_SIM_DATA_SAMPLERATE_TYPE FrameCPP::Version_8::FrSimDataImpl::Data::sampleRate_type
inherited

◆ self_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ string_2_type [1/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ string_2_type [2/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ struct_desc_type [1/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_desc_type [2/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_id_type [1/2]

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_id_type [2/2]

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type [1/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ struct_name_type [2/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ table_iterator [1/2]

typedef table_type::iterator FrameCPP::Version_8::FrSimDataImpl::Data::table_iterator
inherited

◆ table_iterator [2/2]

typedef table_type::iterator FrameCPP::Version_8::FrSimDataImpl::Data::table_iterator
inherited

◆ table_type [1/2]

typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_8::FrSimDataImpl::Data::table_type
inherited

◆ table_type [2/2]

typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_8::FrSimDataImpl::Data::table_type
inherited

◆ timeOffset_type [1/2]

typedef FR_SIM_DATA_TIMEOFFSET_TYPE FrameCPP::Version_8::FrSimDataImpl::Data::timeOffset_type
inherited

◆ timeOffset_type [2/2]

typedef FR_SIM_DATA_TIMEOFFSET_TYPE FrameCPP::Version_8::FrSimDataImpl::Data::timeOffset_type
inherited

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

Constructor & Destructor Documentation

◆ ClassicIO() [1/4]

template<typename T>
FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::ClassicIO ( )
inline

◆ ClassicIO() [2/4]

template<typename T>
FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::ClassicIO ( Previous::FrSimData & Source,
stream_base_type * Stream )
inline

◆ ClassicIO() [3/4]

template<typename T>
FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::ClassicIO ( )
inline

◆ ClassicIO() [4/4]

template<typename T>
FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::ClassicIO ( Previous::FrSimData & Source,
stream_base_type * Stream )
inline

Member Function Documentation

◆ Bytes() [1/2]

template<typename ObjectType, typename ChecksumType>
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream 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]

template<typename ObjectType, typename ChecksumType>
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ CheckSumDataClass() [1/2]

template<typename ObjectType, typename ChecksumType>
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType, typename ChecksumType>
const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType, typename ChecksumType>
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType, typename ChecksumType>
const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Create() [1/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.

◆ Create() [2/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.

◆ Create() [3/6]

template<typename ObjectType, typename ChecksumType>
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [4/6]

template<typename ObjectType, typename ChecksumType>
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [5/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ Create() [6/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ DataType() [1/4]

template<class T>
int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [2/4]

template<class T>
int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [3/4]

template<class T>
int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ DataType() [4/4]

template<class T>
int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ demote() [1/2]

template<typename T>
virtual demote_ret_type FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ demote() [2/2]

template<typename T>
virtual demote_ret_type FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ FrameSpecDescription() [1/2]

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/2]

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [1/2]

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [2/2]

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName() [1/2]

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [2/2]

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ GetComment() [1/2]

const comment_type & FrameCPP::Version_8::FrSimDataImpl::Data::GetComment ( ) const
inlineinherited

◆ GetComment() [2/2]

const comment_type & FrameCPP::Version_8::FrSimDataImpl::Data::GetComment ( ) const
inlineinherited

◆ GetFShift() [1/2]

fShift_type FrameCPP::Version_8::FrSimDataImpl::Data::GetFShift ( ) const
inlineinherited

◆ GetFShift() [2/2]

fShift_type FrameCPP::Version_8::FrSimDataImpl::Data::GetFShift ( ) const
inlineinherited

◆ GetName() [1/2]

const name_type & FrameCPP::Version_8::FrSimDataImpl::Data::GetName ( ) const
inlineinherited

◆ GetName() [2/2]

const name_type & FrameCPP::Version_8::FrSimDataImpl::Data::GetName ( ) const
inlineinherited

◆ GetPhase() [1/2]

phase_type FrameCPP::Version_8::FrSimDataImpl::Data::GetPhase ( ) const
inlineinherited

◆ GetPhase() [2/2]

phase_type FrameCPP::Version_8::FrSimDataImpl::Data::GetPhase ( ) const
inlineinherited

◆ GetSampleRate() [1/2]

sampleRate_type FrameCPP::Version_8::FrSimDataImpl::Data::GetSampleRate ( ) const
inlineinherited

◆ GetSampleRate() [2/2]

sampleRate_type FrameCPP::Version_8::FrSimDataImpl::Data::GetSampleRate ( ) const
inlineinherited

◆ GetTimeOffset() [1/2]

timeOffset_type FrameCPP::Version_8::FrSimDataImpl::Data::GetTimeOffset ( ) const
inlineinherited

◆ GetTimeOffset() [2/2]

timeOffset_type FrameCPP::Version_8::FrSimDataImpl::Data::GetTimeOffset ( ) const
inlineinherited

◆ ObjectStructName() [1/2]

template<typename T>
virtual const char * FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtual

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

template<typename T>
virtual const char * FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtual

The name structure name of this object.

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

◆ operator==() [1/2]

bool FrameCPP::Version_8::FrSimDataImpl::Data::operator== ( const Data & RHS) const
inlineinherited

◆ operator==() [2/2]

bool FrameCPP::Version_8::FrSimDataImpl::Data::operator== ( const Data & RHS) const
inlineinherited

◆ pBytes() [1/2]

template<typename T>
cmn_streamsize_type FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtual

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.

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

◆ pBytes() [2/2]

template<typename T>
cmn_streamsize_type FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtual

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.

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

◆ pCreate() [1/2]

template<typename T>
virtual self_type * FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

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

◆ pCreate() [2/2]

template<typename T>
virtual self_type * FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

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

◆ Promote() [1/2]

template<typename T>
promote_ret_type FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [2/2]

template<typename T>
promote_ret_type FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ promote() [1/2]

template<typename T>
virtual promote_ret_type FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ promote() [2/2]

template<typename T>
virtual promote_ret_type FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ pWrite() [1/2]

template<typename T>
virtual void FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtual

Write the structure to the stream.

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

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

◆ pWrite() [2/2]

template<typename T>
virtual void FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtual

Write the structure to the stream.

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

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

◆ RefData() [1/4]

data_type & FrameCPP::Version_8::FrSimDataImpl::Data::RefData ( )
inlineinherited

◆ RefData() [2/4]

data_type & FrameCPP::Version_8::FrSimDataImpl::Data::RefData ( )
inlineinherited

◆ RefData() [3/4]

const data_type & FrameCPP::Version_8::FrSimDataImpl::Data::RefData ( ) const
inlineinherited

◆ RefData() [4/4]

const data_type & FrameCPP::Version_8::FrSimDataImpl::Data::RefData ( ) const
inlineinherited

◆ RefInput() [1/4]

input_type & FrameCPP::Version_8::FrSimDataImpl::Data::RefInput ( )
inlineinherited

◆ RefInput() [2/4]

input_type & FrameCPP::Version_8::FrSimDataImpl::Data::RefInput ( )
inlineinherited

◆ RefInput() [3/4]

const input_type & FrameCPP::Version_8::FrSimDataImpl::Data::RefInput ( ) const
inlineinherited

◆ RefInput() [4/4]

const input_type & FrameCPP::Version_8::FrSimDataImpl::Data::RefInput ( ) const
inlineinherited

◆ RefTable() [1/4]

table_type & FrameCPP::Version_8::FrSimDataImpl::Data::RefTable ( )
inlineinherited

◆ RefTable() [2/4]

table_type & FrameCPP::Version_8::FrSimDataImpl::Data::RefTable ( )
inlineinherited

◆ RefTable() [3/4]

const table_type & FrameCPP::Version_8::FrSimDataImpl::Data::RefTable ( ) const
inlineinherited

◆ RefTable() [4/4]

const table_type & FrameCPP::Version_8::FrSimDataImpl::Data::RefTable ( ) const
inlineinherited

◆ SetComment() [1/2]

void FrameCPP::Version_8::FrSimDataImpl::Data::SetComment ( const comment_type & Comment)
inlineinherited

Establish the value of the comment field.

Parameters
[in]CommentThe desired value of the comment field.

◆ SetComment() [2/2]

void FrameCPP::Version_8::FrSimDataImpl::Data::SetComment ( const comment_type & Comment)
inlineinherited

Establish the value of the comment field.

Parameters
[in]CommentThe desired value of the comment field.

◆ SetSampleRate() [1/2]

void FrameCPP::Version_8::FrSimDataImpl::Data::SetSampleRate ( sampleRate_type SampleRate)
inlineinherited

Establish the value of the sampleRate field.

Parameters
[in]SampleRateThe desired value of the sampleRate field.

◆ SetSampleRate() [2/2]

void FrameCPP::Version_8::FrSimDataImpl::Data::SetSampleRate ( sampleRate_type SampleRate)
inlineinherited

Establish the value of the sampleRate field.

Parameters
[in]SampleRateThe desired value of the sampleRate field.

◆ SetTimeOffset() [1/2]

void FrameCPP::Version_8::FrSimDataImpl::Data::SetTimeOffset ( timeOffset_type TimeOffset)
inlineinherited

Establish the value of the timeOffset field.

Parameters
[in]TimeThe desired value of the timeOffset field.

◆ SetTimeOffset() [2/2]

void FrameCPP::Version_8::FrSimDataImpl::Data::SetTimeOffset ( timeOffset_type TimeOffset)
inlineinherited

Establish the value of the timeOffset field.

Parameters
[in]TimeThe desired value of the timeOffset field.

◆ StructDescription() [1/2]

template<typename T>
const Common::Description * FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::StructDescription ( )
inlinestatic

The description of structure.

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

◆ StructDescription() [2/2]

template<typename T>
const Common::Description * FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::StructDescription ( )
inlinestatic

The description of structure.

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

◆ StructName() [1/2]

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ StructName() [2/2]

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ TOCQuery() [1/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inlineinherited

◆ TOCQuery() [2/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inherited

◆ vTOCQuery() [1/2]

template<typename T>
virtual void FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::vTOCQuery ( int InfoClass,
va_list vl ) const
inlineprotectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [2/2]

template<typename T>
virtual void FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >::vTOCQuery ( int InfoClass,
va_list vl ) const
inlineprotectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ Write() [1/2]

template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

Member Data Documentation

◆ comment

comment_type FrameCPP::Version_8::FrSimDataImpl::Data::comment
protectedinherited

Comment.

◆ data

data_type FrameCPP::Version_8::FrSimDataImpl::Data::data
protectedinherited

◆ DEFAULT_TIME_OFFSET

constexpr timeOffset_type FrameCPP::Version_8::FrSimDataImpl::Data::DEFAULT_TIME_OFFSET { 0 }
staticconstexprinherited

◆ fShift

fShift_type FrameCPP::Version_8::FrSimDataImpl::Data::fShift
protectedinherited

fShift is the frequency in the original data

◆ input

input_type FrameCPP::Version_8::FrSimDataImpl::Data::input
protectedinherited

◆ m_chkSum

template<typename ObjectType, typename ChecksumType>
ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum
privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ MAX_REF

constexpr unsigned int FrameCPP::Version_8::FrSimDataImpl::Data::MAX_REF { 3 }
staticconstexprprotectedinherited

◆ name

name_type FrameCPP::Version_8::FrSimDataImpl::Data::name
protectedinherited

Name of simulated data.

◆ phase

phase_type FrameCPP::Version_8::FrSimDataImpl::Data::phase
protectedinherited

Phase of hetrodyning signal at start of dataset.

◆ sampleRate

sampleRate_type FrameCPP::Version_8::FrSimDataImpl::Data::sampleRate
protectedinherited

Simulated data sample rate, samples/s.

◆ struct_desc

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

◆ table

table_type FrameCPP::Version_8::FrSimDataImpl::Data::table
protectedinherited

◆ timeOffset

timeOffset_type FrameCPP::Version_8::FrSimDataImpl::Data::timeOffset
protectedinherited

Offset of 1st sample relative to the frame start time.

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