ldas-tools-framecpp  2.7.0
Todo List
Member FrameCPP::Version_4::FrTOC::positionSimEvent (const std::string &EventType, INT_4U Index) const
Need to fix
Member FrameCPP::Version_8::FrAdcData::Merge (const FrAdcData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_7::FrSimData::Merge (const FrSimData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_7::FrSerData::Merge (const FrSerData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_6::FrTOC::ForEach (query_info_type Info, FunctionBase &Action) const
Need to finish the list of channel names
Member FrameCPP::Version_6::FrStatDataPS
Needs documentation
Member FrameCPP::Version_6::FrStatDataNPS
Needs documentation
Member FrameCPP::Version_6::FrProcData::demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
See if the actual sample rate can be computed
Member FrameCPP::Version_6::FrMsg::demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
Replace next references
Member FrameCPP::Version_6::FrMsg::FrMsg (Previous::FrMsg &Source, istream_type *Stream)
Need to replace the next reference
Member FrameCPP::Version_6::FrDetector::FrDetector (Previous::FrDetector &Source, istream_type *Stream)
need to do prefix lookup
Member FrameCPP::Version_4::FrVect::GetDim (nDim_type Offset)
Throw exception if value out of range
Member FrameCPP::Version_4::FrVect::GetDim (nDim_type Offset) const
Throw exception if value out of range
Member FrameCPP::Version_4::FrVect::Merge (const FrVect &RHS)
Need to implement Merge routine
Member FrameCPP::Version_4::FrVect::operator+= (const FrVect &RHS)

Need to have a list of reasons

Need to have a list of reasons

Member FrameCPP::Version_8::FrAdcData::Subset (REAL_8 Offset, REAL_8 Dt) const
Ensure the dimension of the FrVect is 1
Member FrameCPP::Version_4::FrTOC::positionEvent (const std::string &EventType, INT_4U Index) const
Need to fix
Member FrameCPP::Version_4::FrTOC::operator== (const Common::FrameSpec::Object &Obj) const
actually implement comparision operator
Member FrameCPP::Version_4::FrTOC::ForEach (query_info_type Info, FunctionBase &Action) const
Need to finish the list of channel names
Member FrameCPP::Version_4::FrSummary::Merge (const FrSummary &RHS)
Need to implement Merge routine
Member FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() (const Previous::FrStatDataStorage &Source)
Need to modify Version 3 FrStatData to follow NPS
Class FrameCPP::Version_4::FrStatDataNPS::storage_type
Needs documentation
Member FrameCPP::Version_4::FrStatData::Merge (const FrStatData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_4::FrSimData::Merge (const FrSimData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_4::FrSerData::Merge (const FrSerData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_4::FrProcData::demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
See if the actual sample rate can be computed
Member FrameCPP::Version_4::FrProcData::Merge (const FrProcData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_4::FrDetector::Merge (const FrDetector &RHS)
Need to implement Merge routine
Member FrameCPP::Version_4::FrAdcData::Merge (const FrAdcData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_3::FrVect::GetDim (nDim_type Offset)
Throw exception if value out of range
Member FrameCPP::Version_3::FrVect::GetDim (nDim_type Offset) const
Throw exception if value out of range
Member FrameCPP::Version_8::FrProcData::sub_time_series (REAL_8 Offset, REAL_8 Dt) const
Get the slice of FrVect
Member Description::Dump (const struct_data_type &Data, const CommandLine &Options) const
Need to add option to limit the number of data points to print.
Member SMALLEST_FRAME_SPEC_MIN
Need to remove this once version 3 and 4 are supported
Member init_cmm ()
This needs to be version specific
Member FrameCPP::Version_8::FrVect::GetDim (nDim_type Offset)
Throw exception if value out of range
Member FrameCPP::Version_8::FrVect::GetDim (nDim_type Offset) const
Throw exception if value out of range
Member FrameCPP::Version_8::FrVect::Merge (const FrVect &RHS)
Need to implement Merge routine
Member FrameCPP::Version_8::FrVect::operator+= (const FrVect &RHS)

Need to have a list of reasons

Need to have a list of reasons

Member FrameCPP::Version_8::FrTOC::operator== (const Common::FrameSpec::Object &RHS) const
actually implement comparision operator
Member FrameCPP::Version_8::FrTOC::ForEach (query_info_type Info, FunctionBase &Action) const
Need to finish the list of channel names
Member FrameCPP::Version_8::FrSummary::Merge (const FrSummary &RHS)
Need to implement Merge routine
Member FrameCPP::Version_8::FrStatData::Merge (const FrStatData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_8::FrSimData::Merge (const FrSimData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_8::FrSerData::Merge (const FrSerData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_3::FrVect::expandToBuffer (boost::shared_array< CHAR_U > &Dest, INT_8U &DestNBytes) const
The use of BYTE_ORDER_HOST here is flawed. Need to capture the byte order information when the object is read from disk. When initialially created, it will be in BYTE_ORDER_HOST order.
Member FrameCPP::Version_8::FrProcData::sub_time_series (REAL_8 Offset, REAL_8 Dt) const

Ensure the requested range is valid

Ensure the dimension of the FrVect is 1

Member FrameCPP::Version_8::FrProcData::demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
See if the actual sample rate can be computed
Member FrameCPP::Version_8::FrProcData::Merge (const FrProcData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_8::FrMsg::demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
Replace next references
Member FrameCPP::Version_8::FrMsg::Merge (const FrMsg &RHS)
Need to implement Merge routine
Member FrameCPP::Version_8::FrMsg::FrMsg (Previous::FrMsg &Source, istream_type *Stream)
Need to replace the next reference
Member FrameCPP::Version_8::FrHistory::Merge (const FrHistory &RHS)
Need to implement Merge routine
Member FrameCPP::Version_8::FrHeader::m_byte_order
need to lookup how this variable is used.
Member FrameCPP::Version_8::FrHeader::operator== (const Common::FrameSpec::Object &Obj) const
actually implement comparision operator
Member FrameCPP::Version_8::FrEndOfFile::SeekTOC () const
This may be better placed in the protected section.
Member FrameCPP::Version_8::FrDetector::Merge (const FrDetector &RHS)
Need to implement Merge routine
Member FrameCPP::Version_8::FrAdcData::Subset (REAL_8 Offset, REAL_8 Dt) const

Get the slice of FrVect

Ensure the requested range is valid

Member FrameCPP::Version_8::FrVect::GetDim (nDim_type Offset) const
Throw exception if value out of range
Member FrameCFrChanSet (FrameCError **Error, const fr_chan_t *Channel, int Option,...)

Inform user that the specified channel does not support setting of sample rate.

Inform user that the specified channel does not support setting of sample rate.

Inform user that the specified channel does not support setting of sample rate.

Inform user that the specified channel does not support setting of sample rate.

Inform user that the specified channel does not support setting of sample rate.

Member FrameCFrChanQuery (FrameCError **Error, const fr_chan_t *Channel, int Option,...)

Inform user that the specified channel does not support setting of sample rate.

Inform user that the specified channel does not support setting of sample rate.

Inform user that the specified channel does not support setting of sample rate.

Inform user that the specified channel does not support setting of sample rate.

Inform user that the specified channel does not support setting of sample rate.

Inform user that the specified channel does not support querying of this parameter.

Member FrameCFrProcMimeChanAlloc (FrameCError **Error, const char *Name, const char *MimeTypeName, fr_vect_ndata_t NData, fr_vect_data_t MimeData)
Currently the DataType and NData fields are not being used. Either they need to be eliminated or used to create an appropriate FrVect for data storage.
Member FrameCFrProcChanAlloc (FrameCError **Error, const char *Name, fr_proc_type Type, fr_proc_sub_type SubType, fr_vect_data_types_t DataType, fr_vect_ndata_t NData)
Currently the DataType and NData fields are not being used. Either they need to be eliminated or used to create an appropriate FrVect for data storage.
Member FrameCFrChanAlloc (FrameCError **Error, const char *Name, fr_chan_type Type, fr_vect_data_types_t DataType, fr_vect_ndata_t NData)
Currently the DataType and NData fields are not being used. Either they need to be eliminated or used to create an appropriate FrVect for data storage.
Member FrameCPP::Version_8::FrVect::GetDim (nDim_type Offset)
Throw exception if value out of range
Member FrameCFrChanSet (FrameCError **Error, const fr_chan_t *Channel, int Option,...)
Inform user that the specified channel does not support setting of sample rate.
Member FrameCPP::Version_8::FrHeader::m_byte_order
need to lookup how this variable is used.
Member FrameCPP::Version_8::FrEndOfFile::SeekTOC () const
This may be better placed in the protected section.
Member FrameCPP::Version_6::FrStatDataPS
Needs documentation
Member FrameCPP::Version_6::FrStatDataNPS
Needs documentation
Member FrameCPP::Version_4::FrVect::GetDim (nDim_type Offset)
Throw exception if value out of range
Member FrameCPP::Version_4::FrVect::GetDim (nDim_type Offset) const
Throw exception if value out of range
Member FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() (const Previous::FrStatDataStorage &Source)
Need to modify Version 3 FrStatData to follow NPS
Class FrameCPP::Version_4::FrStatDataNPS::storage_type
Needs documentation
Member FrameCPP::Version_3::FrVect::GetDim (nDim_type Offset)
Throw exception if value out of range
Member FrameCPP::Version_3::FrVect::GetDim (nDim_type Offset) const
Throw exception if value out of range
Class FrameCPP::Common::SearchContainer< T, F >
Should this be an adaptor class?
Member FrameCPP::Common::OStream::operator<< (object_type Data)
support MD5Sum
Member FrameCPP::Common::FrSH::name () const =0
See about storing name in this class and eliminate the need for this virtual method.
Member FrameCPP::Compression::ZeroSuppress::Compress (const data_element_type *DataIn, nbytes_type NBytesIn, boost::shared_array< data_element_type > &DataOut, nbytes_type &NBytesOut)
Correct this documentation
Member FrameCPP::Common::FrTOC::ForEach (query_info_type Info, FunctionBase &Action) const
Need to decide if this functions should throw an exception when called to indicate that it is not implemented for the calling version of the frame specification.
Member FrameCPP::Version_3::FrVect::Merge (const FrVect &RHS)
Need to implement Merge routine
Member FrameCPP::Version_3::FrVect::operator+= (const FrVect &RHS)

Need to have a list of reasons

Need to have a list of reasons

Member FrameCPP::Version_3::FrSummary::Merge (const FrSummary &RHS)
Need to implement Merge routine
Member FrameCPP::Version_3::FrStatData::Merge (const FrStatData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_3::FrSimData::Merge (const FrSimData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_3::FrSerData::Merge (const FrSerData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_3::FrProcData::Merge (const FrProcData &RHS)
Need to implement Merge routine
Member FrameCPP::Version_3::FrMsg::Merge (const FrMsg &RHS)
Need to implement Merge routine
Member FrameCPP::Version_3::FrHistory::Merge (const FrHistory &RHS)
Need to implement Merge routine
Member FrameCPP::Version_3::FrHeader::operator== (const Common::FrameSpec::Object &Obj) const
actually implement comparision operator
Member FrameCPP::Version_3::FrDetector::Merge (const FrDetector &RHS)
Need to implement Merge routine
Member FrameCPP::Common::Verify::operator() (IFrameStream &Stream, frame_filename_ptr_type &Filename=NULL_FRAME_FILENAME)
A true check for the end of file structure needs to be done for the fast check. A proposed method would be to do a seek to the end of the file minus the size of the structure. Invoke the read object call and verify the object that was read was an FrEndOfFile object. Seek back to the previous file position.
Class FrameCPP::Common::SearchContainer< T, F >
Should this be an adaptor class?
Member FrameCPP::Common::OStream::operator<< (object_type Data)
support MD5Sum
Member FrameCPP::Compression::GZip::Compress (const CHAR_U *DataIn, INT_8U NBytesIn, size_t Level, boost::shared_array< CHAR_U > &DataOut, INT_8U &NBytesOut)
Correct this documentation
Member FrameCPP::Common::FrStatData::Query::Add (const std::string &NamePattern, const LDASTools::AL::GPSTime &StartTime, const LDASTools::AL::GPSTime &EndTime, const INT_4U Version)
Verify mode to be table of contents
Member FrameCPP::Common::FrSH::name () const =0
See about storing name in this class and eliminate the need for this virtual method.
Member FrameCPP::Common::OFrameStream::Write (object_type Obj)

Need to ensure that all FrStatData structures have been written to the stream. This is to verify that that an FrDetector structure has been associated with each FrStatData.

Check that the compression mode is supported by by the writer

Member FrameCPP::Common::IFrameStream::ReadFrStatData (INT_8U Position)
Need to add support for reading the FrDetector for FrStatData structures where the FrStatData is before any FrameH structures.
Member FrameCPP::Common::IFrameStream::Read ()
Check if read goes beyond the end of the file
Member FrameCPP::Common::FrameBufferInterface::Scanner::NextBlock (const char *Buffer, size_type Size)
Instead of just bailing when failing to read the buffer, need to see if the buffer contains some subset of the ORIGINATOR string so as to allow resyncing to happen
Class FrameCPP::Common::ContainerBase< Obj >
Implement iterators which dereference to Base*'s. This will allow the todo: STL iterator model to be used with this class.
Member FrameCPP::Compression::ZeroSuppress::Compress (const data_element_type *DataIn, nbytes_type NBytesIn, boost::shared_array< data_element_type > &DataOut, nbytes_type &NBytesOut)
Correct this documentation
Member FrameCPP::Compression::GZip::Compress (const CHAR_U *DataIn, INT_8U NBytesIn, size_t Level, boost::shared_array< CHAR_U > &DataOut, INT_8U &NBytesOut)
Correct this documentation
Member FrameCPP::Compression::Compress (INT_4U &CompressionMode, INT_4U Level, const compress_type_mapping &CompressionMapping, const compress_type_reverse_mapping &CompressionReverseMapping, INT_4U DataType, const data_type_mapping &DataTypeMapping, const CHAR_U *Source, const INT_8U SourceLength, const INT_8U SourceByteLength, output_type &Dest, INT_8U &DestByteLength)
See about doing gzip compression when an exception is thrown for zero suppress compressions.
Member FrameCFrChanVectorSet (FrameCError **Error, fr_chan_t *Channel, int Option,...)
Produce error message because the data type or number of data elements is not consistant.
Member FrameCFrChanSet (FrameCError **Error, const fr_chan_t *Channel, int Option,...)

Inform user that the specified channel does not support setting of sample rate.

Inform user that the specified channel does not support setting of sample rate.