ldas-tools-framecpp  2.7.0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
FrameCPP::Version_4::FrProcData Class Reference

#include <FrProcData.hh>

Inheritance diagram for FrameCPP::Version_4::FrProcData:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_4::FrProcData:
Collaboration graph
[legend]

Classes

struct  fr_proc_data_ref_type
 

Public Types

typedef Common::Container< FrVectdata_type
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::iterator iterator
 
typedef Common::Container< FrVectaux_type
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef aux_type::iterator aux_iterator
 
typedef Common::Container< FrVecttable_type
 
typedef table_type::const_iterator const_table_iterator
 
typedef table_type::iterator table_iterator
 
typedef Common::Container< FrVectdata_type
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::iterator iterator
 
typedef Common::Container< FrVectaux_type
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef aux_type::iterator aux_iterator
 
typedef Common::Container< FrVecttable_type
 
typedef table_type::const_iterator const_table_iterator
 
typedef table_type::iterator table_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 object_type promote_arg_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_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
 

Public Member Functions

 FrProcData ()
 
 FrProcData (const FrProcData &Source)
 
 FrProcData (const std::string &Name, const std::string &Comment, const REAL_8 SampleRate, const GPSTime &TimeOffset, const REAL_8 FShift)
 
 FrProcData (Previous::FrProcData &Source, istream_type *Stream)
 
 ~FrProcData ()
 
bool operator== (const FrProcData &RHS) const
 
bool operator!= (const FrProcData &RHS) const
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
const std::string & GetNameSlow () const
 
const aux_typeRefAux () const
 
aux_typeRefAux ()
 
const table_typeRefTable () const
 
table_typeRefTable ()
 
const data_typeRefData () const
 
data_typeRefData ()
 
FrProcDataMerge (const FrProcData &RHS)
 
virtual FrProcDataCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
 FrProcData ()
 
 FrProcData (const FrProcData &Source)
 
 FrProcData (const std::string &Name, const std::string &Comment, const REAL_8 SampleRate, const GPSTime &TimeOffset, const REAL_8 FShift)
 
 FrProcData (Previous::FrProcData &Source, istream_type *Stream)
 
 ~FrProcData ()
 
bool operator== (const FrProcData &RHS) const
 
bool operator!= (const FrProcData &RHS) const
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
const std::string & GetNameSlow () const
 
const aux_typeRefAux () const
 
aux_typeRefAux ()
 
const table_typeRefTable () const
 
table_typeRefTable ()
 
const data_typeRefData () const
 
data_typeRefData ()
 
FrProcDataMerge (const FrProcData &RHS)
 
virtual FrProcDataCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
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, IStream *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
const std::string & GetName () const
 
const std::string & GetName () const
 
const std::string & GetComment () const
 
const std::string & GetComment () const
 
REAL_8 GetSampleRate () const
 
REAL_8 GetSampleRate () const
 
const GPSTimeGetTimeOffset () const
 
const GPSTimeGetTimeOffset () const
 
REAL_8 GetFShift () const
 
REAL_8 GetFShift () const
 
void SetFShift (REAL_8 FShift)
 
void SetFShift (REAL_8 FShift)
 
void SetTimeOffset (const GPSTime &time)
 
void SetTimeOffset (const GPSTime &time)
 
void AppendComment (const std::string &comment)
 
void AppendComment (const std::string &comment)
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
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)
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 

Protected Attributes

fr_proc_data_data_type m_data
 

Private Member Functions

 FrProcData (istream_type &Stream)
 
void copy_core (const FrProcData &Source)
 
std::unique_ptr< FrProcDatasub_time_series (REAL_8 Offset, REAL_8 Dt) const
 
 FrProcData (istream_type &Stream)
 
void copy_core (const FrProcData &Source)
 
std::unique_ptr< FrProcDatasub_time_series (REAL_8 Offset, REAL_8 Dt) const
 

Private Attributes

fr_proc_data_ref_type m_refs
 
bool m_synced_with_vector
 
const class_type m_class
 Storage for the class identifier. More...
 
const Description *const m_desc
 Description for parent class. More...
 

Member Typedef Documentation

◆ aux_iterator [1/2]

typedef aux_type::iterator FrameCPP::Version_4::FrProcData::aux_iterator

◆ aux_iterator [2/2]

typedef aux_type::iterator FrameCPP::Version_4::FrProcData::aux_iterator

◆ aux_type [1/2]

typedef Common::Container< FrVect > FrameCPP::Version_4::FrProcData::aux_type

◆ aux_type [2/2]

typedef Common::Container< FrVect > FrameCPP::Version_4::FrProcData::aux_type

◆ const_aux_iterator [1/2]

typedef aux_type::const_iterator FrameCPP::Version_4::FrProcData::const_aux_iterator

◆ const_aux_iterator [2/2]

typedef aux_type::const_iterator FrameCPP::Version_4::FrProcData::const_aux_iterator

◆ const_iterator [1/2]

typedef data_type::const_iterator FrameCPP::Version_4::FrProcData::const_iterator

◆ const_iterator [2/2]

typedef data_type::const_iterator FrameCPP::Version_4::FrProcData::const_iterator

◆ const_table_iterator [1/2]

typedef table_type::const_iterator FrameCPP::Version_4::FrProcData::const_table_iterator

◆ const_table_iterator [2/2]

typedef table_type::const_iterator FrameCPP::Version_4::FrProcData::const_table_iterator

◆ data_type [1/2]

typedef Common::Container< FrVect > FrameCPP::Version_4::FrProcData::data_type

◆ data_type [2/2]

typedef Common::Container< FrVect > FrameCPP::Version_4::FrProcData::data_type

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ frame_spec_version_type [1/2]

◆ frame_spec_version_type [2/2]

◆ iterator [1/2]

typedef data_type::iterator FrameCPP::Version_4::FrProcData::iterator

◆ iterator [2/2]

typedef data_type::iterator FrameCPP::Version_4::FrProcData::iterator

◆ 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]

◆ 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

◆ table_iterator [1/2]

typedef table_type::iterator FrameCPP::Version_4::FrProcData::table_iterator

◆ table_iterator [2/2]

typedef table_type::iterator FrameCPP::Version_4::FrProcData::table_iterator

◆ table_type [1/2]

typedef Common::Container< FrVect > FrameCPP::Version_4::FrProcData::table_type

◆ table_type [2/2]

typedef Common::Container< FrVect > FrameCPP::Version_4::FrProcData::table_type

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

Member Enumeration Documentation

◆ 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 

◆ 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 

Constructor & Destructor Documentation

◆ FrProcData() [1/10]

FrameCPP::Version_4::FrProcData::FrProcData ( )

◆ FrProcData() [2/10]

FrameCPP::Version_4::FrProcData::FrProcData ( const FrProcData Source)

◆ FrProcData() [3/10]

FrameCPP::Version_4::FrProcData::FrProcData ( const std::string &  Name,
const std::string &  Comment,
const REAL_8  SampleRate,
const GPSTime TimeOffset,
const REAL_8  FShift 
)

◆ FrProcData() [4/10]

FrameCPP::Version_4::FrProcData::FrProcData ( Previous::FrProcData Source,
istream_type Stream 
)

◆ ~FrProcData() [1/2]

FrameCPP::Version_4::FrProcData::~FrProcData ( )

◆ FrProcData() [5/10]

FrameCPP::Version_4::FrProcData::FrProcData ( istream_type Stream)
private

◆ FrProcData() [6/10]

FrameCPP::Version_4::FrProcData::FrProcData ( )

◆ FrProcData() [7/10]

FrameCPP::Version_4::FrProcData::FrProcData ( const FrProcData Source)

◆ FrProcData() [8/10]

FrameCPP::Version_4::FrProcData::FrProcData ( const std::string &  Name,
const std::string &  Comment,
const REAL_8  SampleRate,
const GPSTime TimeOffset,
const REAL_8  FShift 
)

◆ FrProcData() [9/10]

FrameCPP::Version_4::FrProcData::FrProcData ( Previous::FrProcData Source,
istream_type Stream 
)

◆ ~FrProcData() [2/2]

FrameCPP::Version_4::FrProcData::~FrProcData ( )

◆ FrProcData() [10/10]

FrameCPP::Version_4::FrProcData::FrProcData ( istream_type Stream)
private

Member Function Documentation

◆ AppendComment() [1/2]

void FrameCPP::Version_3::FrProcDataData::AppendComment ( const std::string &  comment)
inlineinherited

◆ AppendComment() [2/2]

void FrameCPP::Version_3::FrProcDataData::AppendComment ( const std::string &  comment)
inherited

◆ Bytes() [1/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_4::FrProcData::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

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

◆ Bytes() [2/2]

cmn_streamsize_type FrameCPP::Version_4::FrProcData::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

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

◆ Clone() [1/2]

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

◆ Clone() [2/2]

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

◆ copy_core() [1/2]

void FrameCPP::Version_4::FrProcData::copy_core ( const FrProcData Source)
private

◆ copy_core() [2/2]

void FrameCPP::Version_4::FrProcData::copy_core ( const FrProcData Source)
private

◆ Create() [1/4]

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

◆ Create() [2/4]

FrProcData * FrameCPP::Version_4::FrProcData::Create ( istream_type Stream) const
virtual

constructor - virtual

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

◆ Create() [3/4]

virtual FrProcData* FrameCPP::Version_4::FrProcData::Create ( istream_type Stream) const
virtual

constructor - virtual

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

◆ Create() [4/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream &  Buffer) const
virtualinherited

◆ DataType() [1/4]

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

◆ DataType() [2/4]

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

◆ DataType() [3/4]

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

◆ DataType() [4/4]

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

◆ demote() [1/2]

FrProcData::demote_ret_type FrameCPP::Version_4::FrProcData::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

Todo:
See if the actual sample rate can be computed

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

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_4::FrProcData::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_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,
istream_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]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_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.

◆ GetClass() [1/2]

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

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]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ 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::FrProcDataData::GetComment ( ) const
inlineinherited

◆ GetComment() [2/2]

const std::string& FrameCPP::Version_3::FrProcDataData::GetComment ( ) const
inherited

◆ GetDescription() [1/2]

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

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.

◆ GetFShift() [1/2]

REAL_8 FrameCPP::Version_3::FrProcDataData::GetFShift ( ) const
inlineinherited

◆ GetFShift() [2/2]

REAL_8 FrameCPP::Version_3::FrProcDataData::GetFShift ( ) const
inherited

◆ GetName() [1/2]

const std::string & FrameCPP::Version_3::FrProcDataData::GetName ( ) const
inlineinherited

◆ GetName() [2/2]

const std::string& FrameCPP::Version_3::FrProcDataData::GetName ( ) const
inherited

◆ GetNameSlow() [1/2]

const std::string & FrameCPP::Version_4::FrProcData::GetNameSlow ( ) const

◆ GetNameSlow() [2/2]

const std::string& FrameCPP::Version_4::FrProcData::GetNameSlow ( ) const

◆ GetSampleRate() [1/2]

REAL_8 FrameCPP::Version_3::FrProcDataData::GetSampleRate ( ) const
inlineinherited

◆ GetSampleRate() [2/2]

REAL_8 FrameCPP::Version_3::FrProcDataData::GetSampleRate ( ) const
inherited

◆ GetTimeOffset() [1/2]

const GPSTime & FrameCPP::Version_3::FrProcDataData::GetTimeOffset ( ) const
inlineinherited

◆ GetTimeOffset() [2/2]

const GPSTime& FrameCPP::Version_3::FrProcDataData::GetTimeOffset ( ) const
inherited

◆ Merge() [1/2]

FrProcData & FrameCPP::Version_4::FrProcData::Merge ( const FrProcData RHS)
Todo:
Need to implement Merge routine

◆ Merge() [2/2]

FrProcData& FrameCPP::Version_4::FrProcData::Merge ( const FrProcData RHS)

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_4::FrProcData::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_4::FrProcData::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/2]

bool FrameCPP::Version_4::FrProcData::operator!= ( const FrProcData RHS) const
inline

◆ operator!=() [2/2]

bool FrameCPP::Version_4::FrProcData::operator!= ( const FrProcData RHS) const

◆ operator==() [1/4]

bool FrameCPP::Version_4::FrProcData::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

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

◆ operator==() [2/4]

virtual bool FrameCPP::Version_4::FrProcData::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

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

◆ operator==() [3/4]

bool FrameCPP::Version_4::FrProcData::operator== ( const FrProcData RHS) const
inline

◆ operator==() [4/4]

bool FrameCPP::Version_4::FrProcData::operator== ( const FrProcData RHS) const

◆ Promote() [1/2]

FrProcData::promote_ret_type FrameCPP::Version_4::FrProcData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_4::FrProcData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
static

◆ promote() [1/2]

FrProcData::promote_ret_type FrameCPP::Version_4::FrProcData::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

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

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_4::FrProcData::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_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,
istream_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 >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_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]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_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 >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_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,
IStream Stream 
)
inherited

◆ RefAux() [1/4]

FrProcData::aux_type & FrameCPP::Version_4::FrProcData::RefAux ( )
inline

◆ RefAux() [2/4]

aux_type& FrameCPP::Version_4::FrProcData::RefAux ( )

◆ RefAux() [3/4]

const FrProcData::aux_type & FrameCPP::Version_4::FrProcData::RefAux ( ) const
inline

◆ RefAux() [4/4]

const aux_type& FrameCPP::Version_4::FrProcData::RefAux ( ) const

◆ RefData() [1/4]

FrProcData::data_type & FrameCPP::Version_4::FrProcData::RefData ( )
inline

◆ RefData() [2/4]

data_type& FrameCPP::Version_4::FrProcData::RefData ( )

◆ RefData() [3/4]

const FrProcData::data_type & FrameCPP::Version_4::FrProcData::RefData ( ) const
inline

◆ RefData() [4/4]

const data_type& FrameCPP::Version_4::FrProcData::RefData ( ) const

◆ RefTable() [1/4]

FrProcData::table_type & FrameCPP::Version_4::FrProcData::RefTable ( )
inline

◆ RefTable() [2/4]

table_type& FrameCPP::Version_4::FrProcData::RefTable ( )

◆ RefTable() [3/4]

const FrProcData::table_type & FrameCPP::Version_4::FrProcData::RefTable ( ) const
inline

◆ RefTable() [4/4]

const table_type& FrameCPP::Version_4::FrProcData::RefTable ( ) const

◆ SetFShift() [1/2]

void FrameCPP::Version_3::FrProcDataData::SetFShift ( REAL_8  FShift)
inlineinherited

◆ SetFShift() [2/2]

void FrameCPP::Version_3::FrProcDataData::SetFShift ( REAL_8  FShift)
inherited

◆ SetTimeOffset() [1/2]

void FrameCPP::Version_3::FrProcDataData::SetTimeOffset ( const GPSTime time)
inlineinherited

◆ SetTimeOffset() [2/2]

void FrameCPP::Version_3::FrProcDataData::SetTimeOffset ( const GPSTime time)
inherited

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_4::FrProcData::StructDescription ( )
static

◆ StructDescription() [2/2]

static const Common::Description* FrameCPP::Version_4::FrProcData::StructDescription ( )
static

◆ StructName() [1/2]

const char * FrameCPP::Version_4::FrProcData::StructName ( )
inlinestatic

◆ StructName() [2/2]

static const char* FrameCPP::Version_4::FrProcData::StructName ( )
static

◆ sub_time_series() [1/2]

std::unique_ptr< FrProcData > FrameCPP::Version_4::FrProcData::sub_time_series ( REAL_8  Offset,
REAL_8  Dt 
) const
private

◆ sub_time_series() [2/2]

std::unique_ptr< FrProcData > FrameCPP::Version_4::FrProcData::sub_time_series ( REAL_8  Offset,
REAL_8  Dt 
) const
private

◆ TOCQuery() [1/2]

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

◆ TOCQuery() [2/2]

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

◆ VerifyObject() [1/2]

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

◆ VerifyObject() [2/2]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

◆ vTOCQuery() [1/2]

void FrameCPP::Version_4::FrProcData::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

◆ vTOCQuery() [2/2]

virtual void FrameCPP::Version_4::FrProcData::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

◆ Write() [1/2]

void FrameCPP::Version_4::FrProcData::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_4::FrProcData::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

◆ 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_proc_data_data_type FrameCPP::Version_3::FrProcDataData::m_data
mutableprotectedinherited

◆ 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.

◆ m_refs

fr_proc_data_ref_type FrameCPP::Version_4::FrProcData::m_refs
private

◆ m_synced_with_vector

bool FrameCPP::Version_4::FrProcData::m_synced_with_vector
mutableprivate

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