0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / Interface / Interface_Category.hxx
CommitLineData
42cf5bc1 1// Created on: 1995-11-08
2// Created by: Christian CAILLET
3// Copyright (c) 1995-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 _Interface_Category_HeaderFile
18#define _Interface_Category_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_DefineAlloc.hxx>
22#include <Standard_Handle.hxx>
23
24#include <TColStd_HArray1OfInteger.hxx>
25#include <Standard_Integer.hxx>
26#include <Standard_CString.hxx>
27class Interface_GTool;
28class Interface_Protocol;
29class Standard_Transient;
30class Interface_ShareTool;
31class Interface_InterfaceModel;
32
33
34//! This class manages categories
35//! A category is defined by a name and a number, and can be
36//! seen as a way of rough classification, i.e. less precise than
37//! a cdl type.
38//! Hence, it is possible to dispatch every entity in about
39//! a dozen of categories, twenty is a reasonable maximum.
40//!
41//! Basically, the system provides the following categories :
42//! Shape (Geometry, BRep, CSG, Features, etc...)
43//! Drawing (Drawing, Views, Annotations, Pictures, Scketches ...)
44//! Structure (Component & Part, Groups & Patterns ...)
45//! Description (Meta-Data : Relations, Properties, Product ...)
46//! Auxiliary (those which do not enter in the above list)
47//! and some dedicated categories
48//! FEA , Kinematics , Piping , etc...
49//! plus Professional for other dedicated non-classed categories
50//!
51//! In addition, this class provides a way to compute then quickly
52//! query category numbers for an entire model.
53//! Values are just recorded as a list of numbers, control must
54//! then be done in a wider context (which must provide a Graph)
55class Interface_Category
56{
57public:
58
59 DEFINE_STANDARD_ALLOC
60
61
62 //! Creates a Category, with no protocol yet
63 Standard_EXPORT Interface_Category();
64
65 //! Creates a Category with a given protocol
66 Standard_EXPORT Interface_Category(const Handle(Interface_Protocol)& proto);
67
68 //! Creates a Category with a given GTool
69 Standard_EXPORT Interface_Category(const Handle(Interface_GTool)& gtool);
70
71 //! Sets/Changes Protocol
72 Standard_EXPORT void SetProtocol (const Handle(Interface_Protocol)& proto);
73
74 //! Determines the Category Number for an entity in its context,
75 //! by using general service CategoryNumber
76 Standard_EXPORT Standard_Integer CatNum (const Handle(Standard_Transient)& ent, const Interface_ShareTool& shares);
77
78 //! Clears the recorded list of category numbers for a Model
79 Standard_EXPORT void ClearNums();
80
81 //! Computes the Category Number for each entity and records it,
82 //! in an array (ent.number -> category number)
83 //! Hence, it can be queried by the method Num.
84 //! The Model itself is not recorded, this method is intended to
85 //! be used in a wider context (which detains also a Graph, etc)
86 Standard_EXPORT void Compute (const Handle(Interface_InterfaceModel)& model, const Interface_ShareTool& shares);
87
88 //! Returns the category number recorded for an entity number
89 //! Returns 0 if out of range
90 Standard_EXPORT Standard_Integer Num (const Standard_Integer nument) const;
91
92 //! Records a new Category defined by its names, produces a number
93 //! New if not yet recorded
94 Standard_EXPORT static Standard_Integer AddCategory (const Standard_CString name);
95
96 //! Returns the count of recorded categories
97 Standard_EXPORT static Standard_Integer NbCategories();
98
99 //! Returns the name of a category, according to its number
100 Standard_EXPORT static Standard_CString Name (const Standard_Integer num);
101
102 //! Returns the number of a category, according to its name
103 Standard_EXPORT static Standard_Integer Number (const Standard_CString name);
104
105 //! Default initialisation
106 //! (protected against several calls : passes only once)
107 Standard_EXPORT static void Init();
108
109
110
111
112protected:
113
114
115
116
117
118private:
119
120
121
122 Handle(Interface_GTool) thegtool;
123 Handle(TColStd_HArray1OfInteger) thenum;
124
125
126};
127
128
129
130
131
132
133
134#endif // _Interface_Category_HeaderFile