0027206: Inconsistent and obsolete information in persistence documentation and Relea...
[occt.git] / dox / user_guides / foundation_classes / foundation_classes.md
1 Foundation Classes  {#occt_user_guides__foundation_classes}
2 =================================
3
4 @tableofcontents
5
6 @section occt_fcug_1 Introduction
7
8 This manual explains how to use Open CASCADE Technology (**OCCT**)  Foundation Classes. It provides basic documentation on foundation classes. For  advanced information on foundation classes and their applications, see our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
9    
10 Foundation Classes provide a variety of general-purpose  services such as automated dynamic memory management (manipulation of objects  by handle), collections, exception handling, genericity by down-casting and  plug-in creation. 
11
12 Foundation Classes include the following: 
13
14 ### Root Classes
15 Root classes are the basic data types and classes on which all the  other classes are built. They provide: 
16   * fundamental types such as Boolean, Character, Integer or Real,
17   * safe handling of dynamically created objects, ensuring automatic  deletion of unreferenced objects (see  *Standard_Transient* class),
18   * configurable optimized memory manager increasing the performance  of applications that intensively use dynamically created objects,
19   * extended run-time type information (RTTI) mechanism facilitating  the creation of complex programs,
20   * management of exceptions,
21   * encapsulation of C++ streams.
22 Root classes are mainly implemented in *Standard* and  *MMgt* packages. 
23
24 ### Strings
25 Strings are classes that handle dynamically sized sequences  of characters based on both ASCII (normal 8-bit character type) and Unicode  (16-bit character type).  
26 Strings may also be manipulated by handles, and consequently  be shared. 
27 Strings are implemented in the *TCollection* package. 
28
29 ### Collections
30 Collections are the classes that handle dynamically sized  aggregates of data.  
31 Collection classes are *generic*, that is, they define  a structure and algorithms allowing to hold a variety of objects which do not  necessarily inherit from a unique root class (similarly to C++ templates). When  you need to use a collection of a given type of object, you must *instantiate* it for this specific type of element. Once this declaration is compiled, all functions available on the generic collection are available on your *instantiated  class*. 
32
33 Collections include a wide range of generic classes such as  run-time sized arrays, lists, stacks, queues, sets and hash maps. 
34 Collections are implemented in the *TCollection* and *NCollection* packages. 
35
36 ### Collections of Standard Objects
37
38 The *TColStd* package provides frequently used  instantiations of generic classes from the *TCollection* package with  objects from the *Standard* package or strings from the *TCollection* package. 
39
40 ### Vectors and Matrices
41
42 These classes provide commonly used mathematical algorithms  and basic calculations (addition, multiplication, transposition, inversion,  etc.) involving vectors and matrices. 
43
44 ### Primitive Geometric Types
45
46 Open CASCADE Technology primitive geometric types are a  STEP-compliant implementation of basic geometric and algebraic entities.  
47 They provide: 
48   * Descriptions of elementary geometric shapes:
49   * Points,
50   * Vectors,
51   * Lines,
52   * Circles and conics,
53   * Planes and elementary surfaces,
54   * Positioning of these shapes in space or in a plane by means of an  axis or a coordinate system,
55   * Definition and application of geometric transformations to these  shapes:
56   * Translations
57   * Rotations
58   * Symmetries
59   * Scaling transformations
60   * Composed transformations
61   * Tools (coordinates and matrices) for algebraic computation.
62   
63 ### Common Math Algorithms
64
65 Open CASCADE Technology common math algorithms provide a C++  implementation of the most frequently used mathematical algorithms.  
66 These include: 
67   * Algorithms to solve a set of linear algebraic equations,
68   * Algorithms to find the minimum of a function of one or more  independent variables,
69   * Algorithms to find roots of one, or of a set, of non-linear  equations,
70   * Algorithms to find the eigen-values and eigen-vectors of a square  matrix.
71
72 ### Exceptions
73
74 A hierarchy of commonly used exception classes is provided,  all based on class Failure, the  root of exceptions. 
75 Exceptions describe exceptional situations, which can arise  during the execution of a function. With the raising of an exception, the  normal course of program execution is abandoned. The execution of actions in  response to this situation is called the treatment of the exception. 
76
77 ### Quantities
78
79 These are various classes supporting date and time  information and fundamental types representing most physical quantities such as  length, area, volume, mass, density, weight, temperature, pressure etc. 
80
81 ### Application services
82
83 Foundation Classes also include implementation of several  low-level services that facilitate the creation of customizable and  user-friendly applications with Open CASCADE Technology. These include: 
84   * Unit conversion tools, providing a uniform mechanism for dealing  with quantities and associated physical units: check unit compatibility,  perform conversions of values between different units and so on (see package  *UnitsAPI*);
85   * Basic interpreter of expressions that facilitates the creation of  customized scripting tools, generic definition of expressions and so on (see  package *ExprIntrp*);
86   * Tools for dealing with configuration resource files (see package  *Resource*) and customizable message files (see package *Message*), making it easy  to provide a multi-language support in applications;
87   * Progress indication and user break interfaces, giving a  possibility even for low-level algorithms to communicate with the user in a  universal and convenient way.
88   
89
90 @section occt_fcug_2 Basics
91 This chapter deals with basic services such as library organization, persistence, data types, memory management,  programming with handles, exception handling, genericity by downcasting and plug-in creation. 
92
93
94 @subsection occt_fcug_2_a Library organization
95
96 This chapter introduces some basic concepts, which are used not only in Foundation Classes, but  throughout the whole OCCT library. 
97
98 @subsubsection occt_fcug_2_a_1 Modules  and toolkits
99
100 The whole OCCT library is organized in a set of modules. The  first module, providing most basic services and used by all other modules, is  called Foundation Classes and described by this manual. 
101
102 Every module consists primarily of one or several toolkits  (though it can also contain executables, resource units etc.). Physically a toolkit  is represented by a shared library (e.g. .so or .dll). The toolkit is built  from one or several packages. 
103
104 @subsubsection occt_fcug_2_a_2 Packages
105 A **package** groups together a number of classes which  have semantic links. For example, a geometry package would contain Point, Line,  and Circle classes. A package can also contain enumerations, exceptions and  package methods (functions). In practice, a class name is prefixed with the  name of its package e.g.  
106 *Geom_Circle*. 
107 Data types described in a package may include one or  more of the following data types: 
108   * Enumerations
109   * Object classes
110   * Exceptions
111   * Pointers to other object classes
112 Inside a package, two data types cannot bear the same  name. 
113
114 @image html /user_guides/foundation_classes/images/foundation_classes_image003.png  "Contents of a package"
115 @image latex /user_guides/foundation_classes/images/foundation_classes_image003.png  "Contents of a package"
116
117 **Methods** are either **functions** or **procedures**.  Functions return an object, whereas procedures only communicate by passing arguments.  In both cases, when the transmitted object is an instance manipulated by a  handle, its identifier is passed. There are three categories of methods: 
118 * **Object  constructor** Creates an instance of the described class. A class  will have one or more object constructors with various different arguments or none. 
119 * **Instance method** Operates on the  instance which owns it. 
120 * **Class  method** Does not work on individual  instances, only on the class itself. 
121
122 @subsubsection occt_fcug_2_a_3 Classes
123 The fundamental software component in object-oriented software  development is the class. A class is the implementation of a **data type**.  It defines its **behavior** (the services offered by its functions) and its **representation** (the data structure of the class -- the fields, which store its data). 
124
125 Classes fall into three categories: 
126 * Ordinary classes.
127 * Abstract classes. An **abstract class** cannot be instantiated. The purpose  of having such classes is to have a given behavior shared by a hierarchy of  classes and dependent on the implementation of the descendants. This is a way  of guaranteeing a certain base of inherited behavior common to all the classes  based on a particular deferred class. 
128 * Template classes. A **template class** offers a set of functional behaviors  to manipulate other data types. Instantiation of a template class requires that  a data type is given for its argument(s).
129
130 @subsubsection occt_fcug_2_a_5 Inheritance
131 The purpose of inheritance is to reduce the development  workload. The inheritance mechanism allows a new class to be declared already  containing the characteristics of an existing class. This new class can then be  rapidly specialized for the task in hand. This avoids the necessity of  developing each component “from scratch”. 
132 For example, having already developed a class *BankAccount* you  could quickly specialize new classes: *SavingsAccount, LongTermDepositAccount,  MoneyMarketAccount, RevolvingCreditAccount*, etc.... 
133
134 The corollary of this is that when two or more classes  inherit from a parent (or ancestor) class, all these classes guarantee as a  minimum the behavior of their parent (or ancestor). For example, if the parent  class BankAccount contains the method Print which tells it to print itself out,  then all its descendant classes guarantee to offer the same service. 
135
136 One way of ensuring the use of inheritance is to declare  classes at the top of a hierarchy as being **abstract**. In such classes,  the methods are not implemented. This forces the user to create a new class  which redefines the methods. This is a way of guaranteeing a certain minimum of  behavior among descendant classes. 
137
138 @subsection occt_fcug_2_1 Data Types
139
140 An object-oriented language structures a system around data types rather than around the actions carried out on this data. In this context,  an **object** is an **instance** of a data type and its definition  determines how it can be used. Each data type is implemented by one or more  classes, which make up the basic elements of the system. 
141
142 The data types in Open CASCADE Technology fall into two  categories: 
143   * Data types manipulated by handle (or reference)
144   * Data types manipulated by value
145   
146 @image html /user_guides/foundation_classes/images/foundation_classes_image004.png  "Manipulation of data types"
147 @image latex /user_guides/foundation_classes/images/foundation_classes_image004.png  "Manipulation of data types"
148   
149 A data type is implemented as a class. The class not only  defines its data representation and the methods available on instances, but it  also suggests how the instance will be manipulated. 
150   * A variable of a type manipulated by value contains the instance  itself.
151   * A variable of a type manipulated by handle contains a reference  to the instance.
152 The first examples of types manipulated by values are the  predefined **primitive types**: *Boolean, Character, Integer, Real*, etc. 
153
154 A variable of a type manipulated by handle which is not  attached to an object is said to be **null**. To reference an object, we  instantiate the class with one of its constructors. For example, in C++: 
155
156 ~~~~~
157 Handle(myClass)  m = new myClass; 
158 ~~~~~
159
160 In Open CASCADE Technology, the  Handles are specific classes that are used to safely manipulate objects  allocated in the dynamic memory by reference, providing reference counting  mechanism and automatic destruction of the object when it is not referenced. 
161
162
163
164 @subsubsection occt_fcug_2_1_1 Primitive Types
165
166 The primitive types are predefined in the language and they  are **manipulated by value**. 
167
168 * **Boolean** is used to represent logical  data. It may have only two values: *Standard_True*  and *Standard_False*. 
169 * **Character** designates any ASCII  character. 
170 * **ExtCharacter** is an extended character. 
171 * **Integer** is a whole number. 
172 * **Real** denotes  a real number (i.e. one with whole and a fractional part, either of which may  be null). 
173 * **ShortReal** is a real with a smaller choice of  values and memory size. 
174 * **CString** is used for literal  constants. 
175 * **ExtString** is an extended string. 
176 * **Address** represents a byte address of  undetermined size. 
177
178 The services offered by each of these types are described in  the **Standard** Package. 
179 The table below presents the equivalence existing between  C++ fundamental types and OCCT primitive types. 
180
181 **Table 1: Equivalence between C++ Types and OCCT Primitive  Types** 
182
183 | C++ Types     | OCCT Types |
184 | :--------- | :----------- |
185 | int   | Standard_Integer |
186 | double        | Standard_Real |
187 | float | Standard_ShortReal |
188 | unsigned int  | Standard_Boolean |
189 | char  | Standard_Character |
190 | short | Standard_ExtCharacter |
191 | char\*        | Standard_CString |
192 | void\*        | Standard_Address |
193 | short\*       | Standard_ExtString |
194
195 \* The types with asterisk are pointers. 
196
197 **Reminder of the classes listed above:** 
198
199 * **Standard_Integer** : fundamental type representing 32-bit integers yielding  negative, positive or null values. *Integer* is implemented as a *typedef* of the C++ *int* fundamental type. As such, the algebraic operations  +, -, *, / as well as the ordering and equivalence relations <, <=, ==, !=, >=, >  are defined on it. 
200 * **Standard_Real** : fundamental type representing real numbers with finite  precision and finite size. **Real** is implemented as a *typedef* of  the C++ *double* (double precision) fundamental type. As such, the  algebraic operations +, -, *, /, unary- and the ordering and equivalence  relations <, <=, ==, !=, >=, >  are defined on reals. 
201 * **Standard_ShortReal** : fundamental type representing real numbers with finite  precision and finite size. *ShortReal* is implemented as a *typedef* of  the C++ *float* (simple precision) fundamental type. As such, the  algebraic operations +, -, *, /, unary- and the ordering and equivalence  relations <, <=, ==, !=, >=, >  are defined on reals. 
202 * **Standard_Boolean** : fundamental type representing logical  expressions. It has two values: *false* and *true*. *Boolean* is implemented  as a *typedef* of the C++ *unsigned int* fundamental type. As such,  the algebraic operations *and, or, xor* and *not* as well as equivalence relations == and != are defined on Booleans. 
203 * **Standard_Character** : fundamental type representing the  normalized ASCII character set. It may be assigned the values of the 128 ASCII  characters. *Character* is implemented as a *typedef* of the C++ *char* fundamental type. As such, the ordering and equivalence relations <, <=, ==, !=, >=, >  are defined on characters using the order of the  ASCII chart (ex: A B). 
204 * **Standard_ExtCharacter** : fundamental type representing the  Unicode character set. It is a 16-bit character type. *ExtCharacter* is  implemented as a *typedef* of the C++ *short* fundamental type. As  such, the ordering and equivalence relations <, <=, ==, !=, >=, >   are defined on extended characters using the order of the UNICODE chart (ex:  A B). 
205 * **Standard_CString** : fundamental type representing string  literals. A string literal is a sequence of ASCII (8 bits) characters enclosed  in double quotes. *CString* is implemented as a *typedef* of the C++ *char* fundamental type. 
206 * **Standard_Address** : fundamental type representing a generic  pointer. *Address* is implemented as a *typedef* of the C++ *void* fundamental  type. 
207 * **Standard_ExtString** is a fundamental type representing string  literals as sequences of Unicode (16 bits) characters. *ExtString* is  implemented as a *typedef* of the C++ *short* fundamental type. 
208
209 @subsubsection occt_fcug_2_1_2 Types manipulated by value
210 There are three categories of types which are manipulated by  value: 
211   * Primitive types
212   * Enumerated types
213   * Types defined by classes not inheriting from *Standard_Transient*, whether directly or not.
214 Types which are manipulated by value behave in a more direct  fashion than those manipulated by handle and thus can be expected to perform  operations faster, but they cannot be stored independently in a file. 
215
216 @image html /user_guides/foundation_classes/images/foundation_classes_image005.png   "Manipulation of a data type by value"
217 @image latex /user_guides/foundation_classes/images/foundation_classes_image005.png   "Manipulation of a data type by value"
218
219 @subsubsection occt_fcug_2_1_3 Types manipulated by reference (handle)
220
221 These are types defined by classes inheriting from the *Transient* class.
222   
223 @image html /user_guides/foundation_classes/images/foundation_classes_image006.png   "Manipulation of a data type by reference"
224 @image latex /user_guides/foundation_classes/images/foundation_classes_image006.png   "Manipulation of a data type by reference"
225   
226 @subsubsection occt_fcug_2_1_4 When is it necessary to use a handle?
227
228 When you design an object, it can be difficult to choose how to manipulate that
229 object: by value or by handle. The following ideas can help you to make up your mind: 
230
231 * If your object may have a long lifetime within the application and you want to make multiple 
232 references to it, it would be preferable to manipulate this object with a handle. The memory for the 
233 object will be allocated on the heap. The handle which points to that memory is a light object which 
234 can be rapidly passed in argument. This avoids the penalty of copying a large object. 
235 * If your object will have a limited lifetime, for example, used within a single algorithm, it would 
236 be preferable to manipulate this object by value, non-regarding its size, because this object is 
237 allocated on the stack and the allocation and de-allocation of memory is extremely rapid, which 
238 avoids the implicit calls to *new* and *delete* occasioned by allocation on the heap.
239 * Finally, if an object will be created only once during, but will exist throughout the lifetime of 
240 the application, the best choice may be a class manipulated by handle or a value declared as a 
241 global variable. 
242
243
244 @subsection occt_fcug_2_2 Programming with Handles
245
246 @subsubsection occt_fcug_2_2_1 Handle Definition
247
248 A handle is OCCT implementation of a smart pointer.
249 Several handles  can reference the same object.
250 Also, a single handle may reference several  objects, but only one at a time.
251 To have access to the object it refers to, the  handle must be de-referenced just as with a C++ pointer. 
252
253 #### Organization of Classes
254
255 Class *Standard_Transient* is a root of a big hierarchy of OCCT  classes that are said to be operable by handles. It provides a reference  counter field, inherited by all its descendant classes, that is used by  associated *Handle()* classes to track a number of handles pointing to this  instance of the object. 
256
257 Objects of classes derived (directly or indirectly) from *Transient*, are normally allocated in dynamic memory using operator **new**, and manipulated by handle.
258 Handle is defined as template class *opencascade::handle<>*.
259 Open CASCADE Technology  provides preprocessor macro *Handle()* that is historically used throughout OCCT code to name a handle:
260 ~~~~~{.cpp}
261 Handle(Geom_Line) aLine; // "Handle(Geom_Line)" is expanded to "opencascade::handleL<Geom_Line>"
262 ~~~~~
263
264 In addition, for standard OCCT classes additional typedef is defined for a handle, as name of a class prefixed by *Handle_*.
265 For instance, above example can be also coded as:
266 ~~~~~{.cpp}
267 Handle_Geom_Line aLine; // "Handle_Geom_Line" is typedef to "opencascade::handleL<Geom_Line>"
268 ~~~~~
269
270 #### Using a Handle
271
272
273 A handle is characterized by the object it references. 
274
275 Before performing any operation on a transient object, you  must declare the handle. For example, if Point and Line are two transient classes  from the Geom package, you  would write: 
276 ~~~~~
277 Handle(Geom_Point)  p1, p2; 
278 ~~~~~
279 Declaring a handle creates a null handle that does not refer  to any object. The handle may be checked to be null by its method *IsNull()*. To  nullify a handle, use method *Nullify()*. 
280
281 To initialize a handle, either a new object should be  created or the value of another handle can be assigned to it, on condition that  their types are compatible. 
282
283 **Note** that handles should only be used  for object sharing. For all local operations, it is advisable to use classes  manipulated by values. 
284
285 @subsubsection occt_fcug_2_2_2 Type Management
286
287 Open CASCADE Technology provides a means to describe the hierarchy  of data types in a generic way, with a possibility to check the exact type of  the given object at run-time (similarly to C++ RTTI). 
288
289 To enable this feature, a class declaration should include declaration of OCCT RTTI.
290 Header *Standard_Type.hxx* provides two variants of preprocessor macros facilitating this:
291
292 * Inline variant, declares and defines RTTI methods by single line of code:
293 ~~~~~{.cpp}
294 #include <Geom_Surface.hxx>
295 class Appli_ExtSurface : public Geom_Surface
296 {
297 . . .
298 public:
299   DEFINE_STANDARD_RTTIEXT(Appli_ExtSurface,Geom_Surface)
300 };
301 ~~~~~
302
303 * Out-of line variant, using one macros in declaration (normally put in header file), and another for implementation (to be put in C++ source):
304
305   In *Appli_ExtSurface.hxx* file:
306 ~~~~~{.cpp}
307 #include <Geom_Surface.hxx>
308 class Appli_ExtSurface : public Geom_Surface
309 {
310 . . .
311 public:
312   DEFINE_STANDARD_RTTIEXT(Appli_ExtSurface,Geom_Surface)
313 };
314 ~~~~~
315
316    In *Appli_ExtSurface.cxx* file:
317 ~~~~~{.cpp}
318 #include <Appli_ExtSurface.hxx>
319 IMPLEMENT_STANDARD_RTTIEXT(Appli_ExtSurface,Geom_Surface)
320 ~~~~~
321
322 These macros define method *DynamicType()* that returns a type descriptor - handle to singleton instance of the class *Standard_Type* describing the class.
323 Type descriptor stores name of the class and descriptor of its parent class.
324
325 Note that while inline version is easier to use, for widely used classes this method may lead to bloating of binary code of dependent libraries, due to multiple instantiations of inline method.
326
327 To get the type descriptor for a given class type, use macros *STANDARD_TYPE()* with name of the class as argument.
328
329 Example of usage:
330 ~~~~~{.cpp}
331 if (aCurve->IsKind(STANDARD_TYPE(Geom_Line))) // equivalent to "if (dynamic_cast<Geom_Line>(aCurve.get()) != 0)"
332 {
333 ...
334 }
335 ~~~~~
336
337 #### Type Conformity
338
339 The type used in the declaration of a handle is the static  type of the object, the type seen by the compiler. A handle can reference an  object instantiated from a subclass of its static type. Thus, the dynamic type  of an object (also called the actual type of an object) can be a descendant of  the type which appears in the handle declaration through which it is  manipulated. 
340
341 Consider the class *CartesianPoint*, a  sub-class of *Point*; the rule of type conformity can be illustrated as  follows: 
342
343 ~~~~~
344 Handle (Geom_Point) p1;
345 Handle (Geom_CartesianPoint) p2;
346 p2 = new Geom_CartesianPoint;
347 p1 = p2;  // OK,  the types are compatible
348 ~~~~~
349
350
351 The compiler sees p1 as a handle to *Point* though the  actual object referenced by *p1* is of the *CartesianPoint* type. 
352
353 #### Explicit Type Conversion
354
355 According to the rule of type conformity, it is always  possible to go up the class hierarchy through successive assignments of  handles. On the other hand, assignment does not authorize you to go down the  hierarchy. Consequently, an explicit type conversion of handles is required. 
356
357 A handle can be converted explicitly into one of its  sub-types if the actual type of the referenced object is a descendant of the  object used to cast the handle. If this is not the case, the handle is  nullified (explicit type conversion is sometimes called a “safe cast”).  Consider the example below. 
358
359 ~~~~~~
360 Handle (Geom_Point) p1;
361 Handle (Geom_CartesianPoint) p2, p3;
362 p2 = new Geom_CartesianPoint;
363 p1 = p2; // OK, standard assignment
364 p3 = Handle (Geom_CartesianPoint)::DownCast (p1);
365 // OK, the actual type of p1 is CartesianPoint, although the static type of the handle is Point
366 ~~~~~~
367
368 If conversion is not compatible with the actual type of the  referenced object, the handle which was “cast” becomes null (and no exception  is raised). So, if you require reliable services defined in a sub-class of the  type seen by the handle (static type), write as follows: 
369
370 ~~~~~~
371 void MyFunction (const Handle(A) & a)
372 {
373   Handle(B) b =  Handle(B)::Downcast(a);
374   if (! b.IsNull()) {
375     // we can use “b” if class B inherits from A
376   }
377   else {
378     // the types are incompatible
379   }
380 }
381 ~~~~~~
382 Downcasting is used particularly with collections of objects  of different types; however, these objects should inherit from the same root  class. 
383
384 For example, with a sequence of transient objects *SequenceOfTransient* and two classes  A and B that both inherit from *Standard_Transient*, you get the  following syntax: 
385
386 ~~~~~
387 Handle (A) a;
388 Handle (B) b;
389 Handle (Standard_Transient) t;
390 SequenceOfTransient s;
391 a = new A;
392 s.Append (a);
393 b = new B;
394 s.Append (b);
395 t = s.Value (1);
396 // here, you cannot write:
397 // a = t; // ERROR !
398 // so you downcast:
399 a = Handle (A)::Downcast (t)
400 if (! a.IsNull()) {
401         // types are compatible, you can use a
402 }
403 else {
404        // the types are incompatible
405 }
406 ~~~~~
407
408 @subsubsection occt_fcug_2_2_3 Using  Handles to Create Objects
409
410 To create an object which is manipulated by handle, declare  the handle and initialize it with the standard C++ **new** operator,  immediately followed by a call to the constructor. The constructor can be any  of those specified in the source of the class from which the object is  instanced. 
411
412 ~~~~~
413 Handle (Geom_CartesianPoint) p;
414 p = new Geom_CartesianPoint (0, 0, 0);
415 ~~~~~
416
417 Unlike for a pointer, the **delete** operator does not  work on a handle; the referenced object is automatically destroyed when no  longer in use. 
418
419 @subsubsection occt_fcug_2_2_4 Invoking Methods
420 Once you have a handle to an object,  you can use it like a pointer in C++. To invoke a method which acts on the  referenced object, you translate this method by the standard *arrow* operator, or  alternatively, by function call syntax when this is available. 
421
422 To test or to modify the state of the handle, the method is  translated by the *dot* operator. 
423 The example below illustrates how to access the coordinates  of an (optionally initialized) point object: 
424
425 ~~~~~
426 Handle (Geom_CartesianPoint) centre;
427 Standard_Real x, y, z;
428 if (centre.IsNull()) {
429   centre = new PGeom_CartesianPoint (0, 0, 0);
430 }
431 centre->Coord(x, y, z);
432 ~~~~~
433
434 The example below illustrates how to access the type object  of a Cartesian point: 
435
436 ~~~~~
437 Handle(Standard_Transient)  p = new Geom_CartesianPoint(0.,0.,0.);
438 if ( p->DynamicType() ==  STANDARD_TYPE(Geom_CartesianPoint) )
439   cout  << ;Type check OK;  << endl; 
440 else 
441   cout << ;Type check FAILED; <<  endl;   
442 ~~~~~
443
444 *NullObject* exception will be raised if  a field or a method of an object is accessed via a *Null* handle. 
445
446 #### Invoking Class Methods
447
448 A class method is called like a static C++ function, i.e. it  is called by the name of the class of which it is a member, followed by the “::” operator and the name of the  method. 
449
450 For example, we can find the maximum degree of a Bezier curve:
451
452 ~~~~~
453 Standard_Integer  n; 
454 n = Geom_BezierCurve::MaxDegree();
455 ~~~~~
456
457 @subsubsection occt_fcug_2_2_5 Handle deallocation
458
459 Before you delete an object, you must ensure it is no longer  referenced. To reduce the programming load related to this management of object  life, the delete function in Open CASCADE Technology is secured by a **reference counter** of classes manipulated by handle. A handle automatically deletes an object when it is no  longer referenced. Normally you never call the delete operator explicitly on  instances of subclasses of *Standard_Transient*. 
460
461 When a new handle to the same object is created, the  reference counter is incremented. When the handle is destroyed, nullified, or  reassigned to another object, that counter is decremented. The object is  automatically deleted by the handle when reference counter becomes 0. 
462
463 The principle of allocation can be seen in the example  below. 
464
465 ~~~~~
466 ...
467 {
468 Handle (TColStd_HSequenceOfInteger) H1 = new TColStd_HSequenceOfInteger;
469   // H1 has one reference and corresponds to 48 bytes of  memory
470   {
471     Handle (TColStd_HSequenceOfInteger) H2;
472     H2 = H1; // H1 has two references
473     if (argc == 3) {
474       Handle (TColStd_HSequenceOfInteger) H3;
475       H3 = H1;
476       // Here, H1 has three references
477       ...
478     }
479     // Here, H1 has two references
480   }
481   // Here, H1 has 1 reference
482 }
483 // Here, H1 has no reference and the referred TColStd_HSequenceOfInteger object is deleted. 
484 ~~~~~
485
486 You can easily cast a reference to the handle object to <i> void* </i> by defining the following:
487
488 ~~~~
489     void *pointer;
490     Handle(Some_class) aHandle;
491     // Here only a pointer will be copied
492     Pointer = &aHandle;
493     // Here the Handle object will be copied
494     aHandle = * (Handle(Some_Class) *)pointer;
495 ~~~~
496
497
498 @subsubsection occt_fcug_2_2_6  Cycles
499
500 Cycles appear if two or more objects reference each other by  handles (stored as fields). In this condition automatic destruction will not work. 
501
502 Consider for example a graph, whose objects (primitives)  have to know the graph object to which they belong, i.e. a primitive must have  a reference to complete graph object. If both primitives and the graph are  manipulated by handle and they refer to each other by keeping a handle as a  field, the cycle appears.  
503
504 The graph object will not be deleted when the last handle to  it is destructed in the application, since there are handles to it stored  inside its own data structure (primitives). 
505
506 There are two approaches how to avoid such situation: 
507   * Use C++ pointer for one kind of references, e.g. from a primitive  to the graph
508   * Nullify one set of handles (e.g. handles to a graph in  primitives) when a graph object needs to be destroyed
509   
510 @subsection occt_fcug_2_3 Memory Management 
511
512 In a work session, geometric modeling  applications create and delete a considerable number of C++ objects allocated  in the dynamic memory (heap). In this context, performance of standard  functions for allocating and deallocating memory may be not sufficient. For this reason, Open CASCADE Technology employs a specialized memory manager implemented in the *Standard* package. 
513
514 The Memory Manager is based on the following principles:
515
516 * small memory arrays are grouped into clusters and then recycled (clusters are never released to the system),
517 * large arrays are allocated and de-allocated through the standard functions of the system (the arrays are released to system when they are no longer used).
518
519 As a general rule, it is advisable to allocate memory through significant blocks. In this way, the user can work with blocks of contiguous data and it facilitates memory page manager processing.
520
521 @subsubsection occt_fcug_2_3_1 Usage of Memory Manager
522
523 To  allocate memory in a C code with Open CASCADE Technology memory manager, simply use method *Standard::Allocate()* instead of  *malloc()* and method *Standard::Free()* instead of *free()*. In addition, method *Standard::Reallocate()* is provided to replace C function *realloc()*. 
524
525 In C++, operators *new()* and *delete()* for a class may be  defined so as to allocate memory using *Standard::Allocate()* and free it using  *Standard::Free()*. In that case all objects of that class and all inherited  classes will be allocated using the OCCT memory manager. 
526
527 Preprocessor macro *DEFINE_STANDARD_ALLOC* provided by header *Standard_DefineAlloc.hxx* defines *new()* and *delete()* in this way.
528 It is used for all OCCT classes (apart from a few exceptions) which thus are allocated using the OCCT memory manager. 
529 Since operators *new()* and *delete()* are inherited, this is  also true for any class derived from an OCCT class, for instance, for all  classes derived from *Standard_Transient*. 
530
531 **Note** that it is possible (though not  recommended unless really unavoidable) to redefine *new()* and *delete()* functions  for a class inheriting *Standard_Transient*. If that is done, the method  *Delete()* should be also redefined to apply operator *delete* to this pointer. This will ensure that appropriate *delete()* function will be called,  even if the object is manipulated by a handle to a base class.
532
533 @subsubsection occt_fcug_2_3_2 How to configure the Memory Manager
534
535 The OCCT memory manager may be configured to apply different  optimization techniques to different memory blocks (depending on their size),  or even to avoid any optimization and use C functions *malloc()* and *free()*  directly. 
536 The configuration is defined by numeric values of the  following environment variables: 
537   * *MMGT_OPT*: if set to 0 (default) every memory block is allocated  in C memory heap directly (via *malloc()* and *free()* functions). In this case,  all other options except for *MMGT_CLEAR* are ignored; if set to 1 the memory manager  performs optimizations as described below; if set to 2, Intel ® TBB optimized  memory manager is used.
538   * *MMGT_CLEAR*: if set to 1 (default), every allocated memory block  is cleared by zeros; if set to 0, memory block is returned as it is.
539   * *MMGT_CELLSIZE*: defines the maximal size of blocks allocated in  large pools of memory. Default is 200.
540   * *MMGT_NBPAGES*: defines the size of memory chunks allocated for  small blocks in pages (operating-system dependent). Default is 1000.
541   * *MMGT_THRESHOLD*: defines the maximal size of blocks that are  recycled internally instead of being returned to the heap. Default is 40000.
542   * *MMGT_MMAP*: when set to 1 (default), large memory blocks are  allocated using memory mapping functions of the operating system; if set to 0,  they will be allocated in the C heap by *malloc()*.
543
544 @subsubsection occt_fcug_2_3_3 Optimization Techniques
545
546 When *MMGT_OPT* is set to 1, the following optimization  techniques are used: 
547   * Small blocks with a size less than *MMGT_CELLSIZE*, are not  allocated separately. Instead, a large pools of memory are allocated (the size  of each pool is *MMGT_NBPAGES* pages). Every new memory block is arranged in a  spare place of the current pool. When the current memory pool is completely  occupied, the next one is allocated, and so on.
548   
549 In the current version memory  pools are never returned to the system (until the process finishes). However,  memory blocks that are released by the method *Standard::Free()* are remembered  in the free lists and later reused when the next block of the same size is  allocated (recycling). 
550
551   * Medium-sized blocks, with a size greater than *MMGT_CELLSIZE* but  less than *MMGT_THRESHOLD*, are allocated directly in the C heap (using *malloc()*  and *free()*). When such blocks are released by the method *Standard::Free()* they  are recycled just like small blocks.
552   
553 However, unlike small blocks, the  recycled medium blocks contained in the free lists (i.e. released by the  program but held by the memory manager) can be returned to the heap by method  *Standard::Purge()*. 
554
555   * Large blocks with a size greater than *MMGT_THRESHOLD*, including  memory pools used for small blocks, are allocated depending on the value of  *MMGT_MMAP*: if it is 0, these blocks are allocated in the C heap; otherwise they  are allocated using operating-system specific functions managing memory mapped  files. Large blocks are returned to the  system immediately when *Standard::Free()* is called. 
556
557 @subsubsection occt_fcug_2_3_4 Benefits and drawbacks
558
559 The major benefit of the OCCT memory manager is explained  by its recycling of small and medium blocks that makes an application work much  faster when it constantly allocates and frees multiple memory blocks of similar  sizes. In practical situations, the real gain on the application performance  may be up to 50%. 
560
561 The associated drawback is that recycled memory is not  returned to the operating system during program execution. This may lead to  considerable memory consumption and even be misinterpreted as a memory leak. To  minimize this effect it is necessary to call the method *Standard::Purge* after the completion  of memory-intensive operations. 
562
563 The overhead expenses induced by the OCCT memory manager  are: 
564   * size of every allocated memory block is rounded up to 8 bytes  (when *MMGT_OPT* is 0 (default), the rounding is defined by the CRT; the typical  value for 32-bit platforms is 4 bytes)
565   * additional 4 bytes (or 8 on 64-bit platforms) are allocated in  the beginning of every memory block to hold its size (or address of the next  free memory block when recycled in free list) only when *MMGT_OPT* is 1.
566   
567 Note that these overheads may be greater or less than  overheads induced by the C heap memory manager, so overall memory consumption  may be greater in either optimized or standard modes, depending on  circumstances. 
568
569 As a general rule, it is advisable to allocate memory  through significant blocks. In this way, you can work with blocks of contiguous  data, and processing is facilitated for the memory page manager. 
570
571 OCCT memory manager uses mutex to lock access to free lists, therefore it may have less  performance than non-optimized mode in situations when different threads often  make simultaneous calls to the memory manager.
572 The reason is that modern  implementations of *malloc()* and *free()* employ several allocation arenas and  thus avoid delays waiting mutex release, which are possible in such situations. 
573
574 @subsection occt_fcug_2_4 Exceptions 
575
576 @subsubsection occt_fcug_2_4_1 Introduction 
577
578 The behavior of any object is implemented by the methods,  which were defined in its class declaration. The definition of these methods  includes not only their signature (their programming interface) but also their domain of validity.  
579
580 This domain is expressed by **exceptions**. Exceptions  are raised under various error conditions to protect software quality. 
581
582 Exception handling provides a means of transferring control  from a given point in a program being executed to an **exception handler** associated  with another point previously executed. 
583
584 A method may raise an exception which interrupts its normal  execution and transfers control to the handler catching this exception. 
585
586 A hierarchy of commonly used exception classes is provided. The root class is *Standard_Failure* from the *Standard* package.  So each exception inherits from *Standard_Failure* either directly or by inheriting from another exception. Exception classes list all  exceptions, which can be raised by any OCCT function. 
587
588 Open CASCADE Technology also provides  support for converting system signals (such as access violation or division by  zero) to exceptions, so that such situations can be safely handled with the  same uniform approach. 
589  
590 However, in order to support this functionality on various  platforms, some special methods and workarounds are used. Though the  implementation details are hidden and handling of OCCT exceptions is done  basically in the same way as with C++, some peculiarities of this approach  shall be taken into account and some rules must be respected. 
591
592 The following paragraphs describe recommended approaches for  using exceptions when working with Open CASCADE Technology.  
593
594 @subsubsection occt_fcug_2_4_2 Raising  an Exception
595
596 #### “C++ like” Syntax
597
598 To raise an exception of a definite type method Raise() of  the appropriate exception class shall be used. 
599 ~~~~~
600 DomainError::Raise(“Cannot cope with this condition”);
601 ~~~~~
602 raises an exception of *DomainError* type with the associated  message “Cannot cope with this condition”, the message being optional. This  exception may be caught by a handler of a *DomainError* type as follows: 
603 ~~~~~
604 try {
605   OCC_CATCH_SIGNALS
606   // try block
607 }
608 catch(DomainError) {
609 // handle DomainError exceptions here
610 }
611 ~~~~~
612
613 #### Regular usage
614
615 Exceptions should not be used as a programming technique, to  replace a “goto” statement for example, but as a way to protect methods against  misuse. The caller must make sure its condition is such that the method can  cope with it. 
616
617 Thus, 
618   * No exception should be raised during normal execution of an  application.
619   * A method which may raise an exception should be protected by  other methods allowing the caller to check on the validity of the call.
620   
621 For example, if you consider the *TCollection_Array1* class  used with: 
622   * *Value*  function to extract an element
623   * *Lower*  function to extract the lower bound of the array
624   * *Upper*  function  to extract the upper bound of the array. 
625   
626 then, the *Value*  function may be implemented as follows: 
627
628 ~~~~~
629 Item  TCollection_Array1::Value (const Standard_Integer&index) const
630 {
631   // where r1 and r2 are  the lower and upper bounds of the array
632   if(index < r1 || index > r2) {
633     OutOfRange::Raise(“Index  out of range in Array1::Value”);
634   }
635   return contents[index];
636 }
637 ~~~~~
638
639 Here validity of the index is first verified using the Lower and Upper functions in order to protect the call. 
640 Normally the caller ensures the index being in the valid  range before calling <i>Value()</i>. In this case the above implementation of *Value* is not optimal since the  test done in *Value* is  time-consuming and redundant. 
641  
642 It is a widely used practice to include that kind of  protections in a debug build of the program and exclude in release (optimized)  build. To support this practice, the macros <i>Raise_if()</i> are provided for every OCCT  exception class: 
643 ~~~~~
644 <ErrorTypeName>_Raise_if(condition,  “Error message”); 
645 ~~~~~
646 where *ErrorTypeName* is the exception type, *condition*  is the logical expression leading to the raise of the exception, and *Error message* is the associated  message. 
647   
648 The entire call may be removed by defining one of the preprocessor symbols *No_Exception* or <i>No_<ErrorTypeName></i> at compile-time: 
649
650 ~~~~~
651 #define  No_Exception /* remove all raises */ 
652 ~~~~~
653
654 Using this syntax, the *Value* function becomes: 
655
656 ~~~~~
657 Item  TCollection_Array1::Value (const Standard_Integer&index) const
658      { 
659   OutOfRange_Raise_if(index < r1 || index > r2,
660                       “index out of range in  Array1::Value”);
661   return contents[index];
662 }
663 ~~~~~
664
665 @subsubsection occt_fcug_2_4_3 Handling  an Exception
666
667 When an exception is raised, control is transferred to the  nearest handler of a given type in the call stack, that is: 
668   * the handler whose try block was most recently entered and not yet  exited,
669   * the handler whose type matches the raise expression.
670   
671 A handler of T exception type is a match for a raise  expression with an exception type of E if: 
672   * T and E are of the same type, or
673   * T is a supertype of E.
674   
675 In order to handle system signals as exceptions, make sure  to insert macro *OCC_CATCH_SIGNALS* somewhere in the beginning of the relevant  code. The recommended location for it is first statement after opening brace of  <i>try {}</i> block. 
676
677 As an example, consider the exceptions of type *NumericError, Overflow, Underflow* and *ZeroDivide*,  where *NumericError* is the parent type of the three others. 
678
679 ~~~~~
680 void f(1)
681  {
682   try {
683     OCC_CATCH_SIGNALS
684     // try block
685   }
686   catch(Standard_Overflow) { // first handler
687     // ...
688   }
689   catch(Standard_NumericError) { // second handler
690     // ...
691   }
692 }
693 ~~~~~
694
695 Here, the first handler will catch exceptions of *Overflow* type and the second one -- exceptions of *NumericError* type and all exceptions derived from it, including *Underflow* and *ZeroDivide*. 
696
697 The handlers are checked in order of appearance, from the nearest to the try block to the most distant from it, until one matches the raise expression.  For a try block, it would be a mistake to place a handler for a base exception  type ahead of a handler for its derived type since that would ensure that the  handler for the derived exception would never be invoked.  
698
699 ~~~~~
700 void f(1)
701 {
702   int i = 0;
703   {
704     try {
705       OCC_CATCH_SIGNALS
706       g(i);// i is accessible
707     }
708     // statement here will produce compile-time errors !
709     catch(Standard_NumericError) {
710       // fix up with possible reuse of i
711     }
712     // statement here may produce unexpected side effect 
713   }
714   . . .
715 }
716 ~~~~~
717
718 The exceptions form a hierarchy tree completely separated  from other user defined classes. One exception of type *Failure* is the root of the entire exception  hierarchy. Thus, using a handler with *Failure* type catches any OCCT exception. It is recommended to set up such a handler in  the main routine.  
719
720 The main routine of a program would look like this: 
721
722 ~~~~~
723 #include <Standard_ErrorHandler.hxx>
724 #include <Standard_Failure.hxx>
725 #include <iostream.h>
726 int main (int argc, char* argv[])
727 {
728   try {
729     OCC_CATCH_SIGNALS
730     // main block
731     return 0;
732   }
733   catch(Standard_Failure) {
734     Handle(Standard_Failure) error = Standard_Failure::Caught  ();
735     cout  error  end1;
736   }
737   return 1;
738 }
739 ~~~~~
740
741 In this example function *Caught* is a static member of *Failure* that  returns an exception object containing the error message built in the raise  expression. Note that this method of accessing a raised object is used in Open  CASCADE Technology instead of usual C++ syntax (receiving the exception in  catch argument). 
742
743 Though standard C++ scoping  rules and syntax apply to try block and handlers, note that on some platforms Open  CASCADE Technology may be compiled in compatibility mode when exceptions are  emulated by long jumps (see below). In this mode it is required that no  statement precedes or follows any handler. Thus it is highly recommended to  always include a try block into additional {} braces. Also this mode requires  that header file *Standard_ErrorHandler.hxx* be included in your program before a  try block, otherwise it may fail to handle Open CASCADE Technology exceptions;  furthermore *catch()* statement does not allow passing exception object as  argument. 
744
745 #### Catching signals
746
747 In order for the application to be able to catch system  signals (access violation, division by zero, etc.) in the same way as other  exceptions, the appropriate signal handler shall be installed in the runtime by  the method *OSD::SetSignal()*.
748  
749 Normally this method is called in the beginning of the  main() function. It installs a handler that will convert system signals into OCCT  exceptions. 
750
751 In order to actually convert signals to exceptions, macro *OCC_CATCH_SIGNALS* needs to be inserted in the source code. The typical place where  this macro is put is beginning of the *try{}* block which catches such exceptions.   
752
753 @subsubsection occt_fcug_2_4_4 Implementation on various platforms. 
754
755 The exception handling mechanism in Open CASCADE Technology  is implemented in different ways depending on the preprocessor macros *NO_CXX_EXCEPTIONS*  and *OCC_CONVERT_SIGNALS*, which shall be consistently defined by compilation  procedures for both Open CASCADE Technology and user applications: 
756
757 1. On  Windows, these macros are not defined by default, and normal C++  exceptions are used in all cases, including throwing from signal handler. Thus the  behavior is as expected in C++. 
758
759 2. On  Linux, macro *OCC_CONVERT_SIGNALS* is defined by default. The C++  exception mechanism is used for catching exceptions and for throwing them from  normal code. Since it is not possible to throw C++ exception from system signal  handler function, that function makes a long jump to the nearest (in the  execution stack) invocation of macro *OCC_CATCH_SIGNALS*, and only there the C++  exception gets actually thrown. The macro *OCC_CATCH_SIGNALS* is defined in the  file *Standard_ErrorHandler.hxx*. Therefore, including this file is necessary for  successful compilation of a code containing this macro. 
760
761    This mode differs from standard  C++ exception handling only for signals:
762  
763    * macro *OCC_CATCH_SIGNALS* is necessary (besides call to  *OSD::SetSignal()* described above) for conversion of signals into exceptions;
764    * the destructors for automatic C++ objects created in the code  after that macro and till the place where signal is raised will not be called in  case of signal, since no C++ stack unwinding is performed by long jump.
765
766 3. On  Linux Open CASCADE Technology can also be compiled in compatibility  mode. In that case macro  *NO_CXX_EXCEPTIONS* is defined and the C++ exceptions are simulated with C long  jumps. As a consequence, the behavior is slightly different from that expected  in the C++ standard.  
767
768 While exception handling with  *NO_CXX_EXCEPTIONS* is very similar to C++ by syntax, it has a number of  peculiarities that should be taken into account: 
769
770 * try and catch are actually macros defined in the file *Standard_ErrorHandler.hxx*. Therefore, including this file is necessary for  handling OCCT exceptions;
771 * due to being a macro, catch cannot contain a declaration of the  exception object after its type; only type is allowed in the catch statement.  Use method *Standard_Failure::Caught()* to access an exception object;
772 * catch macro may conflict with some STL classes that might use  catch(...) statements in their header files. So STL headers should not be  included after *Standard_ErrorHandler.hxx*;
773 * Open CASCADE Technology try/catch block will not handle normal  C++ exceptions; however this can be achieved using special workarounds;
774 * the try macro defines a C++ object that holds an entry point in the  exception handler. Therefore if exception is raised by code located immediately  after the try/catch block but on the same nesting level as *try*, it may  be handled by that *catch*. This may lead to unexpected behavior,  including infinite loop. To avoid that, always surround the try/catch block with curved brackets;
775 * the destructors of C++ objects allocated on the stack after  handler initialization are not called by exception raising.
776
777 In general, for writing platform-independent code it is recommended  to insert macros *OCC_CATCH_SIGNALS* in try {} blocks or other code where signals  may happen. For compatibility with previous versions of Open CASCADE Technology  the limitations described above for *NO_CXX_EXCEPTIONS* shall be assumed. 
778
779 @subsection occt_fcug_2_5 Plug-In  Management
780
781 @subsubsection occt_fcug_2_5_1 Distribution by Plug-Ins
782
783 A plug-in is a component that can be loaded dynamically into  a client application, not requiring to be directly linked to it. The plug-in is  not bound to its client, i.e. the plug-in knows only how its connection  mechanism is defined and how to call the corresponding services. 
784
785 A plug-in can be used to: 
786   * implement the mechanism of a *driver*, i.e dynamically  changing a driver implementation according to the current transactions (for  example, retrieving a document stored in another version of an application),
787   * restrict processing resources to the minimum required (for  example, it does not load any application services at run-time as long as the  user does not need them),
788   * facilitate modular development  (an application can be  delivered with base functions while some advanced capabilities will be added as  plug-ins when they are available).
789   
790 The plug-in is identified with the help of the global  universal identifier (GUID). The GUID includes lower case characters and cannot  end with a blank space. 
791
792 Once it has been loaded, the call to the services provided  by the plug-in is direct (the client is implemented in the same language as the  plug-in). 
793
794 #### C++ Plug-In  Implementation
795
796 The C++ plug-in implements a service as an object with  functions defined in an abstract class (this abstract class and its parent  classes with the GUID are the only information about the plug-in implemented in  the client application). The plug-in consists of a sharable library including a  method named Factory which  creates the C++ object (the client cannot instantiate this object because the  plug-in implementation is not visible). 
797 Foundation classes provide in the package *Plugin* a  method named *Load()*, which enables the client to access the required service  through a library.  
798
799 That method reads the information regarding available  plug-ins and their locations from the resource file *Plugin* found by environment  variable *CSF_PluginDefaults*:
800
801 ~~~~~ 
802 $CSF_PluginDefaults/.Plugin 
803 ~~~~~
804
805 The *Load* method looks for the library name in the resource file or registry  through its GUID, for example, on UNIX:
806 ~~~~~
807 ! METADATADRIVER whose value must be OS or DM.
808
809 ! FW
810 a148e300-5740-11d1-a904-080036aaa103.Location:
811  
812 libFWOSPlugin.so
813 a148e300-5740-11d1-a904-080036aaa103.CCL:
814 /adv_44/CAS/BAG/FW-K4C/inc/FWOS.ccl
815
816 ! FWDM
817 a148e301-5740-11d1-a904-080036aaa103.Location:
818 libFWDMPlugin.so
819 a148e301-5740-11d1-a904-080036aaa103.CCL:
820 /adv_44/CAS/BAG/DESIGNMANAGER-K4C/inc/DMAccess.ccl|/
821 adv_44/CAS/BAG/DATABASE-K4C/inc/FWDMCommands.ccl
822 a148e301-5740-11d1-a904-080036aaa103.Message:  /adv_44/CAS/
823 BAG/DESIGNMANAGER-K4C/etc/locale/DMAccess
824
825 ! Copy-Paste
826 5ff7dc00-8840-11d1-b5c2-00a0c9064368.Location:
827 libCDMShapeDriversPlugin.so
828 5ff7dc01-8840-11d1-b5c2-00a0c9064368.Location:
829 libCDMShapeDriversPlugin.so
830 5ff7dc02-8840-11d1-b5c2-00a0c9064368.Location:
831 libCDMShapeDriversPlugin.so
832 5ff7dc03-8840-11d1-b5c2-00a0c9064368.Location:
833 libCDMShapeDriversPlugin.so
834 5ff7dc04-8840-11d1-b5c2-00a0c9064368.Location:
835 libCDMShapeDriversPlugin.so
836
837 ! Plugs 2d plotters:
838 d0d722a2-b4c9-11d1-b561-0000f87a4710.location: FWOSPlugin
839 d0d722a2-b4c9-11d1-b561-0000f87a4710.CCL: /adv_44/CAS/BAG/
840 VIEWERS-K4C/inc/CCLPlotters.ccl
841 d0d722a2-b4c9-11d1-b561-0000f87a4710.Message: /adv_44/CAS/
842 BAG/VIEWERS-K4C/etc/locale/CCLPlotters
843
844 !SHAPES
845 e3708f72-b1a8-11d0-91c2-080036424703.Location:
846 libBRepExchangerPlugin.so
847 e3708f72-b1a8-11d0-91c2-080036424703.CCL: /adv_44/CAS/BAG/
848 FW-K4C/inc/BRep.ccl
849 ~~~~~
850
851
852 Then the *Load* method loads the library according to the rules of the operating system  of the host machine (for example, by using environment variables such as  *LD_LIBRARY_PATH* with Unix and *PATH* with Windows). After that it invokes the *Factory*  method to return the object which supports the required service.
853 The client may then call the functions supported by this  object. 
854
855 #### C++ Client Plug-In  Implementation
856
857 To invoke one of the services provided by the plug-in, you  may call the *Plugin::ServiceFactory* global function with the *Standard_GUID* of the requested service as follows: 
858
859 ~~~~~
860 Handle(FADriver_PartStorer)::DownCast 
861 (PlugIn::ServiceFactory 
862 (PlugIn_ServiceId(yourStandardGUID))) 
863 ~~~~~
864
865 Let us take *FAFactory.cxx* as an example:
866
867 ~~~~~
868 #include <FAFactory.ixx>
869
870 #include <FADriver_PartRetriever.hxx>
871 #include <FADriver_PartStorer.hxx>
872 #include <FirstAppSchema.hxx>
873 #include <Standard_GUID.hxx>
874 #include <Standard_Failure.hxx>
875 #include <FACDM_Application.hxx>
876 #include <Plugin_Macro.hxx>
877
878 PLUGIN(FAFactory)
879
880 static Standard_GUID 
881        StorageDriver(“45b3c690-22f3-11d2-b09e-0000f8791463”);
882 static Standard_GUID 
883        RetrievalDriver(“45b3c69c-22f3-11d2-b09e-0000f8791463”);
884 static Standard_GUID 
885        Schema(“45b3c6a2-22f3-11d2-b09e-0000f8791463”);
886
887 //======================================================
888 // function : Factory
889 // purpose :
890 //======================================================
891  
892 Handle(Standard_Transient)  FAFactory::Factory(const Standard_GUID& aGUID) 
893 {
894   if(aGUID == StorageDriver) {
895     cout  “FAFactory : Create store driver”   endl;
896     static  Handle(FADriver_PartStorer) sd = new FADriver_PartStorer();
897     return sd;
898   }
899
900   if(aGUID == RetrievalDriver) {
901     cout  “FAFactory : Create retrieve driver”   endl;
902     static Handle(FADriver_PartRetriever)
903     rd = new FADriver_PartRetriever();
904     return rd;
905   }
906
907   if(aGUID == Schema) {
908     cout  “FAFactory : Create schema”   endl;
909     static Handle(FirstAppSchema) s = new  FirstAppSchema();
910     return s;
911   }
912
913   Standard_Failure::Raise(“FAFactory: unknown GUID”);
914   Handle(Standard_Transient) t;
915   return t;
916 }
917 ~~~~~
918
919 #### Without using the Software  Factory
920
921 To create a factory without using the Software Factory,  define a *dll* project under Windows or a library under UNIX by using a  source file as specified above. The *FAFactory* class is implemented as follows: 
922
923 ~~~~~
924 #include <Handle_Standard_Transient.hxx>
925 #include <Standard_Macro.hxx>
926 class Standard_Transient;
927 class Standard_GUID;
928 class FAFactory {
929 public:
930   Standard_EXPORT  static Handle_Standard_Transient
931                   Factory(const Standard_GUID& aGUID)  ;
932   . . .
933 };
934 ~~~~~
935
936
937 @section occt_fcug_3 Collections,  Strings, Quantities and Unit Conversion
938
939 @subsection occt_fcug_3_1 Collections
940
941 @subsubsection occt_fcug_3_1_1 Overview
942
943 The **Collections** component contains the classes that  handle dynamically sized aggregates of data. They include a wide range of  collections such as arrays, lists and maps. 
944
945 Collections classes are *generic* (C++ template-like), that is, they define  a structure and algorithms allowing to hold a variety of objects which do not  necessarily inherit from a unique root class (similarly to C++ templates). 
946
947 When you need to use a collection of a given type of object you must *instantiate* it for this specific type of element. Once this declaration is compiled,  all the functions available on the generic collection are available on your *instantiated  class*. 
948
949 However, note that: 
950   * Each collection directly used as an argument in OCCT public  syntax is instantiated in an OCCT component.
951   * The *TColStd* package (**Collections of Standard Objects** component)  provides numerous instantiations of these generic collections with objects from  the **Standard** package or from the **Strings** component.
952 The **Collections** component provides a wide range of  generic collections: 
953   * **Arrays** are generally used for a quick access to the item,  however an array is a fixed sized aggregate.
954   * **Sequences** are variable-sized structures, they avoid the  use of large and quasi-empty arrays. A sequence item is longer to access  than an array item: only an exploration in sequence is effective (but sequences  are not adapted for numerous explorations). Arrays and sequences are commonly  used as data structures for more complex objects.
955   * **Maps** are dynamic structures, where the size is constantly adapted to the number of inserted items and access to an item is the fastest. Maps structures are commonly used in cases of numerous explorations: they are typically internal data structures for complex algorithms.
956   * **Lists** are similar to sequences but have different algorithms to explore them. 
957   * Specific iterators for sequences and maps. 
958   
959 @subsubsection occt_fcug_3_1_2 Generic general-purpose Aggregates
960
961 #### TCollection_Array1
962
963 These are unidimensional arrays similar to C arrays, i.e. of fixed  size but dynamically dimensioned at construction time. 
964 As with a C array, the access time for an *Array1* indexed  item is constant and is independent of the array size. Arrays are commonly used  as elementary data structures for more complex objects. 
965
966 *Array1* is a generic class which depends on *Item*,  the type of element in the array. 
967
968 *Array1* indexes start and end at a user-defined  position. Thus, when accessing an item, you must base the index on the lower  and upper bounds of the array. 
969
970 #### TCollection_Array2
971
972 These are bi-dimensional arrays of fixed size but dynamically  dimensioned at construction time. 
973
974 As with a C array, the access time for an *Array2* indexed  item is constant and is independent of the array size. Arrays are commonly used  as elementary data structures for more complex objects. 
975
976 *Array2* is a generic class which depends on *Item*,  the type of element in the array. 
977
978 *Array2* indexes start and end at a user-defined  position. Thus, when accessing an item, you must base the index on the lower  and upper bounds of the array. 
979
980 #### TCollection_HArray1
981
982 These are unidimensional arrays similar to C arrays, i.e. of fixed  size but dynamically dimensioned at construction time. 
983 As with a C array, the access time for an *HArray1* or *HArray2* indexed item is constant and is independent of the array size. Arrays are  commonly used as elementary data structures for more complex objects. 
984
985 *HArray1* objects are **handles** to arrays. 
986   * *HArray1* arrays may be shared by several objects.
987   * You may use a *TCollection_Array1* structure to have the  actual array.
988   
989 *HArray1* is a generic class which depends on two parameters: 
990   * **Item**, the type of element in the array,
991   * **Array**, the actual type of array handled by *HArray1*.  This is an instantiation with **Item** of the *TCollection_Array1* generic  class.
992   
993 *HArray1* indexes start and end at a user-defined  position. Thus, when accessing an item, you must base the index on the lower  and upper bounds of the array. 
994
995 #### TCollection_HArray2
996
997 These are bi-dimensional arrays of fixed size but dynamically  dimensioned at construction time. 
998
999 As with a C array, the access time for an *HArray2* indexed  item is constant and is independent of the array size. Arrays are commonly used  as elementary data structures for more complex objects. 
1000
1001 *HArray2* objects are **handles** to arrays. 
1002   * *HArray2* arrays may be shared by several objects.
1003   * You may use a *TCollection_Array2* structure to have the  actual array.
1004   
1005 *HArray2* is a generic class which depends on two  parameters: 
1006   * *Item*, the type of element in the array,
1007   * *Array*, the actual type of array handled by *HArray2*.  This is an instantiation with *Item* of the *TCollection_Array2* generic  class.
1008   
1009 #### TCollection_HSequence
1010
1011 This is a sequence of items indexed by an integer. 
1012
1013 Sequences have about the same goal as unidimensional arrays  *TCollection_HArray1*: they are commonly used as elementary data  structures for more complex objects. But a sequence is a structure of *variable  size*: sequences avoid the use of large and quasi-empty arrays. Exploring a  sequence data structure is effective when the exploration is done in  sequence; elsewhere a sequence item is longer to read than an array item.  Note also that sequences are not effective when they have to support numerous  algorithmic explorations: a map is better for that. 
1014
1015 *HSequence* objects are **handles** to sequences. 
1016   * *HSequence* sequences may be shared by several objects.
1017   * You may use a *TCollection_Sequence* structure to have the  actual sequence.
1018   
1019 *HSequence* is a generic class which depends on two  parameters: 
1020   * *Item*, the type of element in the sequence,
1021   * *Seq*, the actual type of sequence handled by *HSequence*.  This is an instantiation with *Item* of the *TCollection_Sequence* generic  class.
1022   
1023 #### TCollection_List
1024
1025 These are ordered lists of non-unique objects which can be accessed  sequentially using an iterator. 
1026 Item insertion in a list is very fast at any position. But  searching for items by value may be slow if the list is long, because it  requires a sequential search. 
1027
1028 *List* is a generic class, which depends on *Item*,  the type of element in the structure. 
1029 Use a *ListIterator* iterator to explore a *List* structure. 
1030
1031 An iterator class is automatically instantiated from the *TCollection_ListIterator* class at the time of instantiation of a *List* structure. 
1032
1033 A sequence is a better structure when searching for items by  value. 
1034
1035 Queues and stacks are other kinds of list with a different  access to data. 
1036
1037 #### TCollection_Sequence
1038
1039 This is a sequence of items indexed by an integer. 
1040 Sequences have about the same goal as unidimensional arrays  (*TCollection_Array1*): they are commonly used as elementary data  structures for more complex objects. But a sequence is a structure of *variable  size*: sequences avoid the use of large and quasi-empty arrays. Exploring a  sequence data structure is effective when the exploration is done *in sequence*; elsewhere a sequence item is longer to read than an array item.  Note also that sequences are not effective when they have to support numerous  algorithmic explorations: a map is better for that. 
1041
1042 *Sequence* is a generic class which depends on *Item*,  the type of element in the sequence. 
1043
1044 @subsubsection occt_fcug_3_1_3 Generic Maps
1045
1046 Maps are dynamically extended data structures where data is  quickly accessed with a key. *TCollection_BasicMap* is a root class for maps. 
1047
1048 #### General properties of maps
1049
1050 Map items may contain complex non-unitary data, thus it can be difficult to manage them with an array. The map allows a data structure to be  indexed by complex data. 
1051
1052 The size of a map is dynamically extended. So a map may be  first dimensioned for a little number of items. Maps avoid the use of large and  quasi-empty arrays. 
1053
1054 The access time for a map item is much better than the one  for a sequence, list, queue or stack item. It is  comparable with the  access time for an array item. It depends on the size of the map and on the quality of the user redefinable function (the *hashing  function*) to find quickly where is the item. 
1055
1056 The performance of a map exploration may be better of an array exploration because the size of the map is adapted to the  number of inserted items. 
1057
1058 That is why maps are commonly used as  internal data structures for algorithms. 
1059
1060 #### Definitions 
1061
1062 A map is a data structure for which data are addressed by *keys*. 
1063
1064 Once inserted in the map, a map item is referenced as an *entry* of the map. 
1065
1066 Each entry of the map is addressed by a key. Two different  keys address two different entries of the map. 
1067 The position of an entry in the map is called a *bucket*. 
1068
1069 A map is dimensioned by its number of buckets, i.e. the  maximum number of entries in the map. The performance of a map is conditioned  by the number of buckets. 
1070
1071 The *hashing function* transforms a key into a bucket  index. The number of values that can be computed by the hashing function is  equal to the number of buckets of the map. 
1072
1073 Both the hashing function and the equality test between two  keys are provided by a *hasher* object. 
1074
1075 A map may be explored by a *map iterator*. This  exploration provides only inserted entries in the map (i.e. non empty buckets). 
1076
1077 #### Collections of generic maps 
1078
1079 The *Collections* component provides numerous generic  derived maps. 
1080
1081 These maps include automatic management of the number of *buckets*:  they are automatically resized when the number of *keys* exceeds the  number of buckets. If you have a fair idea of the number of items in your map,  you can save on automatic resizing by specifying a number of buckets at the  time of construction, or by using a resizing function. This may be considered  for crucial optimization issues. 
1082
1083 *Keys, items* and *hashers* are parameters of  these generic derived maps. 
1084
1085 *TCollection_MapHasher* class describes the functions  required by any *hasher*, which is to be used with a map instantiated from  the **Collections** component. 
1086
1087 An iterator class is automatically instantiated at the time  of instantiation of a map provided by the *Collections* component if this  map is to be explored with an iterator. Note that some provided generic maps  are not to be explored with an iterator but with indexes (*indexed maps*). 
1088
1089 ##### TCollection_DataMap
1090
1091 This is a map used to store keys with associated items. An entry of **DataMap** is composed of both the key and the item. 
1092 The *DataMap* can be seen as an extended array where  the keys are the indexes.
1093  
1094 *DataMap* is a generic class which depends on three  parameters: 
1095   * *Key* is the type of key for an entry in the map,
1096   * *Item* is the type of element associated with a key in the  map,
1097   * *Hasher* is the type of hasher on keys.
1098   
1099 Use a *DataMapIterator* iterator to explore a *DataMap*  map. 
1100
1101 An iterator class is automatically instantiated from the *TCollection_DataMapIterator* generic class at the time  of instantiation of a *DataMap* map. 
1102
1103 *TCollection_MapHasher* class describes the functions required for a *Hasher* object. 
1104
1105 ##### TCollection_DoubleMap
1106
1107 This is a map used to bind pairs of keys (Key1,Key2) and retrieve them in linear time. 
1108
1109 *Key1* is  referenced as the first key of the *DoubleMap* and *Key2* as the second key. 
1110
1111 An entry of a *DoubleMap* is composed of a pair of two  keys: the first key and the second key. 
1112
1113 *DoubleMap* is a generic class which depends on four  parameters: 
1114   * *Key1* is the type of the first key for an entry in the map,
1115   * *Key2* is the type of the second key for an entry in the  map,
1116   * *Hasher1* is the type of hasher on first keys,
1117   * *Hasher2* is the type of hasher on second keys.
1118   
1119 Use *DoubleMapIterator* to explore a *DoubleMap* map. 
1120
1121 An iterator class is automatically instantiated from the *TCollection_DoubleMapIterator* class at the time of instantiation of a *DoubleMap* map. 
1122
1123 *TCollection_MapHasher* class describes the functions  required for a *Hasher1* or a *Hasher2* object. 
1124
1125 ##### TCollection_IndexedDataMap
1126
1127 This is  map to store keys with associated items and to bind an  index to them. 
1128
1129 Each new key stored in the map is assigned an index. Indexes  are incremented as keys (and items) stored in the map. A key can be found by  the index, and an index can be found by the key. No key but the last can be  removed, so the indexes are in the range 1...Upper,  where *Upper* is the number of  keys stored in the map. An item is stored with each key. 
1130
1131 An entry of an *IndexedDataMap* is composed of both the  key, the item and the index. An *IndexedDataMap* is an ordered map, which  allows a linear iteration on its contents. It combines the interest: 
1132   * of an array because data may be accessed with an index,
1133   * and of a map because data may also be accessed with a key.
1134
1135 *IndexedDataMap* is a generic class which depends on  three parameters: 
1136         * *Key* is the type of key for an entry in the map,
1137         * *Item* is the type of element associated with a key in the map,
1138         * *Hasher* is the type of hasher on keys.
1139
1140 ##### TCollection_IndexedMap
1141
1142 This is map used to store keys and to bind an index to them. 
1143
1144 Each new key stored in the map is assigned an index. Indexes  are incremented as keys stored in the map. A key can be found by the index, and  an index by the key. No key but the last can be removed, so the indexes are in  the range 1...Upper where Upper is the number of keys stored  in the map. 
1145
1146 An entry of an *IndexedMap* is composed of both the key  and the index. An *IndexedMap* is an ordered map, which allows a linear  iteration on its contents. But no data is attached to the key. An *IndexedMap* is typically used by an algorithm to know if some action is still performed  on components of a complex data structure. 
1147
1148 *IndexedMap* is a generic class which depends on two  parameters: 
1149   * *Key* is the type of key for an entry in the map,
1150   * *Hasher* is the type of hasher on keys.
1151
1152 ##### TCollection_Map
1153
1154 This is a basic hashed map, used to store and retrieve keys in  linear time. 
1155
1156 An entry of a *Map* is composed of the key only. No  data is attached to the key. A *Map* is typically used by an algorithm to  know if some action is still performed on components of a complex data  structure. 
1157
1158 *Map* is a generic class which depends on two  parameters: 
1159   * *Key* is the type of key in the map,
1160   * *Hasher* is the type of hasher on keys.
1161
1162 Use a *MapIterator* iterator to explore a *Map* map. 
1163
1164 ##### TCollection_MapHasher
1165
1166 This is a hasher on the *keys* of a map instantiated from the *Collections* component. 
1167
1168 A hasher provides two functions: 
1169 * *HashCode()* function transforms a key into a bucket index in the map. The number of values that can be  computed by the hashing function is equal to the number of buckets in the map.
1170 * *IsEqual* is the equality test between two keys. Hashers are  used as parameters in generic maps provided by the **Collections** component.
1171
1172 *MapHasher* is a generic class which depends on the  type of keys, providing that *Key* is a type from the *Standard* package.  In such cases *MapHasher* may be directly instantiated with *Key*.  Note that the package *TColStd* provides some of these instantiations. 
1173
1174 Elsewhere, if *Key* is not a type from the *Standard* package  you must consider *MapHasher* as a template and build a class which  includes its functions, in order to use it as a hasher in a map instantiated  from the *Collections* component. 
1175
1176 Note that *TCollection_AsciiString* and *TCollection_ExtendedString* classes correspond to these specifications, in consequence they may be used  as hashers: when *Key* is one of these two types you may just define the  hasher as the same type at the time of instantiation of your map. 
1177
1178 @subsubsection occt_fcug_3_1_4 Iterators
1179
1180 #### TCollection_BasicMapIterator
1181
1182 This is a root class for map iterators. A map iterator provides a step  by step exploration of all the entries of a map. 
1183
1184 #### TCollection_DataMapIterator
1185
1186 These are functions used for iterating the contents of a *DataMap* map. 
1187
1188 A map is a non-ordered data structure. The order in which  entries of a map are explored by the iterator depends on its contents and  change when the map is edited. It is not recommended to modify the contents of a map during  the iteration: the result is unpredictable. 
1189
1190 #### TCollection_DoubleMapIterator
1191
1192 These are functions used for iterating the contents of a *DoubleMap* map. 
1193
1194 #### TCollection_ListIterator
1195
1196 These are unctions used for iterating the contents of a *List* data  structure. 
1197
1198 A *ListIterator* object can be used to go through a  list sequentially, and as a bookmark to hold a position in a list. It is not an  index, however. Each step of the iteration gives the current position of  the iterator, to which corresponds the current item in the list. The current  position is not defined if the list is empty, or when the exploration  is finished. 
1199
1200 An iterator class is automatically instantiated from this  generic class at the time of instantiation of a *List* data structure. 
1201
1202 #### TCollection_MapIterator
1203
1204 These are functions used for iterating the contents of a *Map* map. 
1205 An iterator class is automatically instantiated from this  generic class at the time of instantiation of a *Map* map. 
1206
1207 #### TCollection_SetIterator
1208
1209 These are functions used for iterating the contents of a *Set* data  structure. 
1210 An iterator class is automatically instantiated from this  generic class at the time of instantiation of a *Set* structure. 
1211
1212 #### TCollection_StackIterator
1213
1214 These are functions used for iterating the contents of a **Stack** data  structure. 
1215
1216 An iterator class is automatically instantiated from this  generic class at the time of instantiation of a *Stack* structure. 
1217
1218 @subsection occt_fcug_3_2 Collections of Standard Objects
1219 @subsubsection occt_fcug_3_2_1 Overview
1220 While generic classes of the *TCollection* package are the  root classes that describe the generic purpose of every type of collection, classes effectively used are extracted from the *TColStd* package. 
1221 The *TColStd* and *TShort* packages provide  frequently used instantiations of generic classes with objects from the *Standard* package or strings from the *TCollection* package. 
1222
1223 @subsubsection occt_fcug_3_2_2 Description
1224 These instantiations are the following: 
1225   * Unidimensional arrays: instantiations of the *TCollection_Array1* generic class with *Standard* Objects and *TCollection* strings.
1226   * Bidimensional arrays: instantiations of the *TCollection_Array2* generic class with *Standard* Objects.
1227   * Unidimensional arrays manipulated by handles: instantiations of  the *TCollection_HArray1* generic class with *Standard* Objects and *TCollection* strings.
1228   * Bidimensional arrays manipulated by handles: instantiations of  the *TCollection_HArray2* generic class with *Standard* Objects.
1229   * Sequences: instantiations of the *TCollection_Sequence* generic  class with *Standard* objects and *TCollection* strings.
1230   * Sequences manipulated by handles: instantiations of the *TCollection_HSequence* generic class with *Standard* objects and *TCollection* strings.
1231   * Lists: instantiations of the *TCollection_List* generic  class with *Standard* objects.
1232   * Queues: instantiations of the *TCollection_Queue* generic  class with *Standard* objects.
1233   * Sets: instantiations of the *TCollection_Set* generic class  with *Standard* objects.
1234   * Sets manipulated by handles: instantiations of the *TCollection_HSet* generic class with *Standard* objects.
1235   * Stacks: instantiations of the *TCollection_Stack* generic  class with *Standard* objects.
1236   * Hashers on map keys: instantiations of the *TCollection_MapHasher* generic class with *Standard* objects.
1237   * Basic hashed maps: instantiations of the *TCollection_Map* generic  class with *Standard* objects.
1238   * Hashed maps with an additional item: instantiations of the *TCollection_DataMap* generic class with *Standard* objects.
1239   * Basic indexed maps: instantiations of the *TCollection_IndexedMap* generic class with *Standard* objects.
1240   * Indexed maps with an additional item: instantiations of the *TCollection_IndexedDataMap* generic class with *Standard_Transient* objects.
1241   * Class *TColStd_PackedMapOfInteger* provides alternative  implementation of map of integer numbers, optimized for both performance and  memory usage (it uses bit flags to encode integers, which results in spending  only 24 bytes per 32 integers stored in optimal case). This class also provides  Boolean operations with maps as sets of integers (union, intersection,  subtraction, difference, checks for equality and containment).
1242   
1243 @subsection occt_fcug_3_3 NCollections
1244 @subsubsection occt_fcug_3_3_1 Overview  
1245   
1246 The *NCollection* package provides a set of template collection classes used throughout OCCT.
1247
1248 Macro definitions of these classes are stored in *NCollection_Define\*.hxx* files. These definitions are now obsolete though still can be used, particularly for compatibility with the existing code.
1249
1250 @subsubsection occt_fcug_3_3_2 Instantiation of collection classes
1251
1252 Now we are going to implement the definitions from *NCollection* in the code, taking as an example a sequence of points (analogue of *TColgp_SequenceOfPnt*).
1253   
1254 #### Definition of a new collection class
1255
1256 Let the header file be *MyPackage_SequenceOfPnt.hxx* :
1257
1258 Template class instantiaton
1259 ~~~~~
1260 #include <NCollection_Sequence.hxx>
1261 #include <gp_Pnt.hxx>
1262 typedef NCollection_Sequence<gp_Pnt> MyPackage_SequenceOfPnt;
1263 ~~~~~
1264
1265 Macro instantiation
1266 ~~~~~
1267 #include <NCollection_DefineSequence.hxx>
1268 #include <gp_Pnt.hxx>
1269 ~~~~~
1270
1271 The following line defines the class "base collection of points"
1272 ~~~~~
1273 DEFINE_BASECOLLECTION(MyPackage_BaseCollPnt, gp_Pnt)
1274 ~~~~~
1275
1276 The following line defines the class *MyPackage_SequenceOfPnt*
1277
1278 ~~~~~
1279 DEFINE_SEQUENCE (MyPackage_SequenceOfPnt, MyPackage_BaseCollPnt , gp_Pnt)  
1280 ~~~~~
1281
1282 #### Definition of a new collection class managed by Handle
1283
1284 It is necessary to provide relevant statements both in the header ( .hxx file) and the C++ source ( .cxx file). 
1285
1286 Header file MyPackage_HSequenceOfPnt.hxx:
1287
1288 ~~~~~
1289 #include <NCollection_DefineHSequence.hxx>
1290 #include <gp_Pnt.hxx>
1291 ~~~~~
1292
1293 The following line defines the class "base collection of points"
1294
1295 ~~~~~
1296 DEFINE_BASECOLLECTION(MyPackage_BaseCollPnt, gp_Pnt)
1297 ~~~~~
1298
1299 The following line defines the class *MyPackage_SequenceOfPnt*
1300
1301 ~~~~~
1302 DEFINE_SEQUENCE (MyPackage_SequenceOfPnt, MyPackage_BaseCollPnt, gp_Pnt)
1303 ~~~~~
1304
1305 The following line defines the classes *MyPackage_HSequenceOfPnt* and *Handle(MyPackage_HSequenceOfPnt)*
1306
1307 ~~~~~
1308 DEFINE_HSEQUENCE (MyPackage_HSequenceOfPnt, MyPackage_SequenceOfPnt)
1309 ~~~~~
1310
1311 Source code file will be *MyPackage_HSequenceOfPnt.cxx* or any other .cxx file (once in the whole project):
1312
1313 ~~~~~
1314 IMPLEMENT_HSEQUENCE (MyPackage_HSequenceOfPnt)
1315 ~~~~~
1316
1317 @subsubsection occt_fcug_3_3_3 Arrays and sequences
1318
1319 Standard collections provided by OCCT are:
1320 * *NCollection_Array1* - fixed-size (at initialization) one-dimensional array; note that index can start at any value, usually 1
1321 * *NCollection_Array2* - fixed-size (at initialization) two-dimensional array; note that index can start at any value, usually 1
1322 * *NCollection_List* - plain list
1323 * *NCollection_Sequence* - double-connected list with access by index; note that index starts at 1
1324
1325 These classes provide STL-style iterators (methods begin() and end()) and thus can be used in STL algorithms.
1326
1327 @subsubsection occt_fcug_3_3_3x Maps
1328
1329 NCollection provides several classes for storage of objects by value, providing fast search due to use of hash:
1330 * *NCollection_Map* - hash set
1331 * *NCollection_IndexedMap* - set with prefixed order of elements, allowing fast access by index or by value (hash-based)
1332 * *NCollection_DataMap* - hash map
1333 * *NCollection_IndexedDataMap* - map with prefixed order of elements, allowing fast access by index or by value (hash-based)
1334 * *NCollection_DoubleMap* - two-side hash map (with two keys)
1335
1336 @subsubsection occt_fcug_3_3_4 Other collection types
1337
1338 There are 4 collection types provided as template classes:
1339 * *NCollection_Vector*
1340 * *NCollection_UBTree*
1341 * *NCollection_SparseArray*
1342 * *NCollection_CellFilter*
1343
1344 #### Vector
1345
1346 This type is implemented internally as a list of arrays of the same size. Its properties:
1347 * Direct (constant-time) access to members like in Array1 type; data are allocated in compact blocks, this provides faster iteration.
1348 * Can grow without limits, like List, Stack or Queue types.
1349 * Once having the size LEN, it cannot be reduced to any size less than LEN -- there is no operation of removal of items.
1350
1351 Insertion in a Vector-type class is made by two methods:
1352 * _SetValue(ind, theValue)_ -- array-type insertion, where ind is the index of the inserted item, can be any non-negative number. If it is greater than or equal to Length(), then the vector is enlarged (its Length() grows).
1353 * _Append(theValue)_ -- list-type insertion equivalent to _myVec.SetValue(myVec.Length(), theValue)_, incrementing the size of the collection.
1354
1355 Other essential properties coming from List and Array1 type collections:
1356 * Like in *List*, the method *Clear()* destroys all contained objects and releases the allocated memory.
1357 * Like in *Array1*, the methods *Value()* and *ChangeValue()* return a contained object by index. Also, these methods have the form of overloaded operator ().
1358
1359 #### UBTree
1360
1361 The name of this type stands for “Unbalanced Binary Tree”. It stores the members in a binary tree of overlapped bounding objects (boxes or else).
1362 Once the tree of boxes of geometric objects is constructed, the algorithm is capable of fast geometric selection of objects. The tree can be easily updated by adding to it a new object with bounding box. 
1363 The time of adding to the tree of one object is O(log(N)), where N is the total number of objects, so the time of building a tree of N objects is O(N(log(N)). The search time of one object is O(log(N)). 
1364
1365 Defining various classes inheriting *NCollection_UBTree::Selector* we can perform various kinds of selection over the same b-tree object.  
1366
1367 The object may be of any type allowing copying. Among the best suitable solutions there can be a pointer to an object, handled object or integer index of object inside some collection. The bounding object may have any dimension and geometry. The minimal interface of *TheBndType* (besides public empty and copy constructor and operator =) used in UBTree algorithm as follows: 
1368
1369 ~~~~~
1370    class MyBndType
1371    {
1372     public:
1373      inline void                   Add (const MyBndType& other);
1374      // Updates me with other bounding type instance
1375
1376      inline Standard_Boolean       IsOut (const MyBndType& other) const;
1377      // Classifies other bounding type instance relatively me
1378
1379      inline Standard_Real          SquareExtent() const;
1380      // Computes the squared maximal linear extent of me (for a box it is the squared diagonal of the box).
1381    };
1382 ~~~~~
1383    
1384
1385 This interface is implemented in types of Bnd package: *Bnd_Box, Bnd_Box2d, Bnd_B2x, Bnd_B3x*.
1386
1387 To select objects you need to define a class derived from *UBTree::Selector* that should redefine the necessary virtual methods to maintain the selection condition. Usually this class instance is also used to retrieve selected objects after search.
1388 The class *UBTreeFiller* is used to randomly populate a *UBTree* instance. The quality of a tree is better (considering the speed of searches) if objects are added to it in a random order trying to avoid the addition of a chain of nearby objects one following another. 
1389 Instantiation of *UBTreeFiller* collects objects to be added, and then adds them at once to the given UBTree instance in a random order using the Fisher-Yates algorithm.
1390 Below is the sample code that creates an instance of *NCollection_UBTree* indexed by 2D boxes (Bnd_B2f), then a selection is performed returning the objects whose bounding boxes contain the given 2D point.
1391
1392 ~~~~~
1393 typedef NCollection_UBTree<MyData, Bnd_B2f> UBTree;
1394 typedef NCollection_List<MyData> ListOfSelected;
1395 //! Tree Selector type
1396 class MyTreeSelector : public UBTree::Selector
1397 {
1398 public:
1399   // This constructor initializes the selection criterion (e.g., a point)
1400
1401   MyTreeSelector (const gp_XY& thePnt) : myPnt(thePnt) {}
1402   // Get the list of selected objects
1403
1404   const ListOfSelected& ListAccepted () const
1405   { return myList; }
1406   // Bounding box rejection - definition of virtual method.  @return True if theBox is outside the selection criterion.
1407
1408   Standard_Boolean Reject  (const Bnd_B2f& theBox) const
1409   { return theBox.IsOut(myPnt); }
1410   // Redefined from the base class. Called when the bounding of theData conforms to the selection criterion. This method updates myList.
1411
1412   Standard_Boolean Accept  (const MyData& theData)
1413   { myList.Append(theData); }
1414   private:
1415   gp_XY          myPnt;
1416   ListOfSelected myList;
1417 };
1418 . . .
1419 // Create a UBTree instance and fill it with data, each data item having the corresponding 2D box.
1420
1421 UBTree aTree;
1422 NCollection_UBTreeFiller <MyData, Bnd_B2f> aTreeFiller(aTree);
1423 for(;;) {
1424   const MyData& aData = …;
1425   const Bnd_B2d& aBox = aData.GetBox();
1426   aTreeFiller.Add(aData, aBox);
1427 }
1428 aTreeFiller.Fill();
1429 . . .
1430 // Perform selection based on ‘aPoint2d’
1431 MyTreeSelector aSel(aPoint2d);
1432 aTree.Select(aSel);
1433 const ListOfSelected = aSel.ListAccepted();
1434 ~~~~~
1435
1436
1437 #### SparseArray
1438
1439
1440 This type has almost the same features as Vector but it allows to store items having scattered indices. In Vector, if you set an item with index 1000000, the container will allocate memory for all items with indices in the range 0-1000000. In SparseArray, only one small block of items will be reserved that contains the item with index 1000000.
1441
1442 This class can be also seen as equivalence of *DataMap<int,TheItemType>* with the only one practical difference: it can be much less memory-expensive if items are small (e.g. Integer or Handle). 
1443
1444 This type has both interfaces of DataMap and Vector to access items.
1445
1446 #### CellFilter
1447
1448 This class represents a data structure for sorting geometric objects in n-dimensional space into cells, with associated algorithm for fast checking of coincidence (overlapping, intersection, etc.) with other objects. It can be considered as a functional alternative to UBTree, as in the best case it provides the direct access to an object like in an n-dimensional array, while search with UBTree provides logarithmic law access time.
1449
1450 @subsubsection occt_fcug_3_3_5 Features
1451
1452 NCollection defines some specific features, in addition to the public API inherited from TCollection classes. 
1453
1454 #### Iterators
1455
1456 Every collection defines its Iterator class capable of iterating the members in some predefined order. Every Iterator is defined as a subtype of the particular collection type (e.g., MyPackage_StackOfPnt::Iterator ). The order of iteration is defined by a particular collection type. The methods of Iterator are: 
1457
1458 * _void Init (const MyCollection&)_ -- initializes the iterator on the collection object;
1459 * _Standard_Boolean More () const_ -- makes a query if there is another non-iterated member;
1460 * _void Next ()_ -- increments the iterator; 
1461 * _const ItemType& Value () const_ -- returns the current member; 
1462 * _ItemType& ChangeValue () const_ -- returns the mutable current member
1463
1464 ~~~~~
1465 typedef Ncollection_Sequence<gp_Pnt>
1466 MyPackage_SequenceOfPnt
1467 void Perform (const MyPackage_SequenceOfPnt& theSequence)
1468 {
1469         MyPackage_SequenceOfPnt::Iterator anIter (theSequence);
1470         for (; anIter.More(); anIter.Next()) {
1471                 const gp_Pnt aPnt& = anIter.Value();
1472 ....
1473         }
1474 }
1475 ~~~~~
1476
1477 This feature is present only for some classes in *TCollection (Stack, List, Set, Map, DataMap, DoubleMap)*. In *NCollection* it is generalized. 
1478
1479
1480 #### Class BaseCollection
1481
1482 There is a common abstract base class for all collections for a given item type (e.g., gp_Pnt). Developer X can arbitrarily name this base class like *MyPackage_BaseCollPnt* in the examples above. This name is further used in the declarations of any (non-abstract) collection class to designate the C++ inheritance. 
1483
1484 This base class has the following public API:
1485 * abstract class Iterator as the base class for all Iterators descried above; 
1486 * _Iterator& CreateIterator () const_ -- creates and returns the Iterator on this collection;
1487 * _Standard_Integer Size () const_ -- returns the number of items in this collection;
1488 * *void Assign (const NCollection_BaseCollection& theOther)* -- copies the contents of the Other to this collection object; 
1489
1490 These members enable accessing any collection without knowing its exact type. In particular, it makes possible to implement methods receiving objects of the abstract collection type: 
1491
1492 ~~~~~
1493 #include <NColection_Map.hxx>
1494 typedef NCollection_Map<gp_Pnt> MyPackage_MapOfPnt;
1495 typedef NCollection_BaseCollection<gp_Pnt> MyPackage_BaseCollPnt;
1496 MyPackage_MapOfPnt aMapPnt;
1497 ....
1498 gp_Pnt aResult = COG (aMapPnt);
1499 ....
1500 gp_Pnt COG(const MyPackage_BaseCollPnt& theColl)
1501 {
1502   gp_XYZ aCentreOfGravity(0., 0., 0.);
1503 // create type-independent iterator (it is abstract type instance)
1504   MyPackage_BaseCollString::Iterator& anIter = theColl.CreateIterator();
1505   for (; anIter.More(); anIter.Next()) {
1506     aCentreOfGravity += anIter.Value().XYZ();
1507   }
1508   return aCentreOfGravity / theColl.Size();
1509 }
1510 ~~~~~
1511
1512 Note that there are fundamental differences between the shown type-independent iterator and the iterator belonging to a particular non-abstract collection:
1513 * Type-independent iterator can only be obtained via the call <i>CreateIterator()</i>; the typed iterator -- only via the explicit construction. 
1514 * Type-independent iterator is an abstract class, so it is impossible to copy it or to assign it to another collection object; the typed iterators can be copied and reassigned using the method <i>Init()</i>. 
1515 * Type-independent iterator is actually destroyed when its collection object is destroyed; the typed iterator is destroyed as any other C++ object in the corresponding C++ scope. 
1516
1517 The common point between them is that it is possible to create any number of both types of iterators on the same collection object. 
1518
1519 #### Heterogeneous Assign
1520
1521 The semantics of the method *Assign()* has been changed in comparison to *TCollection*. In *NCollection* classes the method *Assign()* is virtual and it receives the object of the abstract *BaseCollection* class (see the previous section). Therefore this method can be used to assign any collection type to any other if only these collections are instantiated on the same *ItemType*. 
1522
1523 For example, conversion of *Map* into *Array1* is performed like this:
1524
1525 ~~~~~
1526 #include <NCollection_Map.hxx>
1527 #include <NCollection_Array1.hxx>
1528 typedef NCollection_Map<gp_Pnt> MyPackage_MapOfPnt;
1529 typedef NCollection_Array1<gp_Pnt> MyPackage_Array1OfPnt;
1530 ....
1531 MyPackage_MapOfPnt aMapPnt;
1532 ....
1533 MyPackage_Array1OfPnt anArr1Pnt (1, aMapPnt.Size());
1534 anArr1Pnt.Assign (aMapPnt); // heterogeneous assignment
1535 ~~~~~
1536
1537 There are some aspects to mention:
1538 * Unlike in *TCollection*, in *NCollection* the methods *Assign* and operator= do not coincide. The former is a virtual method defined in the *BaseCollection* class. The latter is always defined in instance classes as a non-virtual inline method and it corresponds exactly to the method *Assign* in *TCollection* classes. Therefore it is always profitable to use operator= instead of *Assign* wherever the types on both sides of assignment are known. 
1539 * If the method *Assign* copies to *Array1* or *Array2* structure, it first checks if the size of the array is equal to the number of items in the copied collection object. If the sizes differ, an exception is thrown, as in *TCollection_Array1.gxx*. 
1540 * Copying to *Map, IndexedMap, DataMap* and *IndexedDataMap* can bring about a loss of data: when two or more copied data items have the same key value, only one item is copied and the others are discarded. It can lead to an error in the code like the following:
1541
1542 ~~~~~
1543 MyPackage_Array1OfPnt anArr1Pnt (1, 100); 
1544 MyPackage_MapOfPnt aMapPnt;
1545 ....
1546 aMapPnt.Assign(anArr1Pnt);
1547 anArr1Pnt.Assign(aMapPnt);
1548 ~~~~~
1549
1550 Objects of classes parameterised with two types (*DoubleMap, DataMap* and  *IndexedDataMap*) cannot be assigned. Their method *Assign* throws the exception *Standard_TypeMismatch* (because it is impossible to check if the passed *BaseCollection* parameter belongs to the same collection type).
1551
1552 #### Allocator
1553
1554 All constructors of *NCollection* classes receive the *Allocator* Object as the last parameter. This is an object of a type managed by Handle, inheriting *NCollection_BaseAllocator*, with the following (mandatory) methods redefined:
1555
1556 ~~~~~
1557 Standard_EXPORT virtual void* Allocate (const size_t size); 
1558 Standard_EXPORT virtual void Free (void * anAddress);
1559 ~~~~~
1560
1561 It is used internally every time when the collection allocates memory for its item(s) and releases this memory. The default value of this parameter (empty *Handle*) designates the use of *NCollection_BaseAllocator* X where the functions *Standard::Allocate* and *Standard::Free* are called. Therefore if the user of *NCollection* does not specify any allocator as a parameter to the constructor of his collection, the memory management will be identical to the one in *TCollection* and other Open CASCADE Technology classes.
1562
1563 Nevertheless, the it is possible to define a custom *Allocator* type to manage the memory in the most optimal or convenient way for his algorithms.
1564
1565 As one possible choice, the class *NCollection_IncAllocator* is included. Unlike *BaseAllocator*, it owns all memory it allocates from the system. Memory is allocated in big blocks (about 20kB) and the allocator keeps track of the amount of occupied memory. The method *Allocate* just increments the pointer to non-occupied memory and returns its previous value. Memory is only released in the destructor of *IncAllocator*, the method *Free* is empty. If used efficiently, this Allocator can greatly improve the performance of OCCT collections.
1566
1567
1568
1569 @subsection occt_fcug_3_4 Strings
1570
1571 Strings are classes that handle dynamically sized sequences of characters based on
1572 ASCII/Unicode UTF-8 (normal 8-bit character type) and UTF-16/UCS-2 (16-bit character type). They provide editing operations with built-in memory management which make the relative objects easier to use than ordinary character arrays.
1573
1574 String classes provide the following services to manipulate character strings:
1575  * Editing operations on string objects, using a built-in string manager 
1576  * Handling of dynamically-sized sequences of characters 
1577  * Conversion from/to ASCII and UTF-8 strings. 
1578
1579 Strings may also be manipulated by handles and therefore shared.
1580
1581 @subsubsection occt_fcug_3_4_1 Examples
1582
1583 #### TCollection_AsciiString
1584
1585 A variable-length sequence of ASCII characters (normal 8-bit  character type). It provides editing operations with built-in memory management  to make *AsciiString* objects easier to use than ordinary character  arrays. 
1586 *AsciiString* objects follow value  semantics;, that is, they are the actual strings, not handles to strings,  and are copied through assignment. You may use *HAsciiString* objects to  get handles to strings. 
1587
1588 #### TCollection_ExtendedString
1589
1590 A variable-length sequence of "extended" (UNICODE)  characters (16-bit character type). It provides editing operations with  built-in memory management to make *ExtendedString* objects easier to use  than ordinary extended character arrays. 
1591
1592 *ExtendedString* objects follow value  semantics;, that is, they are the actual strings, not handles to strings,  and are copied through assignment. You may use *HExtendedString* objects  to get handles to strings. 
1593
1594 #### TCollection_HAsciiString
1595
1596 A variable-length sequence of ASCII characters (normal 8-bit  character type). It provides editing operations with built-in memory management  to make *HAsciiString* objects easier to use than ordinary character  arrays. 
1597 *HAsciiString* objects are *handles* to strings. 
1598   * *HAsciiString* strings may be shared by several objects.
1599   * You may use an *AsciiString* object to get the actual  string.
1600 *HAsciiString* objects use an *AsciiString* string  as a field. 
1601
1602 #### TCollection_HExtendedString
1603
1604 A variable-length sequence of extended; (UNICODE)  characters (16-bit character type). It provides editing operations with  built-in memory management to make *ExtendedString* objects easier to use  than ordinary extended character arrays. 
1605 *HExtendedString* objects are *handles* to  strings. 
1606   * *HExtendedString* strings may be shared by several objects.
1607   * You may use an *ExtendedString* object to get the actual  string.
1608 *HExtendedString* objects use an *ExtendedString* string  as a field. 
1609
1610 @subsubsection occt_fcug_3_4_2 Conversion
1611
1612 *Resource_Unicode* provides functions to convert a non-ASCII *C string* given  in ANSI, EUC, GB or SJIS format, to a Unicode string of extended characters, and vice  versa. 
1613
1614 @subsection occt_fcug_3_5 Quantities
1615
1616 Quantities are various classes supporting date and time information and fundamental types representing most physical quantities such as  length, area, volume, mass, density, weight, temperature, pressure etc. 
1617
1618 Quantity classes provide the following services:
1619   * Definition of primitive types representing most of mathematical and physical quantities;
1620   * Unit conversion tools providing a uniform mechanism for dealing  with quantities and associated physical units: check unit compatibility, perform conversions of values between different units, etc. (see package  *UnitsAPI*)    
1621   * Resources to manage time information such as dates and time periods 
1622   * Resources to manage color definition 
1623
1624 A mathematical quantity is characterized by the name and the value (real).
1625
1626 A physical quantity is characterized by the name, the value (real) and the unit. The unit may be either an international unit complying with the International Unit System (SI) or a user defined unit. The unit is managed by the physical quantity user.
1627
1628 The fact that both physical and mathematical quantities are manipulated as real values means that :
1629   * They are defined as aliases of real values, so all functions provided by the <i>Standard_Real</i> class are available on each quantity.
1630   * It is possible to mix several physical quantities in a mathematical or physical formula involving real values.
1631
1632 <i>Quantity</i> package includes all commonly used basic physical quantities. 
1633
1634 @subsection occt_fcug_3_6 Unit Conversion
1635
1636 The *UnitsAPI* global functions are used to convert a  value from any unit into another unit. Conversion is executed among three unit  systems: 
1637   * the **SI System**,
1638   * the user’s **Local System**,
1639   * the user’s **Current System**.
1640 The **SI System** is the standard international unit  system. It is indicated by *SI* in the signatures of the *UnitsAPI* functions. 
1641
1642 The OCCT (former MDTV) System corresponds to the SI  international standard but the length unit and all its derivatives use the millimeter instead of the meter.  
1643
1644 Both systems are proposed by Open CASCADE Technology; the SI  System is the standard option. By selecting one of these two systems, you  define your **Local System** through the *SetLocalSystem* function. The  **Local System** is indicated by *LS* in the signatures of the *UnitsAPI* functions. 
1645 The Local System units can be modified in the working  environment. You define your **Current System** by modifying its units  through the *SetCurrentUnit* function. The Current System is indicated by *Current* in the signatures of the *UnitsAPI* functions. 
1646 A physical quantity is defined by a string (example:  LENGTH). 
1647
1648
1649 @section occt_occt_fcug_4 Math Primitives and Algorithms
1650
1651 @subsection occt_occt_fcug_4_1 Overview
1652
1653 Math primitives and algorithms available in Open CASCADE  Technology include: 
1654   * Vectors and matrices
1655   * Geometric primitives
1656   * Math algorithms
1657   
1658 @subsection occt_occt_fcug_4_2 Vectors and Matrices
1659
1660 The Vectors and Matrices component provides a C++  implementation of the fundamental types *Vector* and *Matrix*, which are regularly used to define more complex data structures. 
1661
1662 The <i> Vector</i> and <i> Matrix </i> classes provide commonly used mathematical algorithms which
1663 include:
1664
1665   * Basic calculations involving vectors and matrices; 
1666   * Computation of eigenvalues and eigenvectors of a square matrix; 
1667   * Solvers for a set of linear algebraic equations; 
1668   * Algorithms to find the roots of a set of non-linear equations; 
1669   * Algorithms to find the minimum function of one or more independent variables. 
1670
1671 These classes also provide a data structure to represent any expression,
1672 relation, or function used in mathematics, including the assignment of variables.
1673
1674 Vectors and matrices have arbitrary ranges which must be defined at declaration time
1675 and cannot be changed after declaration.
1676
1677 ~~~~~
1678 math_Vector  v(1, 3); 
1679 //  a vector of dimension 3 with range (1..3) 
1680 math_Matrix  m(0, 2, 0, 2); 
1681 //  a matrix of dimension 3x3 with range (0..2, 0..2) 
1682 math_Vector  v(N1, N2); 
1683 //  a vector of dimension N2-N1+1 with range (N1..N2)
1684 ~~~~~
1685
1686 Vector and Matrix objects use value semantics. In other  words, they cannot be shared and are copied through assignment. 
1687
1688 ~~~~~
1689 math_Vector  v1(1, 3), v2(0, 2); 
1690 v2  = v1; 
1691 //  v1 is copied into v2. a modification of v1 does not affect  v2 
1692 ~~~~~
1693
1694 Vector and Matrix values may be initialized and obtained  using indexes which must lie within the range definition of the vector or the  matrix. 
1695
1696 ~~~~~
1697 math_Vector v(1, 3);
1698 math_Matrix m(1, 3, 1, 3);
1699 Standard_Real value;
1700
1701 v(2) = 1.0;
1702 value = v(1);
1703 m(1, 3) = 1.0;
1704 value = m(2, 2);
1705 ~~~~~
1706
1707 Some operations on Vector and Matrix objects may not be  legal. In this case an exception is raised. Two standard exceptions are used: 
1708   * *Standard_DimensionError* exception is raised when two matrices or  vectors involved in an operation are of incompatible dimensions.
1709   * *Standard_RangeError* exception is raised if an access outside the  range definition of a vector or of a matrix is attempted.
1710   
1711 ~~~~~~
1712 math_Vector v1(1, 3), v2(1, 2), v3(0, 2);
1713 v1 = v2;
1714 // error: Standard_DimensionError is raised
1715
1716 v1 = v3;
1717 // OK: ranges are not equal but dimensions are
1718 // compatible
1719
1720 v1(0) = 2.0;
1721 // error: Standard_RangeError is raised
1722 ~~~~~~
1723
1724 @subsection occt_occt_fcug_4_3 Primitive Geometric Types
1725
1726 Open CASCADE Technology primitive geometric types are a  STEP-compliant implementation of basic geometric and algebraic entities.  
1727 They provide: 
1728   * Descriptions of primitive geometric shapes, such as:
1729           * Points; 
1730           * Vectors; 
1731           * Lines; 
1732           * Circles and conics; 
1733           * Planes and elementary surfaces;
1734   * Positioning of these shapes in space or in a plane by means of an axis or a coordinate system;
1735   * Definition and application of geometric transformations to these shapes:
1736           * Translations; 
1737           * Rotations; 
1738           * Symmetries; 
1739           * Scaling transformations; 
1740           * Composed transformations;
1741   * Tools (coordinates and matrices) for algebraic computation.
1742   
1743 All these functions are provided by geometric processor package <i> gp</i>. Its classes for 2d and 3d objects are handled by value rather than by reference. When this sort of object is copied, it is copied entirely. Changes in one instance will not be  reflected in another. 
1744
1745 The *gp* package defines the basic geometric entities used for algebraic calculation and basic analytical geometry  in 2d & 3d space. It also provides basic transformations such as identity,  rotation, translation, mirroring, scale transformations, combinations of  transformations, etc. Entities are handled by value.  
1746
1747 Please, note that <i> gp</i> curves and surfaces are analytic: there is no parameterization and no orientation on <i>gp</i> entities, i.e. these entities do not provide functions which work with these properties. 
1748
1749 If you need, you may use more evolved data structures provided by <i> Geom</i> (in 3D space) and <i> Geom2d</i> (in the plane). However, the definition of <i> gp</i> entities is identical to the one of equivalent <i> Geom</i> and <i> Geom2d</i> entities, and they are located in the plane or in space with the same kind of positioning systems. They implicitly contain the orientation, which they express on the <i> Geom </i> and <i> Geom2d </i> entities, and they induce the definition of their parameterization.
1750
1751 Therefore, it is easy to give an implicit parameterization to <i> gp</i> curves and surfaces, which is the parametrization of the equivalent <i> Geom</i> or <i> Geom2d</i> entity. This property is particularly useful when computing projections or intersections, or for operations involving complex algorithms where it is particularly important to manipulate the simplest data structures, i.e. those of <i> gp</i>. Thus,  <i> ElCLib</i> and <i> ElSLib</i> packages provide functions to compute:
1752   * the point of parameter u on a 2D or 3D gp curve,
1753   * the point of parameter (u,v) on a gp elementary surface, and
1754   * any derivative vector at this point.
1755
1756 Note: the <i> gp</i> entities cannot be shared when they are inside more complex data structures. 
1757   
1758 @subsection occt_occt_fcug_4_4 Collections of Primitive Geometric Types
1759
1760 Before creating a geometric object, you must decide whether  you are in a 2d or in a 3d context and how you want to handle the object. 
1761 If you do not need a single instance of a geometric  primitive but a set of them then the package which deals with collections of  this sort of object, *TColgp*, will provide the necessary functionality. 
1762 In particular, this package provides standard and frequently  used instantiations of generic classes with geometric objects, i.e. *XY*, *XYZ*,  *Pnt*, *Pnt2d*, *Vec*, *Vec2d*, *Lin*, *Lin2d*, *Circ*,  *Circ2d.* 
1763
1764 @subsection occt_occt_fcug_4_5 Basic Geometric Libraries
1765 There are various library packages available which offer a  range of basic computations on curves and surfaces. 
1766 If you are dealing with objects created from the *gp* package,  the useful algorithms are in the elementary curves and surfaces libraries -- the  *ElCLib* and *ElSLib* packages.
1767 * *EICLib* provides methods for analytic curves. This is a library of simple  computations on curves from the *gp* package (Lines, Circles and Conics).  It is possible to compute points with a given parameter or to compute the parameter for a point. 
1768 * *EISLib* provides methods for analytic surfaces. This is a library of simple  computations on surfaces from the package *gp* (Planes, Cylinders,  Spheres, Cones, Tori). It is possible to compute points with a given pair of parameters or to compute the parameter for a point. There is a library for calculating normals  on curves and surfaces. 
1769
1770 Additionally, *Bnd* package provides a set of classes and tools to operate  with bounding boxes of geometric objects in 2d and 3d space. 
1771
1772 @subsection occt_occt_fcug_4_6 Common Math Algorithms
1773 The common math algorithms library provides a C++  implementation of the most frequently used mathematical algorithms. These  include: 
1774   * Algorithms to solve a set of linear algebraic equations,
1775   * Algorithms to find the minimum of a function of one or more  independent variables,
1776   * Algorithms to find roots of one, or of a set, of non-linear  equations,
1777   * An algorithm to find the eigenvalues and eigenvectors of a square  matrix.
1778   
1779 All mathematical algorithms are implemented using the same  principles. They contain: 
1780 A constructor performing all, or most of, the calculation,  given the appropriate arguments. All relevant information is stored inside the  resulting object, so that all subsequent calculations or interrogations will be  solved in the most efficient way. 
1781
1782 A function *IsDone* returning the boolean true if the  calculation was successful. 
1783 A set of functions, specific to each algorithm, enabling all  the various results to be obtained. 
1784 Calling these functions is legal only if the function *IsDone*  answers **true**, otherwise the exception *StdFail_NotDone* is raised. 
1785
1786 The example below demonstrates the use of the Gauss class,  which implements the Gauss solution for a set of linear equations.The following  definition is an extract from the header file of the class *math_Gauss*: 
1787
1788 ~~~~~~
1789 class Gauss {
1790 public:
1791   Gauss (const math_Matrix& A);
1792   Standard_Boolean IsDone() const;
1793   void Solve (const math_Vector& B,
1794   math_Vector& X) const;
1795 };
1796 ~~~~~~
1797
1798 Now the main program uses the Gauss class to solve the  equations a*x1=b1 and a*x2=b2: 
1799
1800 ~~~~~
1801 #include <math_Vector.hxx> 
1802 #include <math_Matrix.hxx>
1803 main ()
1804 {
1805   math_Vector a(1, 3, 1, 3);
1806   math_Vector b1(1, 3), b2(1, 3);
1807   math_Vector x1(1, 3), x2(1, 3);
1808   // a, b1 and b2 are set here to the appropriate values
1809   math_Gauss sol(a);              // computation of the
1810   // LU decomposition of A
1811   if(sol.IsDone()) {              // is it OK ?
1812     sol.Solve(b1, x1);      // yes, so compute x1
1813     sol.Solve(b2, x2);      // then x2
1814     ...
1815   } 
1816   else {                    // it is not OK:
1817     // fix up
1818     sol.Solve(b1, x1);            // error:
1819     // StdFail_NotDone is raised
1820   }
1821 }
1822 ~~~~~
1823
1824 The next example demonstrates the use of the *BissecNewton* class, which implements a combination of the Newton and Bissection algorithms  to find the root of a function known to lie between two bounds. The definition is an extract from the header file of the class *math_BissecNewton*: 
1825
1826 ~~~~~
1827 class  BissecNewton { 
1828         public: 
1829                 BissecNewton  (math_FunctionWithDerivative& f, 
1830                         const Standard_Real bound1, 
1831                         const Standard_Real bound2, 
1832                         const Standard_Real tolx); 
1833         Standard_Boolean IsDone() const; 
1834         Standard_Real Root(); 
1835 }; 
1836 ~~~~~
1837
1838 The abstract class  *math_FunctionWithDerivative* describes the services which have to be implemented  for the function f which is to be used by a *BissecNewton* algorithm. The  following definition corresponds to the header file of the abstract class  *math_FunctionWithDerivative*: 
1839
1840 ~~~~~
1841 class  math_FunctionWithDerivative { 
1842         public: 
1843                 virtual Standard_Boolean Value 
1844                         (const Standard_Real x, Standard_Real&  f) = 0; 
1845                 virtual Standard_Boolean Derivative 
1846                         (const Standard_Real x, Standard_Real&  d) = 0; 
1847                 virtual Standard_Boolean Values 
1848                         (const Standard_Real x, 
1849                         Standard_Real& f, 
1850                         Standard_Real& d) = 0; 
1851 }; 
1852 ~~~~~
1853
1854 Now the test sample uses the *BissecNewton* class to find the  root of the equation *f(x)=x**2-4* in the interval [1.5, 2.5]: the function to  solve is implemented in the class *myFunction* which inherits from the class *math_FunctionWithDerivative*, then the main program finds the required root. 
1855
1856 ~~~~~
1857 #include <math_BissecNewton.hxx> 
1858 #include <math_FunctionWithDerivative.hxx>
1859 class myFunction : public math_FunctionWithDerivative 
1860 {
1861   Standard_Real coefa, coefb, coefc;
1862
1863   public:
1864     myFunction (const  Standard_Real a, const Standard_Real b,
1865                 const Standard_Real c) :
1866       coefa(a), coefb(b), coefc(c)
1867     {}
1868
1869     virtual  Standard_Boolean Value (const Standard_Real x, 
1870                                     Standard_Real& f)
1871     {
1872       f = coefa * x * x + coefb * x + coefc;
1873     }
1874
1875     virtual  Standard_Boolean Derivative (const Standard_Real x,
1876                                          Standard_Real&  d)
1877     {
1878       d = coefa * x * 2.0 + coefb;
1879     }
1880
1881     virtual  Standard_Boolean Values (const Standard_Real x,
1882                                      Standard_Real& f, Standard_Real& d)
1883     {
1884       f = coefa * x * x + coefb * x + coefc;
1885       d = coefa * x *  2.0 + coefb;
1886     }
1887 };
1888
1889 main()
1890 {
1891   myFunction f(1.0, 0.0, 4.0);
1892   math_BissecNewton sol(F, 1.5, 2.5, 0.000001);
1893   if(Sol.IsDone()) { // is it OK ?
1894     Standard_Real x = sol.Root(); // yes.
1895   }
1896   else { // no
1897   }
1898 ~~~~~
1899
1900 @subsection occt_occt_fcug_4_7 Precision
1901
1902 On the OCCT platform, each object stored in the database  should carry its own precision value. This is important when dealing with  systems where objects are imported from other systems as well as with various  associated precision values. 
1903
1904 The *Precision* package addresses the daily problem of  the geometric algorithm developer: what precision setting to use to compare two  numbers. Real number equivalence is clearly a poor choice. The difference  between the numbers should be compared to a given precision setting. 
1905
1906 Do not write _if  (X1 == X2),_  instead write _if  (Abs(X1-X2) < Precision)._ 
1907
1908 Also, to order real numbers, keep in mind that _if  (X1 < X2 - Precision)_ is incorrect. 
1909 _if  (X2 - X1 > Precision)_ is far better when *X1* and *X2* are high numbers. 
1910
1911 This package proposes a set of methods providing precision  settings for the most commonly encountered situations. 
1912
1913 In Open CASCADE Technology, precision is usually not  implicit; low-level geometric algorithms accept precision settings as  arguments. Usually these should not refer directly to this package. 
1914
1915 High-level modeling algorithms have to provide a precision  setting to the low level geometric algorithms they call. One way is to use the  settings provided by this package. The high-level modeling algorithms can also  have their own strategy for managing precision. As an example the Topology Data  Structure stores precision values which are later used by algorithms. When a  new topology is created, it takes the stored value. 
1916 Different precision settings offered by this package cover  the most common needs of geometric algorithms such as *Intersection* and *Approximation*. 
1917 The choice of a precision value depends both on the algorithm  and on the geometric space. The geometric space may be either: 
1918   * a real space, 3d or 2d where the lengths are measured  in meters, micron, inches, etc.
1919   * a parametric space, 1d on a curve or 2d on a surface  where numbers have no dimension.
1920 The choice of precision value for parametric space depends  not only on the accuracy of the machine, but also on the dimensions of the  curve or the surface. 
1921 This is because it is desirable to link parametric precision  and real precision. If you are on a curve defined by the equation *P(t)*,  you would want to have equivalence between the following: 
1922
1923 ~~~~~
1924 Abs(t1-t2)  < ParametricPrecision 
1925 Distance  (P(t1),P(t2)) < RealPrecision. 
1926 ~~~~~
1927
1928 @subsubsection occt_occt_fcug_4_7_1 The Precision package
1929 The *Precision* package offers a number of package methods and  default precisions for use in dealing with angles, distances, intersections,  approximations, and parametric space. 
1930 It provides values to use in comparisons to test for real  number equalities. 
1931   * Angular precision compares angles.
1932   * Confusion precision compares distances.
1933   * Intersection precision is used by intersection algorithms.
1934   * Approximation precision is used by approximation algorithms.
1935   * Parametric precision gets a parametric space precision from a 3D  precision.
1936   * *Infinite* returns a high number that can be considered to  be infinite. Use <i>-Infinite</i> for a high negative number. 
1937   
1938 @subsubsection occt_occt_fcug_4_7_2 Standard Precision values
1939 This package provides a set of real space precision values  for algorithms. The real space precisions are designed for precision to *0.1*  nanometers. The only unit available is the millimeter. 
1940 The parametric precisions are derived from the real  precisions by the *Parametric* function. This applies a scaling factor which  is the length of a tangent to the curve or the surface. You, the user, provide  this length. There is a default value for a curve with <i>[0,1]</i> parameter  space and a length less than 100 meters. 
1941 The geometric packages provide Parametric precisions for the  different types of curves. 
1942 The *Precision* package provides methods to test whether a  real number can be considered to be infinite. 
1943
1944 #### Precision::Angular
1945
1946 This method is used to compare two angles. Its current value is *Epsilon(2 *  PI)* i.e. the smallest number *x* such that *2*PI + x* is  different of *2\*PI*. 
1947
1948 It can be used to check confusion  of two angles as follows:
1949 _Abs(Angle1  - Angle2) < Precision::Angular()_ 
1950
1951 It is also possible to check parallelism  of two vectors (_Vec_ from _gp_) as follows _V1.IsParallel(V2,Precision::Angular())_ 
1952
1953 Note that *Precision::Angular()* can be used on both  dot and cross products because for small angles the *Sine* and the *Angle* are equivalent. So to test if two directions of type *gp_Dir* are  perpendicular, it is legal to use the following code: 
1954 _Abs(D1 * D2) < Precision::Angular()_ 
1955
1956 #### Precision::Confusion
1957
1958 This method is used to test 3D distances. The current value is *1.e-7*, in other words, 1/10 micron if the unit used is the millimeter. 
1959
1960 It can be used to check confusion  of two points (_Pnt_ from _gp_) as follows: 
1961 _P1.IsEqual(P2,Precision::Confusion())_ 
1962
1963 It is also possible to find a  vector of null length (_Vec_ from _gp_) :
1964 _V.Magnitude() <  Precision::Confusion()_ 
1965
1966 #### Precision::Intersection
1967
1968 This is reasonable precision to pass to an Intersection process as  a limit of refinement of Intersection Points. *Intersection* is high  enough for the process to converge quickly. *Intersection* is lower than *Confusion* so that you still get a point on the intersected geometries. The current  value is *Confusion() / 100*. 
1969
1970 #### Precision::Approximation
1971
1972 This is a reasonable precision to pass to an approximation process  as a limit of refinement of fitting. The approximation is greater than the other  precisions because it is designed to be used when the time is at a premium. It has  been provided as a reasonable compromise by the designers of the Approximation  algorithm. The current value is *Confusion() * 10*. 
1973 Note that Approximation is greater than Confusion, so care  must be taken when using Confusion in an approximation process. 
1974