bids_path.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef BIDS_PATH_H
#define BIDS_PATH_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "bids_global.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
#include <QString>
#include <QMap>
#include <QDir>
 
//=============================================================================================================
// DEFINE NAMESPACE BIDSLIB
//=============================================================================================================
 
namespace BIDSLIB
{
 
//=============================================================================================================
class BIDSSHARED_EXPORT BIDSPath
{
public:
    using SPtr = QSharedPointer<BIDSPath>;            
    using ConstSPtr = QSharedPointer<const BIDSPath>; 
 
    //=========================================================================================================
    BIDSPath();
 
    //=========================================================================================================
    BIDSPath(const QString& sRoot,
             const QString& sSubject,
             const QString& sSession = QString(),
             const QString& sTask = QString(),
             const QString& sDatatype = QString(),
             const QString& sSuffix = QString(),
             const QString& sExtension = QString());
 
    //=========================================================================================================
    BIDSPath(const BIDSPath& other);
 
    //=========================================================================================================
    ~BIDSPath();
 
    //=========================================================================================================
    // Entity setters
    //=========================================================================================================

    void setRoot(const QString& sRoot);

    void setSubject(const QString& sSubject);

    void setSession(const QString& sSession);

    void setTask(const QString& sTask);

    void setAcquisition(const QString& sAcquisition);

    void setRun(const QString& sRun);

    void setProcessing(const QString& sProcessing);

    void setSpace(const QString& sSpace);

    void setRecording(const QString& sRecording);

    void setSplit(const QString& sSplit);

    void setDescription(const QString& sDescription);

    void setDatatype(const QString& sDatatype);

    void setSuffix(const QString& sSuffix);

    void setExtension(const QString& sExtension);
 
    //=========================================================================================================
    // Entity getters
    //=========================================================================================================

    QString root() const; 
    QString subject() const; 
    QString session() const; 
    QString task() const; 
    QString acquisition() const; 
    QString run() const; 
    QString processing() const; 
    QString space() const; 
    QString recording() const; 
    QString split() const; 
    QString description() const; 
    QString datatype() const; 
    QString suffix() const; 
    QString extension() const; 
 
    //=========================================================================================================
    // Path construction
    //=========================================================================================================

    QString basename() const;

    QString directory() const;

    QString filePath() const;
 
    //=========================================================================================================
    // Convenience methods
    //=========================================================================================================

    BIDSPath withSuffix(const QString& sSuffix, const QString& sExtension) const;

    BIDSPath channelsTsvPath() const;

    BIDSPath electrodesTsvPath() const;

    BIDSPath coordsystemJsonPath() const;

    BIDSPath eventsTsvPath() const;

    BIDSPath sidecarJsonPath() const;

    bool exists() const;

    bool mkdirs() const;

    QList<BIDSPath> match() const;
 
    //=========================================================================================================
    // Validation
    //=========================================================================================================

    static bool isValidEntityValue(const QString& sValue);
 
    //=========================================================================================================
    // Operators
    //=========================================================================================================
 
    BIDSPath& operator=(const BIDSPath& other);
    friend bool operator==(const BIDSPath& a, const BIDSPath& b);
 
private:
    QString m_sRoot;        
    QString m_sSubject;     
    QString m_sSession;     
    QString m_sTask;        
    QString m_sAcquisition; 
    QString m_sRun;         
    QString m_sProcessing;  
    QString m_sSpace;       
    QString m_sRecording;   
    QString m_sSplit;       
    QString m_sDescription; 
    QString m_sDatatype;    
    QString m_sSuffix;      
    QString m_sExtension;   

    static QString zeroPad(const QString& sValue);
};
 
//=============================================================================================================
 
inline bool operator==(const BIDSPath& a, const BIDSPath& b)
{
    return a.root() == b.root() &&
        a.subject() == b.subject() &&
        a.session() == b.session() &&
        a.task() == b.task() &&
        a.acquisition() == b.acquisition() &&
        a.run() == b.run() &&
        a.processing() == b.processing() &&
        a.space() == b.space() &&
        a.recording() == b.recording() &&
        a.split() == b.split() &&
        a.description() == b.description() &&
        a.datatype() == b.datatype() &&
        a.suffix() == b.suffix() &&
        a.extension() == b.extension();
}
 
} // namespace BIDSLIB
 
#endif // BIDS_PATH_H