X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src2%2FcreaImageIOTreeHandler.h;h=16f599cddf52f69460a8b53082817499e51362f3;hb=c8cde70cb8a9b31ed59460435e7c82ef0b68c6be;hp=a454116a17ca9559128cc7c6bceec7f0828a6a81;hpb=f08880c40f6304be640c7f8702bbbe96f8d50b40;p=creaImageIO.git diff --git a/src2/creaImageIOTreeHandler.h b/src2/creaImageIOTreeHandler.h index a454116..16f599c 100644 --- a/src2/creaImageIOTreeHandler.h +++ b/src2/creaImageIOTreeHandler.h @@ -14,96 +14,97 @@ namespace creaImageIO * \ingroup Model */ //======================================================================= + /// Abstract class which 'handles' a Tree structure class TreeHandler { public: - ///==================================================================== + //==================================================================== // typedef TreeHandlerStatistics Statistics; - ///==================================================================== + //==================================================================== - ///==================================================================== + //==================================================================== /// Ctor TreeHandler() {} /// Virtual dtor virtual ~TreeHandler() {} - ///==================================================================== + //==================================================================== - ///==================================================================== + //==================================================================== /// Returns the Tree handled tree::Tree& GetTree() { return mTree; } /// Returns the Tree handled (const) const tree::Tree& GetTree() const { return mTree; } - ///==================================================================== + //==================================================================== - ///==================================================================== - /// QUERY METHODS + //==================================================================== + // QUERY METHODS /// Is the 'source' readable ? virtual bool IsReadable() { return false; } /// Is the 'source' writable ? virtual bool IsWritable() { return false; } - ///==================================================================== + //==================================================================== - ///==================================================================== - /// INITIALIZATION / FINALIZATION - ///==================================================================== + //==================================================================== + // INITIALIZATION / FINALIZATION + //==================================================================== - ///==================================================================== + //==================================================================== /// Opens an existing 'source' - /// Default mode is read only - /// If IsWritable and writable==true then opens in read/write mode + // Default mode is read only + // If IsWritable and writable==true then opens in read/write mode virtual bool Open(bool writable = false) { return false; } /// Closes the 'source' virtual bool Close() { return false; } /// Creates a new 'source' - /// Default mode is read only - /// If IsWritable and writable==true then opens in read/write mode + // Default mode is read only + // If IsWritable and writable==true then opens in read/write mode virtual bool Create(bool writable = false) { return false; } /// Destroys the 'source' virtual bool Destroy() { return false; } - ///==================================================================== + //==================================================================== - ///==================================================================== + //==================================================================== // READ METHODS - ///==================================================================== + //==================================================================== - ///==================================================================== + //==================================================================== /// Returns the number of children of the Node *WITHOUT LOADING THEM* - /// REM : The Tree itself is a Node and asking for its number of - /// children returns the number of children of level 1. + // REM : The Tree itself is a Node and asking for its number of + // children returns the number of children of level 1. virtual unsigned int GetNumberOfChildren(tree::Node* n) { return 0; } - ///==================================================================== + //==================================================================== - ///==================================================================== + //==================================================================== /// Recursively loads the children of node 'parent' until maxlevel - /// is reached. - /// If maxlevel <= 0 then loads all the sub-tree rooted at parent - /// If parent == NULL or parent == tree then starts with the 'children' of - /// the tree itself. - /// Returns the total number of children loaded. + // is reached. + // If maxlevel <= 0 then loads all the sub-tree rooted at parent + // If parent == NULL or parent == tree then starts with the 'children' of + // the tree itself. + // Returns the total number of children loaded. virtual int LoadChildren(tree::Node* parent, int maxlevel) { return 0; } - ///==================================================================== + //==================================================================== - ///==================================================================== + //==================================================================== /// Unloads the Node and its descendants - /// WITHOUT altering the source, e.g. the database + // WITHOUT altering the source, e.g. the database virtual void UnLoad(tree::Node* n) { return; } - ///==================================================================== + //==================================================================== - ///==================================================================== - /// WRITE METHODS : WORK ONLY IN WRITE MODE - ///==================================================================== + //==================================================================== + // WRITE METHODS : WORK ONLY IN WRITE MODE + //==================================================================== typedef tree::Node::AttributeMapType AttributeMapType; - /// Adds a branch in the tree with the attributes provided - /// returns the Level in the tree where the branch was connected - /// (-1 for error, 0 for top level, etc. ) - /// Of course the branch is loaded on exit + /// Adds a branch in the tree with the attributes provided + // returns the Level in the tree where the branch was connected + // (-1 for error, 0 for top level, etc. ) + // Of course the branch is loaded on exit virtual int AddBranch( const AttributeMapType& ) { return -1; } /// Removes the node and its descendants virtual bool Remove(tree::Node*) { return false; } @@ -111,7 +112,7 @@ namespace creaImageIO virtual bool SetAttribute(tree::Node*, const std::string& key, const std::string& value) { return false; } - ///==================================================================== + //==================================================================== private: @@ -124,11 +125,11 @@ namespace creaImageIO /* //======================================================================= /// Memorizes statistics on operations done by a tree handler - /// (nodes created, removed, ...) + // (nodes created, removed, ...) class TreeHandlerStatistics { public: - ///==================================================================== + //==================================================================== /// Ctor TreeHandler(TreeHandler* tree) : mTreeHandler(tree) { Reset(); } /// Dtor