SDMDataObjectStreamReader.h

Go to the documentation of this file.

#ifndef SDMDataObjectStreamReader_CLASS
#define SDMDataObjectStreamReader_CLASS
#include <utility>
#include <iostream>
#include <sstream>
#include <fstream>
#include <vector>
#include <map>
#include <set>
#include <bitset>
#include <boost/algorithm/string.hpp>
#include <libxml/parser.h>
#include <libxml/tree.h>

#include "boost/filesystem/operations.hpp"
#include <boost/regex.hpp>

#include "SDMDataObjectParser.h"
#include "SDMDataObject.h"
#include "CPrimitiveDataType.h"

using namespace std;
using namespace boost;

namespace asdmbinaries {
  class SDMDataObjectStreamReaderException {
  public:
    SDMDataObjectStreamReaderException();
    SDMDataObjectStreamReaderException(const string& message);
  
    const string& getMessage();
  
  private:
    string message;
  };
 
  class SDMDataObjectStreamReader {
  public:
    SDMDataObjectStreamReader() ;
    virtual ~SDMDataObjectStreamReader() ;
    void        open(const string& path);

    int64_t position();
    
    void close();

    unsigned long long currentIntegrationStartsAt() const;

    unsigned int currentIntegrationIndex() const;

    string title() const;

    const ByteOrder* byteOrder() const ;

    unsigned long long startTime() const;

    unsigned int numTime() const;

    string dataOID() const;

    string execBlockUID() const;

    unsigned int execBlockNum() const;

    unsigned int scanNum() const;

    unsigned int subscanNum() const;

    string projectPath() const;

    unsigned int numAntenna() const;

    CorrelationMode correlationMode() const;


    OptionalSpectralResolutionType spectralResolutionType() const;

    ProcessorType processorType() const;


    CorrelatorType correlatorType() const;

    bool isTP() const ;


    bool isCorrelation() const;

    const SDMDataObject::DataStruct& dataStruct() const;

    bool aborted() const;

    unsigned long long abortTime() const;

    string abortReason() const;

    string toString() const;

    bool                        hasSubset();

    /*
     * Returns a reference to an SDMDataSubset.
     * This SDMDataSubset represents the (sub)integration read and parsed at the current position (see currentIntegrationIndex()
     * and currentIntegrationStartsAt()) in the sequence stored in the stream.
     * O
     * 
     * @return a reference to an SDMDataSubset
     */
    const SDMDataSubset&        getSubset();

    /*
     * Returns binary data found in the BDF file from the current location and contained in the next 
     * nDataSubsets at maximum.
     *
     * The result is returned as a reference to a vector of SDMDataSubset. Each element of this vector
     * is an instance of an SDMDataSubset obtained by a sequential read of the file opened with the method open
     * from the current position in that file.
     *
     * The size of the resulting vector determines how many SDMDataSubsets have been actually read. 
     *
     * @return const vector<SDMDataSubset>& 
     */
    const vector<SDMDataSubset>& nextSubsets(unsigned int nSubsets);

    /*
     * Returns all binary data found in the BDF file from the current location.
     *
     * The result is returned as a reference to a vector of SDMDataSubset. Each element of this vector
     * is an instance of an SDMDataSubset obtained by a sequential read of the file opened with the method open
     * from the current position in that file. 
     *
     * @return const vector<SDMDataSubset>& 
     */
    const vector<SDMDataSubset>& allRemainingSubsets();

    enum BINATTACHCODES {ACTUALDURATIONS=0, ACTUALTIMES=1, AUTODATA=2, FLAGS=3, CROSSDATA=4, ZEROLAGS=5};
    bitset<6> attachmentFlags;

  private:
    // Enumerations to manage the state of an instance of SDMDataObjectStreamReader.
    //
    enum States {S_NO_BDF, S_AT_BEGINNING, S_READING, S_AT_END};
    enum Transitions {T_OPEN, T_QUERY, T_TEST_END, T_READ, T_READ_NEXT, T_READ_ALL, T_CLOSE};

    // Private variables
    unsigned long long integrationStartsAt;
    unsigned int       integrationIndex;
    string      path;
    ifstream    f;
    States      currentState;
    string      currentLine;
    string      boundary_1;
    string      boundary_2;
    bool        opened;

    map<string, int64_t>        binaryPartSize;
    set<string>                 s_partNames;
    char*                       actualTimesBuffer;
    char*                       actualDurationsBuffer;
    char*                       autoDataBuffer;
    char*                       crossDataBuffer;
    char*                       flagsBuffer;
    char*                       zeroLagsBuffer;

    SDMDataObjectParser   parser;
    SDMDataObject         sdmDataObject;
    SDMDataSubset         sdmDataSubset;
    vector<SDMDataSubset> remainingSubsets;
    vector<SDMDataSubset> someSubsets;

    // Private methods
    void                        checkState(Transitions t, const string& methodName) const; 
    string                      nextLine();
    pair<string, string>        headerField2Pair(const string& hf);
    pair<string, string>        requireHeaderField(const string& hf);
    string                      requireMIMEHeader();
    string                      requireBoundaryInCT(const string& ctValue);
    void                        skipUntilEmptyLine(int maxSkips);  
    string                      accumulateUntilBoundary(const string& boundary, int maxLines);
    void                        requireBoundary(const string&, int maxLines);
    void                        lookForBinaryPartSize(xmlNode*  aNode);
    string                      requireCrossDataType(xmlNode* parent);

    void        printElementNames(xmlNode * a_node);
    void        requireSDMDataHeaderMIMEPart();
    void        requireSDMDataSubsetMIMEPart(SDMDataSubset& sdmDataSubset);

    void        releaseMemory(SDMDataSubset & sdmDataSubset);
  };
} // end namespace asdmbinaries

#endif