fiff_dir_node.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FIFF_DIR_NODE_H
#define FIFF_DIR_NODE_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fiff_global.h"
#include "fiff_constants.h"
#include "fiff_types.h"
#include "fiff_dir_entry.h"
#include "fiff_id.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QList>
#include <QSharedPointer>
#include <QStringList>
#include <memory>
 
//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================
 
namespace FIFFLIB
{
 
class FiffStream;
class FiffTag;
 
//=============================================================================================================
class FIFFSHARED_EXPORT FiffDirNode
{
public:
    using SPtr = QSharedPointer<FiffDirNode>;             
    using ConstSPtr = QSharedPointer<const FiffDirNode>;  
    using UPtr = std::unique_ptr<FiffDirNode>;            
    using ConstUPtr = std::unique_ptr<const FiffDirNode>; 
 
    //=========================================================================================================
    FiffDirNode();
 
    //=========================================================================================================
    FiffDirNode(const FiffDirNode* p_FiffDirTree);
 
    //=========================================================================================================
    ~FiffDirNode();
 
    //=========================================================================================================
    static bool copy_tree(QSharedPointer<FiffStream>& p_pStreamIn, const FiffId& in_id, const QList<QSharedPointer<FiffDirNode>>& p_Nodes, QSharedPointer<FiffStream>& p_pStreamOut);
 
    //=========================================================================================================
    inline bool isEmpty() const
    {
        return this->type < 0;
    }
 
    //=========================================================================================================
    QList<FiffDirNode::SPtr> dir_tree_find(fiff_int_t p_kind) const;
 
    //=========================================================================================================
    inline bool find_tag(QSharedPointer<FiffStream>& p_pStream, fiff_int_t findkind, std::unique_ptr<FiffTag>& p_pTag) const;
 
    //=========================================================================================================
    bool find_tag(FiffStream* p_pStream, fiff_int_t findkind, std::unique_ptr<FiffTag>& p_pTag) const;
 
    //=========================================================================================================
    bool has_tag(fiff_int_t findkind);
 
    //=========================================================================================================
    bool has_kind(fiff_int_t p_kind) const;
 
    //=========================================================================================================
    void print(int indent) const;
 
    //=========================================================================================================
    static void explain_block(int kind);
 
    //=========================================================================================================
    static void explain(int kind);
 
    //=========================================================================================================
    static const char* get_tag_explanation(int kind);
 
    //=========================================================================================================
    static const char* get_unit_name(int unit);
 
    //=========================================================================================================
    fiff_int_t nent() const;
 
    //=========================================================================================================
    fiff_int_t nchild() const;
 
public:
    fiff_int_t type;                    
    FiffId id;                          
    QList<FiffDirEntry::SPtr> dir;      
                                        //    fiff_int_t                  nent;       /**< Number of entries in this node. */
    QList<FiffDirEntry::SPtr> dir_tree; 
    fiff_int_t nent_tree;               
    FiffDirNode::SPtr parent;           
    FiffId parent_id;                   
    QList<FiffDirNode::SPtr> children;  
    //    fiff_int_t                  nchild;     /**< Number of child nodes. */ -> use nchild() instead
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
inline bool FiffDirNode::find_tag(QSharedPointer<FiffStream>& p_pStream, fiff_int_t findkind, std::unique_ptr<FiffTag>& p_pTag) const
{
    return find_tag(p_pStream.data(), findkind, p_pTag);
}
} // NAMESPACE
 
#endif // FIFF_DIR_NODE_H