FileSet.h

Go to the documentation of this file.

// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; tab-width: 4; -*-
// vim: set shiftwidth=4 softtabstop=4 expandtab:
/*
 ********************************************************************
 ** NIDAS: NCAR In-situ Data Acquistion Software
 **
 ** 2006, Copyright University Corporation for Atmospheric Research
 **
 ** This program is free software; you can redistribute it and/or modify
 ** it under the terms of the GNU General Public License as published by
 ** the Free Software Foundation; either version 2 of the License, or
 ** (at your option) any later version.
 **
 ** This program is distributed in the hope that it will be useful,
 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ** GNU General Public License for more details.
 **
 ** The LICENSE.txt file accompanying this software contains
 ** a copy of the GNU General Public License. If it is not found,
 ** write to the Free Software Foundation, Inc.,
 ** 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 **
 ********************************************************************
*/
/*
 ********************************************************************
    Copyright by the National Center for Atmospheric Research

    $LastChangedDate$

    $LastChangedRevision$

    $LastChangedBy$

    $HeadURL$
 ********************************************************************

*/

#ifndef NIDAS_UTIL_FILESET_H
#define NIDAS_UTIL_FILESET_H

#include "IOException.h"
#include "UTime.h"

#include <list>
#include <set>
#include <string>
#include <locale>
#include <ctime>
#include <limits.h>
#include <cstdio>
// #include <limits>
#include <sys/types.h>
#include <sys/uio.h>

namespace nidas { namespace util {

class FileSet {
public:

    FileSet();

    FileSet(const FileSet& x);

    FileSet& operator=(const FileSet& x);

    virtual FileSet* clone() const;

    virtual ~FileSet();

    virtual void setDir(const std::string& val);

    virtual const std::string& getDir() { return _dir; }

    int getFd() const { return _fd; }

    bool isNewFile() const { return _newFile; }

    virtual void setFileName(const std::string& val);

    virtual const std::string& getFileName() { return _filename; }

    virtual const std::string& getPath() { return _fullpath; }

    virtual void addFileName(const std::string& val) { _fileset.push_back(val); }

    void setFileLengthSecs(int val)
    {
        // LLONG_MAX is 292471 years in microsconds, so we 
        // won't have a Y2K-type issue for a while...
    if (val <= 0) _fileLength = LONG_LONG_MAX;
    else _fileLength = (long long) val * USECS_PER_SEC;
    }

    int getFileLengthSecs() const
    {
    if (_fileLength == LONG_LONG_MAX) return 0;
        return (int)(_fileLength / USECS_PER_SEC);
    }

    virtual UTime createFile(UTime tfile,bool exact) throw(IOException);

    void setStartTime(const UTime& val) { _startTime = val; } 

    UTime getStartTime() const { return _startTime; } 

    void setEndTime(const UTime& val) { _endTime = val; } 

    UTime getEndTime() const { return _endTime; } 

    const std::string& getCurrentName() const { return _currname; }

    virtual void
    closeFile() throw(IOException);

    virtual void
    openFileForWriting(const std::string& filename) throw(IOException);

    void openNextFile() throw(IOException);

    virtual size_t read(void* buf, size_t count) throw(IOException);

    virtual size_t write(const void* buf, size_t count) throw(IOException);

    virtual size_t write(const struct iovec* iov, int iovcnt) throw(IOException);

    static const char pathSeparator;

    static void createDirectory(const std::string& name,mode_t mode);

    static std::string getDirPortion(const std::string& path);

    static std::string getFilePortion(const std::string& path);

    static std::string makePath(const std::string& dir,const std::string& file);

#if !defined(NIDAS_EMBEDDED)

    void checkPathFormat(const UTime& t1, const UTime& t2) throw(IOException);
#endif

    std::list<std::string> matchFiles(const UTime& t1, const UTime& t2)
        throw(IOException);

    long long getFileSize() const throw(IOException);

    int getLastErrno() const 
    {
        return _lastErrno;
    }

    void
    setKeepOpening(bool keepopening)
    {
        _keepopening = keepopening;
    }

    bool
    keepOpening()
    {
        return _keepopening;
    }

protected:

    std::string formatName(const UTime& t1);

    static void replaceChars(std::string& in,const std::string& pat,
        const std::string& rep);

    const std::time_put<char>& _timeputter;

    bool _newFile;

    mutable int _lastErrno;

    int _fd;

    bool _keepopening;

private:

    void initialize();

    std::string _dir;

    std::string _filename;

    std::string _currname;

    std::string _fullpath;


    UTime _startTime;

    UTime _endTime;

    std::list<std::string> _fileset;

    std::list<std::string>::iterator _fileiter;

    bool _initialized;

    long long _fileLength;

};

}}  // namespace nidas namespace util

#endif