0030773: Application Framework - To allow to inherit existing attributes to reuse...
[occt.git] / src / TDataStd / TDataStd_Name.hxx
1 // Created on: 1997-07-31
2 // Created by: Denis PASCAL
3 // Copyright (c) 1997-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _TDataStd_Name_HeaderFile
18 #define _TDataStd_Name_HeaderFile
19
20 #include <TDataStd_GenericExtString.hxx>
21 #include <Standard_OStream.hxx>
22
23 class Standard_DomainError;
24 class TDF_Label;
25 class TCollection_ExtendedString;
26 class TDF_Attribute;
27 class TDF_RelocationTable;
28
29
30 class TDataStd_Name;
31 DEFINE_STANDARD_HANDLE(TDataStd_Name, TDataStd_GenericExtString)
32
33 //! Used to define a name attribute containing a string which specifies the name.
34 class TDataStd_Name : public TDataStd_GenericExtString
35 {
36
37 public:
38   
39   //! class methods working on the name itself
40   //! ========================================
41   //! Returns the GUID for name attributes.
42   Standard_EXPORT static const Standard_GUID& GetID();
43   
44   //! Creates (if does not exist) and sets the name in the name attribute.
45   //! from any label <L>  search in father  labels (L is not
46   //! concerned) the first name attribute.if found set it in
47   //! <father>.
48   //! class methods working on the name tree
49   //! ======================================
50   //! Search in the  whole TDF_Data the Name attribute which
51   //! fit with <fullPath>. Returns True if found.
52   //! Search  under <currentLabel>  a  label which fit with
53   //! <name>. Returns True if  found. Shortcut which  avoids
54   //! building a ListOfExtendedStrin.
55   //! Search in the whole TDF_Data the label which fit with name
56   //! Returns True if found.
57   //! tools methods to translate path <-> pathlist
58   //! ===========================================
59   //! move to draw For Draw test we may provide this tool method which convert a path in a
60   //! sequence of string to call after the FindLabel methods.
61   //! Example: if it's given "Assembly:Part_1:Sketch_5" it will return in <pathlist>
62   //! the list of 3 strings: "Assembly","Part_1","Sketch_5".
63   //! move to draw from <pathlist> build the string path
64   //! Name methods
65   //! ============
66   Standard_EXPORT static Handle(TDataStd_Name) Set (const TDF_Label& label, const TCollection_ExtendedString& string);
67
68   //! Finds, or creates, a Name attribute with explicit user defined <guid> and sets <string>.
69   //! The Name attribute  is  returned. 
70   Standard_EXPORT static Handle(TDataStd_Name) Set (const TDF_Label& label, const Standard_GUID& guid,
71                                     const TCollection_ExtendedString& string);
72
73   Standard_EXPORT TDataStd_Name();
74   
75   //! Sets <S> as name. Raises if <S> is not a valid name.
76   Standard_EXPORT void Set (const TCollection_ExtendedString& S) Standard_OVERRIDE;
77   
78   //! Sets the explicit user defined GUID  to the attribute.
79   Standard_EXPORT void SetID (const Standard_GUID& guid) Standard_OVERRIDE;
80
81   //! Sets default GUID for the attribute.
82   Standard_EXPORT void SetID() Standard_OVERRIDE;
83
84   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
85   
86
87   DEFINE_DERIVED_ATTRIBUTE(TDataStd_Name, TDataStd_GenericExtString)
88
89 };
90
91
92
93
94
95
96
97 #endif // _TDataStd_Name_HeaderFile