X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src2%2FcreaImageIOTreeNode.h;h=55d6ab570b36a46c7adad26c00419fb0e5ccf284;hb=320881ed38a25ff56c33aa915d4b943c1e42698b;hp=07b46cfb20efe18230ecf071bd23697ed205df90;hpb=cbf693fa62cd51f4ca5c881838bbb609edc447b0;p=creaImageIO.git diff --git a/src2/creaImageIOTreeNode.h b/src2/creaImageIOTreeNode.h index 07b46cf..55d6ab5 100644 --- a/src2/creaImageIOTreeNode.h +++ b/src2/creaImageIOTreeNode.h @@ -11,13 +11,16 @@ namespace creaImageIO namespace tree { + /** + * \ingroup Tree + */ //===================================================================== /// Forward declaration of Tree class Tree; //===================================================================== //===================================================================== - /// Abstract class to store user data on a tree node + /// Abstract class to store user data on a Tree node struct NodeData { NodeData() {} @@ -27,15 +30,22 @@ namespace creaImageIO //===================================================================== - /// Node of an attributed tree structure + /// Node of an attributed Tree structure class Node { public: + typedef std::map AttributeMapType; + + /// Ctor with parent Node(Node* parent); + /// Ctor with parent and attributes map + Node(Node* parent, const AttributeMapType& ); /// Virtual destructor virtual ~Node(); + /// Initializes the attribute map i.e. creates the entries + void InitializeAttributeMap(); /// Returns the level descriptor of the node const LevelDescriptor& GetLevelDescriptor() const; @@ -71,26 +81,35 @@ namespace creaImageIO const ChildrenListType& GetChildrenList() const { return mChildren; } /// Remove the given children from the children list - void RemoveChildrenFromList(Node*); - - typedef std::map AttributeMapType; + int RemoveChildrenFromList(Node*); + + /// Get the Attributes Map AttributeMapType& GetAttributeMap() { return mAttributeMap; } + + /// Get the Attributes Map const AttributeMapType& GetAttributeMap() const { return mAttributeMap; } + + /// Get the Attribute for a specific key const std::string& GetAttribute(const std::string& k) const; - const std::string& GetCleanAttribute(const std::string& k) const; - const std::string& UnsafeGetAttribute(const std::string& k) const - { return mAttributeMap.find(k)->second; } + + /// Get the Attribute for a specific key without OS dependance (not implemented) + // TODO : backslash OS uniformity + const std::string& GetCleanAttribute(const std::string& k) const; + + /// Set an Attribute for a specific key void SetAttribute(const std::string& k, const std::string& v); + + /// Set an Attribute for a specific key(unsafe mode) void UnsafeSetAttribute(const std::string& k, const std::string& v) { mAttributeMap[k] = v; } - const AttributeDescriptor& GetAttributeDescriptor(const std::string& k) - const; - // { return GetTypeDescription().GetFieldDescription(k); } - + /// Get Descriptor for an Attribute + const AttributeDescriptor& GetAttributeDescriptor(const std::string& k)const; + + /// Returns true if the KEY attributes of the node match those of the map provided + bool Matches( const AttributeMapType& ) const; - /// Returns the node data casted into the type T template T GetData() const { if (mData!=0) return dynamic_cast(mData); return 0; } @@ -101,14 +120,12 @@ namespace creaImageIO /// Sorts the children of the node void SortChildren(const LexicographicalComparator&); - /* - virtual void Print() const; + /// Print the node + virtual void Print() const; + + /// Get the Label of the node std::string GetLabel() const; - int ImageGetRows() const; - int ImageGetColumns() const; - int ImageGetFrames() const; - const std::string& ImageGetFullFileName() const { return UnsafeGetAttribute("FullFileName"); } - */ + private: /// The parent of the node