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"
#include "fiff_explain.h"

//=============================================================================================================
// QT INCLUDES
//=============================================================================================================

#include <QList>
#include <QSharedPointer>
#include <QStringList>

//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================

namespace FIFFLIB
{

class FiffStream;
class FiffTag;

//=============================================================================================================
class FIFFSHARED_EXPORT FiffDirNode {
public:
    typedef QSharedPointer<FiffDirNode> SPtr;               
    typedef QSharedPointer<const FiffDirNode> ConstSPtr;    
    //=========================================================================================================
    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, QSharedPointer<FiffTag>& p_pTag) const;

    //=========================================================================================================
    bool find_tag(FiffStream* p_pStream, fiff_int_t findkind, QSharedPointer<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);

    //=========================================================================================================
    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

    // typedef struct _fiffDirNode {
    //  int                 type;    /**< Block type for this directory *
    //  fiffId              id;      /**< Id of this block if any *
    //  fiffDirEntry        dir;     /**< Directory of tags in this node *
    //  int                 nent;    /**< Number of entries in this node *
    //  fiffDirEntry        dir_tree;    /**< Directory of tags within this node
    //                                     * subtrees as well as FIFF_BLOCK_START and FIFF_BLOCK_END
    //                   * included. NOTE: While dir is allocated separately
    //                   * dir_tree is a pointer to the dirtree field
    //                   * in the FiffStream structure. The dir_tree and nent_tree
    //                   * fields are only used within the library to facilitate
    //                   * certain operations. *
    //  int                 nent_tree;   /**< Number of entries in the directory tree node *
    //  struct _fiffDirNode *parent;     /**< Parent node *
    //  struct _fiffDirNode **children;  /**< Child nodes *
    //  int                 nchild;      /**< Number of child nodes *
    // } fiffDirNodeRec,*fiffDirNode;    /**< Directory tree structure used by the fiff library routines. *
};

//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================

inline bool FiffDirNode::find_tag(QSharedPointer<FiffStream> &p_pStream, fiff_int_t findkind, QSharedPointer<FiffTag> &p_pTag) const
{
    return find_tag(p_pStream.data(), findkind, p_pTag);
}
} // NAMESPACE

#endif // FIFF_DIR_NODE_H