diff --git a/src/Adaptor2d/Adaptor2d_Line2d.hxx b/src/Adaptor2d/Adaptor2d_Line2d.hxx index d0ff748027..f365e50804 100644 --- a/src/Adaptor2d/Adaptor2d_Line2d.hxx +++ b/src/Adaptor2d/Adaptor2d_Line2d.hxx @@ -44,7 +44,7 @@ class gp_Parab2d; class Geom2d_BezierCurve; class Geom2d_BSplineCurve; - +//! Use by the TopolTool to trim a surface. class Adaptor2d_Line2d : public Adaptor2d_Curve2d { diff --git a/src/AdvApp2Var/AdvApp2Var_Strip.hxx b/src/AdvApp2Var/AdvApp2Var_Strip.hxx index b5f6601c9f..179e4406d8 100644 --- a/src/AdvApp2Var/AdvApp2Var_Strip.hxx +++ b/src/AdvApp2Var/AdvApp2Var_Strip.hxx @@ -20,7 +20,8 @@ #include #include +//! Set of constraints along a same type of Iso on the same level + typedef NCollection_Sequence AdvApp2Var_Strip; - #endif diff --git a/src/BRepExtrema/BRepExtrema_SeqOfSolution.hxx b/src/BRepExtrema/BRepExtrema_SeqOfSolution.hxx index 8e368ffd27..6804774151 100644 --- a/src/BRepExtrema/BRepExtrema_SeqOfSolution.hxx +++ b/src/BRepExtrema/BRepExtrema_SeqOfSolution.hxx @@ -11,11 +11,6 @@ // Alternatively, this file may be used under the terms of Open CASCADE // commercial license or contractual agreement. -// This file is generated by WOK (CPPExt). -// Please do not edit this file; modify original file instead. -// The copyright and license terms as defined for the original file apply to -// this header file considered to be the "object code" form of the original source. - #ifndef _BRepExtrema_SeqOfSolution_HeaderFile #define _BRepExtrema_SeqOfSolution_HeaderFile diff --git a/src/BRepExtrema/BRepExtrema_SolutionElem.hxx b/src/BRepExtrema/BRepExtrema_SolutionElem.hxx index 61dba48bbd..5c0f808071 100644 --- a/src/BRepExtrema/BRepExtrema_SolutionElem.hxx +++ b/src/BRepExtrema/BRepExtrema_SolutionElem.hxx @@ -11,11 +11,6 @@ // Alternatively, this file may be used under the terms of Open CASCADE // commercial license or contractual agreement. -// This file is generated by WOK (CPPExt). -// Please do not edit this file; modify original file instead. -// The copyright and license terms as defined for the original file apply to -// this header file considered to be the "object code" form of the original source. - #ifndef _BRepExtrema_SolutionElem_HeaderFile #define _BRepExtrema_SolutionElem_HeaderFile diff --git a/src/BRepExtrema/BRepExtrema_SupportType.hxx b/src/BRepExtrema/BRepExtrema_SupportType.hxx index 47d475bf4f..cdbbc70820 100644 --- a/src/BRepExtrema/BRepExtrema_SupportType.hxx +++ b/src/BRepExtrema/BRepExtrema_SupportType.hxx @@ -11,11 +11,6 @@ // Alternatively, this file may be used under the terms of Open CASCADE // commercial license or contractual agreement. -// This file is generated by WOK (CPPExt). -// Please do not edit this file; modify original file instead. -// The copyright and license terms as defined for the original file apply to -// this header file considered to be the "object code" form of the original source. - #ifndef _BRepExtrema_SupportType_HeaderFile #define _BRepExtrema_SupportType_HeaderFile diff --git a/src/BRepOffsetAPI/BRepOffsetAPI_Sewing.hxx b/src/BRepOffsetAPI/BRepOffsetAPI_Sewing.hxx index f1395a6392..4129a63047 100644 --- a/src/BRepOffsetAPI/BRepOffsetAPI_Sewing.hxx +++ b/src/BRepOffsetAPI/BRepOffsetAPI_Sewing.hxx @@ -19,7 +19,7 @@ #include +//! Sew the shapes along their common edges typedef BRepBuilderAPI_Sewing BRepOffsetAPI_Sewing; -typedef Handle_BRepBuilderAPI_Sewing Handle_BRepOffsetAPI_Sewing; #endif // _BRepOffsetAPI_Sewing_HeaderFile diff --git a/src/Bnd/Bnd_SeqOfBox.hxx b/src/Bnd/Bnd_SeqOfBox.hxx index a6ee0d325c..eeb418ff17 100644 --- a/src/Bnd/Bnd_SeqOfBox.hxx +++ b/src/Bnd/Bnd_SeqOfBox.hxx @@ -20,6 +20,7 @@ #include #include +//! This sequence used to store the bounding boxes of sub-Shapes. typedef NCollection_Sequence Bnd_SeqOfBox; diff --git a/src/CDF/CDF_MetaDataDriverError.hxx b/src/CDF/CDF_MetaDataDriverError.hxx index f5bc7fbbe5..d37ca37574 100644 --- a/src/CDF/CDF_MetaDataDriverError.hxx +++ b/src/CDF/CDF_MetaDataDriverError.hxx @@ -22,6 +22,10 @@ #include #include +//! This exception is used in the deferred methods. +//! Programmer implementing such methods may use this +//! exception or any exception inheriting MetaDataDriverError. + class CDF_MetaDataDriverError; DEFINE_STANDARD_HANDLE(CDF_MetaDataDriverError, Standard_Failure) diff --git a/src/FEmTool/FEmTool_AssemblyTable.hxx b/src/FEmTool/FEmTool_AssemblyTable.hxx index 4caa8875dd..67f26c6854 100644 --- a/src/FEmTool/FEmTool_AssemblyTable.hxx +++ b/src/FEmTool/FEmTool_AssemblyTable.hxx @@ -20,6 +20,9 @@ #include #include +//! To define the table [Freedom's degree] [Dimension,Element] +//! which gives Index of Freedom's degree in the assembly problem. + typedef NCollection_Array2 FEmTool_AssemblyTable; diff --git a/src/FEmTool/FEmTool_ListOfVectors.hxx b/src/FEmTool/FEmTool_ListOfVectors.hxx index 37fde0c92f..6c34e1c4ae 100644 --- a/src/FEmTool/FEmTool_ListOfVectors.hxx +++ b/src/FEmTool/FEmTool_ListOfVectors.hxx @@ -20,6 +20,8 @@ #include #include +//! To define list of segments with non-zero coefficients of constraint + typedef NCollection_List FEmTool_ListOfVectors; typedef NCollection_List::Iterator FEmTool_ListIteratorOfListOfVectors; diff --git a/src/FEmTool/FEmTool_SeqOfLinConstr.hxx b/src/FEmTool/FEmTool_SeqOfLinConstr.hxx index c5b6025e79..13f2ea78fc 100644 --- a/src/FEmTool/FEmTool_SeqOfLinConstr.hxx +++ b/src/FEmTool/FEmTool_SeqOfLinConstr.hxx @@ -20,7 +20,8 @@ #include #include +//! To define sequence of constraints + typedef NCollection_Sequence FEmTool_SeqOfLinConstr; - #endif diff --git a/src/GProp/GProp_UndefinedAxis.hxx b/src/GProp/GProp_UndefinedAxis.hxx index aaaf6e0c8c..38224605e0 100644 --- a/src/GProp/GProp_UndefinedAxis.hxx +++ b/src/GProp/GProp_UndefinedAxis.hxx @@ -22,6 +22,9 @@ #include #include +//! This exception is raised when a method makes reference to +//! an undefined inertia axis of symmetry. + class GProp_UndefinedAxis; DEFINE_STANDARD_HANDLE(GProp_UndefinedAxis, Standard_DomainError) diff --git a/src/GeomFill/GeomFill_AppSurf.hxx b/src/GeomFill/GeomFill_AppSurf.hxx index d1806be16c..2b941f03ce 100644 --- a/src/GeomFill/GeomFill_AppSurf.hxx +++ b/src/GeomFill/GeomFill_AppSurf.hxx @@ -43,7 +43,8 @@ class Standard_OutOfRange; class GeomFill_SectionGenerator; class GeomFill_Line; - +//! Approximate a BSplineSurface passing by all the +//! curves described in the SectionGenerator class GeomFill_AppSurf : public AppBlend_Approx { diff --git a/src/GeomFill/GeomFill_AppSweep.hxx b/src/GeomFill/GeomFill_AppSweep.hxx index c174bf755d..a981807073 100644 --- a/src/GeomFill/GeomFill_AppSweep.hxx +++ b/src/GeomFill/GeomFill_AppSweep.hxx @@ -44,6 +44,8 @@ class GeomFill_SweepSectionGenerator; class GeomFill_Line; +//! Approximate a sweep surface passing by all the +//! curves described in the SweepSectionGenerator. class GeomFill_AppSweep : public AppBlend_Approx { diff --git a/src/Graphic3d/Graphic3d_BndBox4f.hxx b/src/Graphic3d/Graphic3d_BndBox4f.hxx index 7a86c2a150..14e902c13a 100644 --- a/src/Graphic3d/Graphic3d_BndBox4f.hxx +++ b/src/Graphic3d/Graphic3d_BndBox4f.hxx @@ -18,6 +18,9 @@ #include +//! Redefines BVH_Box for AABB representation +//! Describes rendering parameters and effects. + typedef BVH_Box Graphic3d_BndBox4f; #endif // _Graphic3d_BndBox4f_HeaderFile diff --git a/src/Intf/Intf_Array1OfLin.hxx b/src/Intf/Intf_Array1OfLin.hxx index 6da2576623..bdd201d924 100644 --- a/src/Intf/Intf_Array1OfLin.hxx +++ b/src/Intf/Intf_Array1OfLin.hxx @@ -20,6 +20,8 @@ #include #include +//! Describes a set of Straight Lines to intersect with the Polyhedron. + typedef NCollection_Array1 Intf_Array1OfLin; diff --git a/src/Quantity/Quantity_AbsorbedDose.hxx b/src/Quantity/Quantity_AbsorbedDose.hxx index 023a110fe6..66913a162f 100644 --- a/src/Quantity/Quantity_AbsorbedDose.hxx +++ b/src/Quantity/Quantity_AbsorbedDose.hxx @@ -19,7 +19,10 @@ #include +//! Defined as the energy absorbed per unit mass in an +//! irradiated medium. +//! It is measured in grays. + typedef Standard_Real Quantity_AbsorbedDose; - #endif // _Quantity_AbsorbedDose_HeaderFile diff --git a/src/Quantity/Quantity_Acceleration.hxx b/src/Quantity/Quantity_Acceleration.hxx index 64c462675b..d5ece2ce59 100644 --- a/src/Quantity/Quantity_Acceleration.hxx +++ b/src/Quantity/Quantity_Acceleration.hxx @@ -19,7 +19,9 @@ #include +//! Defined as the change of velocity per unit time. +//! It is a vector quantity. +//! It is measured in metres per second per second. typedef Standard_Real Quantity_Acceleration; - #endif // _Quantity_Acceleration_HeaderFile diff --git a/src/Quantity/Quantity_AcousticIntensity.hxx b/src/Quantity/Quantity_AcousticIntensity.hxx index 32e0765fc3..7e8e151f60 100644 --- a/src/Quantity/Quantity_AcousticIntensity.hxx +++ b/src/Quantity/Quantity_AcousticIntensity.hxx @@ -19,7 +19,11 @@ #include +//! Defined as a dimensionless comparison of sound pressure +//! levels. The conventional unit, the bel, is the base ten +//! logarithm of the ratio of the two pressures. In practice +//! the decibel (one tenth of a bel) is used. + typedef Standard_Real Quantity_AcousticIntensity; - #endif // _Quantity_AcousticIntensity_HeaderFile diff --git a/src/Quantity/Quantity_Activity.hxx b/src/Quantity/Quantity_Activity.hxx index 0311a1bcde..aa23119850 100644 --- a/src/Quantity/Quantity_Activity.hxx +++ b/src/Quantity/Quantity_Activity.hxx @@ -19,7 +19,10 @@ #include +//! Defined as the number of atoms of a radioactive +//! substance which disintegrate per unit time. It is +//! measured in becquerels (one disintegration per second). + typedef Standard_Real Quantity_Activity; - #endif // _Quantity_Activity_HeaderFile diff --git a/src/Quantity/Quantity_Admittance.hxx b/src/Quantity/Quantity_Admittance.hxx index df5ae8fcb5..17bf9623ae 100644 --- a/src/Quantity/Quantity_Admittance.hxx +++ b/src/Quantity/Quantity_Admittance.hxx @@ -19,7 +19,11 @@ #include +//! Defined as the reciprocal of impedance. +//! It is measured in Siemens (reciprocal Ohms). +//! The square of the admittance is equal to the sum of the +//! squares of the conductance and the susceptance. + typedef Standard_Real Quantity_Admittance; - #endif // _Quantity_Admittance_HeaderFile diff --git a/src/Quantity/Quantity_AmountOfSubstance.hxx b/src/Quantity/Quantity_AmountOfSubstance.hxx index a1a3844902..219fa04997 100644 --- a/src/Quantity/Quantity_AmountOfSubstance.hxx +++ b/src/Quantity/Quantity_AmountOfSubstance.hxx @@ -19,7 +19,11 @@ #include +//! Defined as a dimensionless quantity proportional to +//! the number of specified particles of a substance. +//! Amount of substance is measured in moles. +//! For all substances the number of molecules in a mole +//! is given by Avogadro's Constant. typedef Standard_Real Quantity_AmountOfSubstance; - #endif // _Quantity_AmountOfSubstance_HeaderFile diff --git a/src/Quantity/Quantity_AngularVelocity.hxx b/src/Quantity/Quantity_AngularVelocity.hxx index d010ab4e34..849891b0f1 100644 --- a/src/Quantity/Quantity_AngularVelocity.hxx +++ b/src/Quantity/Quantity_AngularVelocity.hxx @@ -19,7 +19,9 @@ #include +//! Defined as the rate at which a body moves around an axis. +//! It is quantified as change in direction per unit time. +//! It is measured in radians per second. typedef Standard_Real Quantity_AngularVelocity; - #endif // _Quantity_AngularVelocity_HeaderFile diff --git a/src/Quantity/Quantity_Area.hxx b/src/Quantity/Quantity_Area.hxx index 4abe20f60d..0122bb132f 100644 --- a/src/Quantity/Quantity_Area.hxx +++ b/src/Quantity/Quantity_Area.hxx @@ -19,7 +19,8 @@ #include +//! Defined as superficial extension. +//! It is measured in square metres. typedef Standard_Real Quantity_Area; - #endif // _Quantity_Area_HeaderFile diff --git a/src/Quantity/Quantity_Capacitance.hxx b/src/Quantity/Quantity_Capacitance.hxx index c5542f3935..a196cbc959 100644 --- a/src/Quantity/Quantity_Capacitance.hxx +++ b/src/Quantity/Quantity_Capacitance.hxx @@ -19,7 +19,14 @@ #include +//! Defined as a measure of the increase in voltage on +//! an isolated conductor by the addition of a charge. +//! for two isolated conductors, it is the ratio of the charge +//! on either conductor to the potential difference between +//! them. +//! It is measured in farads (coulomb per volt). +//! In practice micro-, nano-, and pico-farads are used. + typedef Standard_Real Quantity_Capacitance; - #endif // _Quantity_Capacitance_HeaderFile diff --git a/src/Quantity/Quantity_CoefficientOfExpansion.hxx b/src/Quantity/Quantity_CoefficientOfExpansion.hxx index 21408dc60c..5b5f532c54 100644 --- a/src/Quantity/Quantity_CoefficientOfExpansion.hxx +++ b/src/Quantity/Quantity_CoefficientOfExpansion.hxx @@ -19,7 +19,14 @@ #include +//! Defined as the proportional change in the length, +//! area, or volume of a solid per degree of temperature. +//! For a liquid the expansion of the container must be +//! taken into account. +//! For a gas there are coefficients for constant pressure +//! and constant volume changes. +//! It is measured in units of reciprocal degree kelvin. + typedef Standard_Real Quantity_CoefficientOfExpansion; - #endif // _Quantity_CoefficientOfExpansion_HeaderFile diff --git a/src/Quantity/Quantity_Concentration.hxx b/src/Quantity/Quantity_Concentration.hxx index c22d8717f0..1723b81189 100644 --- a/src/Quantity/Quantity_Concentration.hxx +++ b/src/Quantity/Quantity_Concentration.hxx @@ -19,7 +19,12 @@ #include +//! Defined as the strength of a mixture or solution. It can +//! be measured as kilograms per litre of solvent or of +//! solution. For certain purposes percentage by weight or +//! volume can be used, and parts per million (ppm) is used +//! for trace elements. + typedef Standard_Real Quantity_Concentration; - #endif // _Quantity_Concentration_HeaderFile diff --git a/src/Quantity/Quantity_Conductivity.hxx b/src/Quantity/Quantity_Conductivity.hxx index 9bd7fa3dc7..92d827c56b 100644 --- a/src/Quantity/Quantity_Conductivity.hxx +++ b/src/Quantity/Quantity_Conductivity.hxx @@ -19,7 +19,10 @@ #include +//! Defined as the current density divided by the electrical +//! field strength. It is also the reciprocal of resistivity. +//! It is measured in Siemens per metre. + typedef Standard_Real Quantity_Conductivity; - #endif // _Quantity_Conductivity_HeaderFile diff --git a/src/Quantity/Quantity_Consumption.hxx b/src/Quantity/Quantity_Consumption.hxx index 1f534ce7df..00dbc896f7 100644 --- a/src/Quantity/Quantity_Consumption.hxx +++ b/src/Quantity/Quantity_Consumption.hxx @@ -19,7 +19,11 @@ #include +//! Defined as a measure of fuel used per unit distance +//! travelled, or distance travelled per unit of fuel. +//! It is measured in litres per 100 kilometres or in +//! miles per gallon (UK or US). + typedef Standard_Real Quantity_Consumption; - #endif // _Quantity_Consumption_HeaderFile diff --git a/src/Quantity/Quantity_Density.hxx b/src/Quantity/Quantity_Density.hxx index 9f085b8647..238d56bc81 100644 --- a/src/Quantity/Quantity_Density.hxx +++ b/src/Quantity/Quantity_Density.hxx @@ -19,7 +19,8 @@ #include +//! Defined as mass per unit volume. +//! It is measured in kilograms per cubic metre. typedef Standard_Real Quantity_Density; - #endif // _Quantity_Density_HeaderFile diff --git a/src/Quantity/Quantity_DoseEquivalent.hxx b/src/Quantity/Quantity_DoseEquivalent.hxx index 2140a4ec62..ccbf7e4db1 100644 --- a/src/Quantity/Quantity_DoseEquivalent.hxx +++ b/src/Quantity/Quantity_DoseEquivalent.hxx @@ -19,7 +19,11 @@ #include +//! Defined as the product of the absorbed dose and a +//! quality factor related to the effect of a particular +//! type of radiation on biological tissue. +//! It is measured in sieverts. + typedef Standard_Real Quantity_DoseEquivalent; - #endif // _Quantity_DoseEquivalent_HeaderFile diff --git a/src/Quantity/Quantity_ElectricCapacitance.hxx b/src/Quantity/Quantity_ElectricCapacitance.hxx index a7db6faa20..562f95806b 100644 --- a/src/Quantity/Quantity_ElectricCapacitance.hxx +++ b/src/Quantity/Quantity_ElectricCapacitance.hxx @@ -19,7 +19,10 @@ #include +//! Defined for a capacitor as the ratio of the charge on +//! either conductor to the potential between them. +//! It is measured in farads (coulomb per volt). + typedef Standard_Real Quantity_ElectricCapacitance; - #endif // _Quantity_ElectricCapacitance_HeaderFile diff --git a/src/Quantity/Quantity_ElectricCharge.hxx b/src/Quantity/Quantity_ElectricCharge.hxx index f14c12404f..2a369aafc9 100644 --- a/src/Quantity/Quantity_ElectricCharge.hxx +++ b/src/Quantity/Quantity_ElectricCharge.hxx @@ -19,7 +19,11 @@ #include +//! Defined as a property of elementary particles. It is +//! more commonly viewed as the product of electric current +//! and time. +//! It is measured in coulombs (ampere-second). + typedef Standard_Real Quantity_ElectricCharge; - #endif // _Quantity_ElectricCharge_HeaderFile diff --git a/src/Quantity/Quantity_ElectricCurrent.hxx b/src/Quantity/Quantity_ElectricCurrent.hxx index b93416f55a..aa3a0d7523 100644 --- a/src/Quantity/Quantity_ElectricCurrent.hxx +++ b/src/Quantity/Quantity_ElectricCurrent.hxx @@ -19,7 +19,9 @@ #include +//! Defined as the amount of charge flowing per unit time. +//! It is measured in amperes (coulombs per second). + typedef Standard_Real Quantity_ElectricCurrent; - #endif // _Quantity_ElectricCurrent_HeaderFile diff --git a/src/Quantity/Quantity_ElectricFieldStrength.hxx b/src/Quantity/Quantity_ElectricFieldStrength.hxx index d45ebca606..f7cccbc487 100644 --- a/src/Quantity/Quantity_ElectricFieldStrength.hxx +++ b/src/Quantity/Quantity_ElectricFieldStrength.hxx @@ -19,7 +19,10 @@ #include +//! Defined as the force exerted on a unit charge at a +//! given point in space. +//! It is measured in volts per metre. + typedef Standard_Real Quantity_ElectricFieldStrength; - #endif // _Quantity_ElectricFieldStrength_HeaderFile diff --git a/src/Quantity/Quantity_ElectricPotential.hxx b/src/Quantity/Quantity_ElectricPotential.hxx index 24549b2475..8e9327626e 100644 --- a/src/Quantity/Quantity_ElectricPotential.hxx +++ b/src/Quantity/Quantity_ElectricPotential.hxx @@ -19,7 +19,13 @@ #include +//! Defined as the work done in bringing unit positive +//! charge from infinity to the point. +//! It is measured in volts. +//! Volts are in practice used to measure differences +//! in potential e.g. the electromotive force generated when +//! a conductor cuts a magnetic field. + typedef Standard_Real Quantity_ElectricPotential; - #endif // _Quantity_ElectricPotential_HeaderFile diff --git a/src/Quantity/Quantity_Energy.hxx b/src/Quantity/Quantity_Energy.hxx index 5cfa72a348..56ed36e11a 100644 --- a/src/Quantity/Quantity_Energy.hxx +++ b/src/Quantity/Quantity_Energy.hxx @@ -19,7 +19,25 @@ #include +//! Defined as the capacity of a system to do work. +//! In mechanical terms this can be quantified as the +//! product of a force and a distance moved by its point of +//! application. +//! In kinetic terms it is the product of half the mass +//! and the square of the speed . +//! In a rotating system it is the product of half the +//! moment of inertia and the square of the angular velocity. +//! In potential terms it is the product of a mass, +//! a height, and the free fall acceleration. +//! In molecular terms it is the sum of the kinetic and +//! potential energies of the molecules. +//! In electric terms it is the product of charge and +//! the electric potential traversed. +//! In relativistic terms it is the difference between +//! the observed mass and the rest mass of a body multiplied +//! by the square of the speed of light. +//! It is measured in joules (newton-metres). + typedef Standard_Real Quantity_Energy; - #endif // _Quantity_Energy_HeaderFile diff --git a/src/Quantity/Quantity_Enthalpy.hxx b/src/Quantity/Quantity_Enthalpy.hxx index 3ecd8f6cfd..2943676cec 100644 --- a/src/Quantity/Quantity_Enthalpy.hxx +++ b/src/Quantity/Quantity_Enthalpy.hxx @@ -19,7 +19,12 @@ #include +//! Defined as the sum of the internal energy of a system plus +//! the product of its pressure and volume. For a reversible +//! process at constant pressure the change in enthalpy is +//! equal to the quantity of heat absorbed (or lost). +//! It is measured in joules. + typedef Standard_Real Quantity_Enthalpy; - #endif // _Quantity_Enthalpy_HeaderFile diff --git a/src/Quantity/Quantity_Entropy.hxx b/src/Quantity/Quantity_Entropy.hxx index 1f0638c3d6..91ea21c04a 100644 --- a/src/Quantity/Quantity_Entropy.hxx +++ b/src/Quantity/Quantity_Entropy.hxx @@ -19,7 +19,16 @@ #include +//! Defined as a property which changes as a system undergoes +//! reversible change. The change in entropy is quantified as +//! the change in energy per degree of temperature. All real +//! changes are at least partially irreversible so entropy +//! is increased by change. Entropy can be viewed as a +//! measure of the molecular disorder of a system, or as the +//! unavailability of its internal energy to do work in a +//! cyclical process. +//! A change in entropy is measured in joules per degree kelvin. + typedef Standard_Real Quantity_Entropy; - #endif // _Quantity_Entropy_HeaderFile diff --git a/src/Quantity/Quantity_Force.hxx b/src/Quantity/Quantity_Force.hxx index 3968e64c93..45e9557f3d 100644 --- a/src/Quantity/Quantity_Force.hxx +++ b/src/Quantity/Quantity_Force.hxx @@ -19,7 +19,11 @@ #include +//! Defined as the product of the mass of a body +//! and the acceleration that the force produces. +//! It is a vector quantity. +//! It is measured in newtons. + typedef Standard_Real Quantity_Force; - #endif // _Quantity_Force_HeaderFile diff --git a/src/Quantity/Quantity_Frequency.hxx b/src/Quantity/Quantity_Frequency.hxx index 8ea7ffe470..00b7413f89 100644 --- a/src/Quantity/Quantity_Frequency.hxx +++ b/src/Quantity/Quantity_Frequency.hxx @@ -19,7 +19,8 @@ #include +//! Defined as the number of oscillations per unit time. +//! It is measured in cycles per second. typedef Standard_Real Quantity_Frequency; - #endif // _Quantity_Frequency_HeaderFile diff --git a/src/Quantity/Quantity_Illuminance.hxx b/src/Quantity/Quantity_Illuminance.hxx index 19896a60f7..35b4512f25 100644 --- a/src/Quantity/Quantity_Illuminance.hxx +++ b/src/Quantity/Quantity_Illuminance.hxx @@ -19,7 +19,9 @@ #include +//! Defined as the incident luminous flux per unit area. +//! It is measured in lux (lumen per square metre). + typedef Standard_Real Quantity_Illuminance; - #endif // _Quantity_Illuminance_HeaderFile diff --git a/src/Quantity/Quantity_Impedance.hxx b/src/Quantity/Quantity_Impedance.hxx index 8223e3e278..494c27e649 100644 --- a/src/Quantity/Quantity_Impedance.hxx +++ b/src/Quantity/Quantity_Impedance.hxx @@ -19,7 +19,11 @@ #include +//! Defined as the total opposition to the flow of current +//! in a circuit. Includes the contributions of resistance, +//! inductance, and capacitance. +//! It is measured in Ohms. + typedef Standard_Real Quantity_Impedance; - #endif // _Quantity_Impedance_HeaderFile diff --git a/src/Quantity/Quantity_Inductance.hxx b/src/Quantity/Quantity_Inductance.hxx index 1f88bc1b3c..62e4db46d5 100644 --- a/src/Quantity/Quantity_Inductance.hxx +++ b/src/Quantity/Quantity_Inductance.hxx @@ -19,7 +19,11 @@ #include +//! Defined as numerically equal to the electromotive force +//! induced when the current in a circuit changes at +//! unit rate. +//! It is measured in henrys (webers per ampere). + typedef Standard_Real Quantity_Inductance; - #endif // _Quantity_Inductance_HeaderFile diff --git a/src/Quantity/Quantity_KinematicViscosity.hxx b/src/Quantity/Quantity_KinematicViscosity.hxx index 88a62c3e92..eda9039151 100644 --- a/src/Quantity/Quantity_KinematicViscosity.hxx +++ b/src/Quantity/Quantity_KinematicViscosity.hxx @@ -19,7 +19,12 @@ #include +//! Defined as the ratio of the dynamic viscosity +//! to the fluid density. Used in modifying the motion of a +//! perfect fluid to include terms due to a real fluid. +//! It is quantified as area per unit time. +//! It is measured in square metres per second. + typedef Standard_Real Quantity_KinematicViscosity; - #endif // _Quantity_KinematicViscosity_HeaderFile diff --git a/src/Quantity/Quantity_KineticMoment.hxx b/src/Quantity/Quantity_KineticMoment.hxx index 932a4d2acb..b389cf06df 100644 --- a/src/Quantity/Quantity_KineticMoment.hxx +++ b/src/Quantity/Quantity_KineticMoment.hxx @@ -19,7 +19,10 @@ #include +//! Defined as the product of momentum of a body +//! and the distance of its centre of gravity from an axis. +//! It is measured in kilogram-square-metres per second. + typedef Standard_Real Quantity_KineticMoment; - #endif // _Quantity_KineticMoment_HeaderFile diff --git a/src/Quantity/Quantity_Length.hxx b/src/Quantity/Quantity_Length.hxx index da4252eeb3..2a35724595 100644 --- a/src/Quantity/Quantity_Length.hxx +++ b/src/Quantity/Quantity_Length.hxx @@ -19,7 +19,8 @@ #include +//! Defined as spatial extension. +//! It is measured in metres. typedef Standard_Real Quantity_Length; - #endif // _Quantity_Length_HeaderFile diff --git a/src/Quantity/Quantity_Luminance.hxx b/src/Quantity/Quantity_Luminance.hxx index 83864f2287..a740b71b85 100644 --- a/src/Quantity/Quantity_Luminance.hxx +++ b/src/Quantity/Quantity_Luminance.hxx @@ -19,7 +19,10 @@ #include +//! It is defined the luminous flux per unit area per unit +//! solid angle. +//! It is measured in candelas per square metre. + typedef Standard_Real Quantity_Luminance; - #endif // _Quantity_Luminance_HeaderFile diff --git a/src/Quantity/Quantity_LuminousEfficacity.hxx b/src/Quantity/Quantity_LuminousEfficacity.hxx index a1ef781331..fe38899139 100644 --- a/src/Quantity/Quantity_LuminousEfficacity.hxx +++ b/src/Quantity/Quantity_LuminousEfficacity.hxx @@ -19,7 +19,10 @@ #include +//! Defined as the ratio of luminous flux emitted by a +//! source to the power it consumes. +//! It is measured in lumens per watt. + typedef Standard_Real Quantity_LuminousEfficacity; - #endif // _Quantity_LuminousEfficacity_HeaderFile diff --git a/src/Quantity/Quantity_LuminousExposition.hxx b/src/Quantity/Quantity_LuminousExposition.hxx index 19d4bee34c..9615ab9d78 100644 --- a/src/Quantity/Quantity_LuminousExposition.hxx +++ b/src/Quantity/Quantity_LuminousExposition.hxx @@ -19,7 +19,9 @@ #include +//! Defined as the quantity of illuminance with time. +//! It is measured in lux-seconds. + typedef Standard_Real Quantity_LuminousExposition; - #endif // _Quantity_LuminousExposition_HeaderFile diff --git a/src/Quantity/Quantity_LuminousFlux.hxx b/src/Quantity/Quantity_LuminousFlux.hxx index 10e5f67209..78df0f0b2d 100644 --- a/src/Quantity/Quantity_LuminousFlux.hxx +++ b/src/Quantity/Quantity_LuminousFlux.hxx @@ -19,7 +19,13 @@ #include +//! Defined as the rate of flow of radiant energy as evaluated +//! by the luminous sensation it produces. This means it +//! depends on the sensitivity of the receptor or observer. It +//! is related to the radiant flux of the source by the +//! spectral luminous efficiency. +//! It is measured in lumens. + typedef Standard_Real Quantity_LuminousFlux; - #endif // _Quantity_LuminousFlux_HeaderFile diff --git a/src/Quantity/Quantity_LuminousIntensity.hxx b/src/Quantity/Quantity_LuminousIntensity.hxx index 8f2ccab13a..e1e51448d3 100644 --- a/src/Quantity/Quantity_LuminousIntensity.hxx +++ b/src/Quantity/Quantity_LuminousIntensity.hxx @@ -19,7 +19,10 @@ #include +//! Defined as the luminous flux emitted per unit solid +//! angle in a given direction by a point source. +//! It is measured in candelas. + typedef Standard_Real Quantity_LuminousIntensity; - #endif // _Quantity_LuminousIntensity_HeaderFile diff --git a/src/Quantity/Quantity_MagneticFieldStrength.hxx b/src/Quantity/Quantity_MagneticFieldStrength.hxx index 188d5db6d2..56a731231e 100644 --- a/src/Quantity/Quantity_MagneticFieldStrength.hxx +++ b/src/Quantity/Quantity_MagneticFieldStrength.hxx @@ -19,7 +19,12 @@ #include +//! Described as a vector quantity, it is the ratio of the +//! magnetic flux density to the permeability of the medium. +//! Its integral along a closed line is equal to the +//! magnetomotive force. +//! It is measured in amperes per metre. + typedef Standard_Real Quantity_MagneticFieldStrength; - #endif // _Quantity_MagneticFieldStrength_HeaderFile diff --git a/src/Quantity/Quantity_MagneticFlux.hxx b/src/Quantity/Quantity_MagneticFlux.hxx index 04a4f23ce8..56d12063df 100644 --- a/src/Quantity/Quantity_MagneticFlux.hxx +++ b/src/Quantity/Quantity_MagneticFlux.hxx @@ -19,7 +19,10 @@ #include +//! Defined as the product of a given area and the +//! average magnetic flux density normal to it. +//! It is measured in webers (tesla-square-metre). + typedef Standard_Real Quantity_MagneticFlux; - #endif // _Quantity_MagneticFlux_HeaderFile diff --git a/src/Quantity/Quantity_MagneticFluxDensity.hxx b/src/Quantity/Quantity_MagneticFluxDensity.hxx index 1a17093e00..580692fe63 100644 --- a/src/Quantity/Quantity_MagneticFluxDensity.hxx +++ b/src/Quantity/Quantity_MagneticFluxDensity.hxx @@ -19,7 +19,13 @@ #include +//! Defined as the magnetic flux passing through unit area +//! of a magnetic field normal to the magnetic force. +//! It is a vector quantity, the product of the permeability +//! and the magnetic field strength and with a direction at any +//! given point the same as that of the magnetic field. +//! It is measured in teslas (webers per square metre). + typedef Standard_Real Quantity_MagneticFluxDensity; - #endif // _Quantity_MagneticFluxDensity_HeaderFile diff --git a/src/Quantity/Quantity_Mass.hxx b/src/Quantity/Quantity_Mass.hxx index 0937a86eac..2f9e70db15 100644 --- a/src/Quantity/Quantity_Mass.hxx +++ b/src/Quantity/Quantity_Mass.hxx @@ -19,7 +19,9 @@ #include +//! Defined as a quantity of matter. Gives rise to the +//! inertial and gravitational properties of a body. +//! It is measured in kilograms. typedef Standard_Real Quantity_Mass; - #endif // _Quantity_Mass_HeaderFile diff --git a/src/Quantity/Quantity_MassFlow.hxx b/src/Quantity/Quantity_MassFlow.hxx index 037d7be4c6..a0f8cad01c 100644 --- a/src/Quantity/Quantity_MassFlow.hxx +++ b/src/Quantity/Quantity_MassFlow.hxx @@ -19,7 +19,9 @@ #include +//! Defined as mass per unit time. +//! It is measured in kilograms per second. + typedef Standard_Real Quantity_MassFlow; - #endif // _Quantity_MassFlow_HeaderFile diff --git a/src/Quantity/Quantity_MolarConcentration.hxx b/src/Quantity/Quantity_MolarConcentration.hxx index b1a9c9622e..1f1ff1f77f 100644 --- a/src/Quantity/Quantity_MolarConcentration.hxx +++ b/src/Quantity/Quantity_MolarConcentration.hxx @@ -19,7 +19,9 @@ #include +//! Defined as the concentration in moles per litre of +//! solution. It is also called molarity. + typedef Standard_Real Quantity_MolarConcentration; - #endif // _Quantity_MolarConcentration_HeaderFile diff --git a/src/Quantity/Quantity_MolarMass.hxx b/src/Quantity/Quantity_MolarMass.hxx index 13032863f7..652383d154 100644 --- a/src/Quantity/Quantity_MolarMass.hxx +++ b/src/Quantity/Quantity_MolarMass.hxx @@ -19,7 +19,11 @@ #include +//! Defined as the mass of a given substance contained in one +//! mole. One mole of any substance contains Avogadro's +//! Constant of molecules. +//! It is measured in kilograms per mole. + typedef Standard_Real Quantity_MolarMass; - #endif // _Quantity_MolarMass_HeaderFile diff --git a/src/Quantity/Quantity_MolarVolume.hxx b/src/Quantity/Quantity_MolarVolume.hxx index 0f79566676..6f6811542c 100644 --- a/src/Quantity/Quantity_MolarVolume.hxx +++ b/src/Quantity/Quantity_MolarVolume.hxx @@ -19,7 +19,11 @@ #include +//! Defined as the volume occupied by one mole of substance. +//! One mole of any substance contains Avogadro's +//! Constant of molecules. +//! It is measured in cubic metres per mole. + typedef Standard_Real Quantity_MolarVolume; - #endif // _Quantity_MolarVolume_HeaderFile diff --git a/src/Quantity/Quantity_Molarity.hxx b/src/Quantity/Quantity_Molarity.hxx index 06f84d8bd0..c4f69ce84a 100644 --- a/src/Quantity/Quantity_Molarity.hxx +++ b/src/Quantity/Quantity_Molarity.hxx @@ -19,7 +19,9 @@ #include +//! Defined as the concentration in moles per kilogram of +//! solvent. + typedef Standard_Real Quantity_Molarity; - #endif // _Quantity_Molarity_HeaderFile diff --git a/src/Quantity/Quantity_MomentOfAForce.hxx b/src/Quantity/Quantity_MomentOfAForce.hxx index 59b9b09056..8a3d0abe9c 100644 --- a/src/Quantity/Quantity_MomentOfAForce.hxx +++ b/src/Quantity/Quantity_MomentOfAForce.hxx @@ -19,7 +19,10 @@ #include +//! Defined as the product of a force and the +//! perpendicular distance to an axis. +//! It is measured in newtons x metres. + typedef Standard_Real Quantity_MomentOfAForce; - #endif // _Quantity_MomentOfAForce_HeaderFile diff --git a/src/Quantity/Quantity_MomentOfInertia.hxx b/src/Quantity/Quantity_MomentOfInertia.hxx index 694f19db97..3697a3b276 100644 --- a/src/Quantity/Quantity_MomentOfInertia.hxx +++ b/src/Quantity/Quantity_MomentOfInertia.hxx @@ -19,7 +19,11 @@ #include +//! Defined as the product of the mass of a body +//! and the square of the distance of its centre of gravity +//! from an axis. +//! It is measured in kilogram-square-metres. + typedef Standard_Real Quantity_MomentOfInertia; - #endif // _Quantity_MomentOfInertia_HeaderFile diff --git a/src/Quantity/Quantity_Momentum.hxx b/src/Quantity/Quantity_Momentum.hxx index 52b7d3f100..91147e30a1 100644 --- a/src/Quantity/Quantity_Momentum.hxx +++ b/src/Quantity/Quantity_Momentum.hxx @@ -19,7 +19,10 @@ #include +//! Defined as the product of mass and velocity. +//! It is a vector quantity. +//! It is measured in kilogram-metres per second. + typedef Standard_Real Quantity_Momentum; - #endif // _Quantity_Momentum_HeaderFile diff --git a/src/Quantity/Quantity_PlaneAngle.hxx b/src/Quantity/Quantity_PlaneAngle.hxx index 91a3511bbb..d2d15dd8dc 100644 --- a/src/Quantity/Quantity_PlaneAngle.hxx +++ b/src/Quantity/Quantity_PlaneAngle.hxx @@ -19,7 +19,8 @@ #include +//! Defined as a difference in direction. +//! It is measured in radians. typedef Standard_Real Quantity_PlaneAngle; - #endif // _Quantity_PlaneAngle_HeaderFile diff --git a/src/Quantity/Quantity_Power.hxx b/src/Quantity/Quantity_Power.hxx index 748b07c289..086fc7b0af 100644 --- a/src/Quantity/Quantity_Power.hxx +++ b/src/Quantity/Quantity_Power.hxx @@ -19,7 +19,14 @@ #include +//! Defined as the rate of expending energy or doing work. +//! In mechanical terms it is the product of a force and +//! the distance it moves per unit time. +//! In electrical terms it is the product of the voltage +//! and the current. For AC the root-mean-square values +//! are multiplied by the cosine of the phase angle. +//! It is measured in watts (joules per second). + typedef Standard_Real Quantity_Power; - #endif // _Quantity_Power_HeaderFile diff --git a/src/Quantity/Quantity_Pressure.hxx b/src/Quantity/Quantity_Pressure.hxx index 4cf4a367d6..3c8e3556bb 100644 --- a/src/Quantity/Quantity_Pressure.hxx +++ b/src/Quantity/Quantity_Pressure.hxx @@ -19,7 +19,11 @@ #include +//! Defined as the force perpendicular to a +//! unit area. In a fluid it is defined as the product +//! of the depth, density, and free fall acceleration. +//! It is measured in pascals (newtons per square metre). + typedef Standard_Real Quantity_Pressure; - #endif // _Quantity_Pressure_HeaderFile diff --git a/src/Quantity/Quantity_Reluctance.hxx b/src/Quantity/Quantity_Reluctance.hxx index 098d304675..8632860245 100644 --- a/src/Quantity/Quantity_Reluctance.hxx +++ b/src/Quantity/Quantity_Reluctance.hxx @@ -19,7 +19,11 @@ #include +//! Defined as the ratio of the magnetomotive force applied +//! to a magnetic circuit to the magnetic flux in the circuit. +//! It is measured in reciprocal henrys. +//! Its reciprocal is permanence. + typedef Standard_Real Quantity_Reluctance; - #endif // _Quantity_Reluctance_HeaderFile diff --git a/src/Quantity/Quantity_Resistance.hxx b/src/Quantity/Quantity_Resistance.hxx index 2ad3c5b336..3dbd542bd9 100644 --- a/src/Quantity/Quantity_Resistance.hxx +++ b/src/Quantity/Quantity_Resistance.hxx @@ -19,7 +19,10 @@ #include +//! Defined as the ratio of the potential difference +//! across a conductor to the current flowing through it. +//! It is measured in ohms. + typedef Standard_Real Quantity_Resistance; - #endif // _Quantity_Resistance_HeaderFile diff --git a/src/Quantity/Quantity_Resistivity.hxx b/src/Quantity/Quantity_Resistivity.hxx index 67580b3bc6..87c4fd681f 100644 --- a/src/Quantity/Quantity_Resistivity.hxx +++ b/src/Quantity/Quantity_Resistivity.hxx @@ -19,7 +19,11 @@ #include +//! Defined as the resistance of a conductor of unit +//! cross-section per unit length. +//! It is measured in Ohm-metres. +//! It is the reciprocal of the conductivity. + typedef Standard_Real Quantity_Resistivity; - #endif // _Quantity_Resistivity_HeaderFile diff --git a/src/Quantity/Quantity_SolidAngle.hxx b/src/Quantity/Quantity_SolidAngle.hxx index 829ca0d8d4..4c3d1d792d 100644 --- a/src/Quantity/Quantity_SolidAngle.hxx +++ b/src/Quantity/Quantity_SolidAngle.hxx @@ -19,7 +19,8 @@ #include +//! Defined as an angle formed by three or more planes. +//! It is measured in steradians. typedef Standard_Real Quantity_SolidAngle; - #endif // _Quantity_SolidAngle_HeaderFile diff --git a/src/Quantity/Quantity_SoundIntensity.hxx b/src/Quantity/Quantity_SoundIntensity.hxx index 59dd21c137..031811b1a7 100644 --- a/src/Quantity/Quantity_SoundIntensity.hxx +++ b/src/Quantity/Quantity_SoundIntensity.hxx @@ -19,7 +19,12 @@ #include +//! Defined as the rate of flow of sound energy through +//! a unit area normal to the flow. It is quantified as the +//! square of the root-mean-square sound pressure, divided by +//! the density of the medium and by the speed of sound. +//! It is measured in watts per square metre. + typedef Standard_Real Quantity_SoundIntensity; - #endif // _Quantity_SoundIntensity_HeaderFile diff --git a/src/Quantity/Quantity_SpecificHeatCapacity.hxx b/src/Quantity/Quantity_SpecificHeatCapacity.hxx index b0f7019461..0b51f4de29 100644 --- a/src/Quantity/Quantity_SpecificHeatCapacity.hxx +++ b/src/Quantity/Quantity_SpecificHeatCapacity.hxx @@ -19,7 +19,17 @@ #include +//! Defined as the quantity of heat required to raise +//! unit mass by one degree temperature. For a gas +//! there are two values: one at constant pressure, the +//! other at constant volume. Their ratio is linked to the +//! speed of sound in the gas and to the number of +//! degrees of freedom of the molecules. +//! It is quantified as energy per unit mass per +//! degree of temperature. +//! It is measured in joules per kilogram per degree +//! kelvin. + typedef Standard_Real Quantity_SpecificHeatCapacity; - #endif // _Quantity_SpecificHeatCapacity_HeaderFile diff --git a/src/Quantity/Quantity_Speed.hxx b/src/Quantity/Quantity_Speed.hxx index 9841e73d96..8fa641bb35 100644 --- a/src/Quantity/Quantity_Speed.hxx +++ b/src/Quantity/Quantity_Speed.hxx @@ -19,7 +19,8 @@ #include +//! Defined as distance covered per unit time. +//! It is measured in metres per second. typedef Standard_Real Quantity_Speed; - #endif // _Quantity_Speed_HeaderFile diff --git a/src/Quantity/Quantity_SurfaceTension.hxx b/src/Quantity/Quantity_SurfaceTension.hxx index 90645909b7..f493bfc539 100644 --- a/src/Quantity/Quantity_SurfaceTension.hxx +++ b/src/Quantity/Quantity_SurfaceTension.hxx @@ -19,7 +19,10 @@ #include +//! Defined as the force required to hold unit length +//! of a plane liquid surface. +//! It is measured in newtons per metre. + typedef Standard_Real Quantity_SurfaceTension; - #endif // _Quantity_SurfaceTension_HeaderFile diff --git a/src/Quantity/Quantity_Temperature.hxx b/src/Quantity/Quantity_Temperature.hxx index 36856e0b9a..9c85e1ab79 100644 --- a/src/Quantity/Quantity_Temperature.hxx +++ b/src/Quantity/Quantity_Temperature.hxx @@ -19,7 +19,9 @@ #include +//! Defined as a measure of the average kinetic energy +//! of the molecules in a body. +//! It is measured in degrees kelvin. typedef Standard_Real Quantity_Temperature; - #endif // _Quantity_Temperature_HeaderFile diff --git a/src/Quantity/Quantity_ThermalConductivity.hxx b/src/Quantity/Quantity_ThermalConductivity.hxx index 8ac16ad38b..b4b9353cc2 100644 --- a/src/Quantity/Quantity_ThermalConductivity.hxx +++ b/src/Quantity/Quantity_ThermalConductivity.hxx @@ -19,7 +19,11 @@ #include +//! Defined as the rate at which heat passes through an +//! area inside a body. Quantified as work per unit time +//! per unit length per unit of temperature. +//! It is measured in watts per metre per degee kelvin. + typedef Standard_Real Quantity_ThermalConductivity; - #endif // _Quantity_ThermalConductivity_HeaderFile diff --git a/src/Quantity/Quantity_Torque.hxx b/src/Quantity/Quantity_Torque.hxx index 5d79533c91..843b9e44f4 100644 --- a/src/Quantity/Quantity_Torque.hxx +++ b/src/Quantity/Quantity_Torque.hxx @@ -19,7 +19,11 @@ #include +//! Defined as the product of a force and the +//! perpendicular distance to an axis or as the +//! the product of a force couple. +//! It is measured in newtons x metres. + typedef Standard_Real Quantity_Torque; - #endif // _Quantity_Torque_HeaderFile diff --git a/src/Quantity/Quantity_Velocity.hxx b/src/Quantity/Quantity_Velocity.hxx index b045bd46f8..e0af14241f 100644 --- a/src/Quantity/Quantity_Velocity.hxx +++ b/src/Quantity/Quantity_Velocity.hxx @@ -19,7 +19,9 @@ #include +//! Defined as distance covered per unit time in a +//! given direction. It is a vector quantity. +//! It is measured in metres per second. typedef Standard_Real Quantity_Velocity; - #endif // _Quantity_Velocity_HeaderFile diff --git a/src/Quantity/Quantity_Viscosity.hxx b/src/Quantity/Quantity_Viscosity.hxx index 19776c1b18..11961afe59 100644 --- a/src/Quantity/Quantity_Viscosity.hxx +++ b/src/Quantity/Quantity_Viscosity.hxx @@ -19,7 +19,12 @@ #include +//! Defined as the resistance to flow in a fluid. +//! It is quantified as the product of pressure +//! and time. For a liquid it generally decreases with +//! temperature; for a gas it increases. +//! It is measured in pascal-seconds. + typedef Standard_Real Quantity_Viscosity; - #endif // _Quantity_Viscosity_HeaderFile diff --git a/src/Quantity/Quantity_Volume.hxx b/src/Quantity/Quantity_Volume.hxx index 3add3454d2..027c79143f 100644 --- a/src/Quantity/Quantity_Volume.hxx +++ b/src/Quantity/Quantity_Volume.hxx @@ -19,7 +19,8 @@ #include +//! Defined as an extension in three dimensions. +//! It is measured in cubic metres. typedef Standard_Real Quantity_Volume; - #endif // _Quantity_Volume_HeaderFile diff --git a/src/Quantity/Quantity_VolumeFlow.hxx b/src/Quantity/Quantity_VolumeFlow.hxx index 42c7bdea78..790be2e416 100644 --- a/src/Quantity/Quantity_VolumeFlow.hxx +++ b/src/Quantity/Quantity_VolumeFlow.hxx @@ -19,7 +19,9 @@ #include +//! Defined as volume per unit time. +//! It is measured in cubic metres per second. + typedef Standard_Real Quantity_VolumeFlow; - #endif // _Quantity_VolumeFlow_HeaderFile diff --git a/src/Quantity/Quantity_Weight.hxx b/src/Quantity/Quantity_Weight.hxx index 83dd649738..73c8597334 100644 --- a/src/Quantity/Quantity_Weight.hxx +++ b/src/Quantity/Quantity_Weight.hxx @@ -19,7 +19,12 @@ #include +//! Defined as the force of gravitation acting on a body +//! near to the surface of the Earth or other planet. +//! It is quantified as the product of the mass of the body +//! and the local value of the acceleration of free fall. +//! It is measured in newtons. + typedef Standard_Real Quantity_Weight; - #endif // _Quantity_Weight_HeaderFile diff --git a/src/Quantity/Quantity_Work.hxx b/src/Quantity/Quantity_Work.hxx index 7a8b6a3d98..1dd2167a4e 100644 --- a/src/Quantity/Quantity_Work.hxx +++ b/src/Quantity/Quantity_Work.hxx @@ -19,7 +19,14 @@ #include +//! In mechanics, the product of a force and the distance +//! moved. In a rotating system, the product of the torque +//! and the angular displacement. In a pressure system, +//! the product of the pressure and the change in volume. +//! In electrical terms, the product of a charge and the +//! potential difference it traverses. +//! It is measured in joules (newton-metres). + typedef Standard_Real Quantity_Work; - #endif // _Quantity_Work_HeaderFile diff --git a/src/Standard/Standard.hxx b/src/Standard/Standard.hxx index bb5364d0a2..3440d77200 100644 --- a/src/Standard/Standard.hxx +++ b/src/Standard/Standard.hxx @@ -24,6 +24,7 @@ #include #include #include + class Standard_ErrorHandlerCallback; class Standard_ErrorHandler; class Standard_GUID; @@ -31,7 +32,8 @@ class Standard_Persistent; class Standard_Transient; class Standard_Failure; - +//! The package Standard provides global memory allocator and other basic +//! services used by other OCCT components. class Standard { @@ -45,9 +47,17 @@ public: Standard_EXPORT static Standard_Address Allocate (const Standard_Size aSize); //! Deallocates memory blocks - //! aStorage - previously allocated memory block to be freed - Standard_EXPORT static void Free (const Standard_Address aStorage); -template static inline void Free (T*& thePtr) { Free ((void*)thePtr); thePtr = 0; } + //! @param thePtr - previously allocated memory block to be freed + Standard_EXPORT static void Free (const Standard_Address thePtr); + + //! Template version of function Free(), nullifies the argument pointer + //! @param thePtr - previously allocated memory block to be freed + template + static inline void Free (T*& thePtr) + { + Free ((void*)thePtr); + thePtr = 0; + } //! Reallocates memory blocks //! aStorage - previously allocated memory block @@ -64,40 +74,22 @@ template static inline void Free (T*& thePtr) { Free ((void*)thePtr //! Deallocates memory blocks //! @param thePtrAligned the memory block previously allocated with AllocateAligned() Standard_EXPORT static void FreeAligned (const Standard_Address thePtrAligned); -template static inline void FreeAligned (T*& thePtrAligned) { FreeAligned ((void* )thePtrAligned); thePtrAligned = 0; } + + //! Template version of function FreeAligned(), nullifies the argument pointer + //! @param thePtrAligned the memory block previously allocated with AllocateAligned() + template + static inline void FreeAligned (T*& thePtrAligned) + { + FreeAligned ((void* )thePtrAligned); + thePtrAligned = 0; + } //! Deallocates the storage retained on the free list //! and clears the list. //! Returns non-zero if some memory has been actually freed. Standard_EXPORT static Standard_Integer Purge(); - - - -protected: - - - - - -private: - - - - -friend class Standard_ErrorHandlerCallback; -friend class Standard_ErrorHandler; -friend class Standard_GUID; -friend class Standard_Persistent; -friend class Standard_Transient; -friend class Standard_Failure; - }; - - - - - #endif // _Standard_HeaderFile diff --git a/src/StepFile/FILES b/src/StepFile/FILES index af4fc8f478..028955f57d 100755 --- a/src/StepFile/FILES +++ b/src/StepFile/FILES @@ -1,10 +1,8 @@ lex.step.c recfile.pc recfile.ph -step.lex step.tab.c step.tab.h -step.yacc StepFile_CallFailure.cxx StepFile_CallFailure.hxx StepFile_Read.cxx diff --git a/src/StepToGeom/StepToGeom_MakeBoundedCurve.cxx b/src/StepToGeom/StepToGeom_MakeBoundedCurve.cxx index 39e3d1b4e3..6883ebc8f0 100644 --- a/src/StepToGeom/StepToGeom_MakeBoundedCurve.cxx +++ b/src/StepToGeom/StepToGeom_MakeBoundedCurve.cxx @@ -17,8 +17,8 @@ //:n6 abv 15.02.99: S4132: adding translation of polyline //:p0 abv 19.02.99: management of 'done' flag improved; trimmed_curve treated -#include #include +#include #include #include #include diff --git a/src/StepToGeom/StepToGeom_MakeBoundedCurve2d.cxx b/src/StepToGeom/StepToGeom_MakeBoundedCurve2d.cxx index 07a7b8d74b..7fd3969080 100644 --- a/src/StepToGeom/StepToGeom_MakeBoundedCurve2d.cxx +++ b/src/StepToGeom/StepToGeom_MakeBoundedCurve2d.cxx @@ -17,7 +17,7 @@ //:n6 abv 15.02.99: S4132: adding translation of polyline //:p0 abv 19.02.99: management of 'done' flag improved -#include +#include #include #include #include diff --git a/src/StepToGeom/StepToGeom_MakeBoundedSurface.cxx b/src/StepToGeom/StepToGeom_MakeBoundedSurface.cxx index 3f33caed05..0fc13ed9ab 100644 --- a/src/StepToGeom/StepToGeom_MakeBoundedSurface.cxx +++ b/src/StepToGeom/StepToGeom_MakeBoundedSurface.cxx @@ -18,8 +18,8 @@ //:j7 abv 05.04.99: S4136: ass-tol2.stp #9861: avoid using CheckSurfaceClosure // rln 02.06.99 removing #include -#include #include +#include #include #include #include diff --git a/src/StepToGeom/StepToGeom_MakeConic.cxx b/src/StepToGeom/StepToGeom_MakeConic.cxx index cc037f45ed..7aea651415 100644 --- a/src/StepToGeom/StepToGeom_MakeConic.cxx +++ b/src/StepToGeom/StepToGeom_MakeConic.cxx @@ -16,7 +16,10 @@ //:p0 abv 19.02.99: management of 'done' flag improved -#include +#include +#include +#include +#include #include #include #include diff --git a/src/StepToGeom/StepToGeom_MakeConic2d.cxx b/src/StepToGeom/StepToGeom_MakeConic2d.cxx index 090b98f571..607ea5372c 100644 --- a/src/StepToGeom/StepToGeom_MakeConic2d.cxx +++ b/src/StepToGeom/StepToGeom_MakeConic2d.cxx @@ -16,7 +16,10 @@ //:p0 abv 19.02.99: management of 'done' flag improved -#include +#include +#include +#include +#include #include #include #include diff --git a/src/StepToGeom/StepToGeom_MakeCurve.cxx b/src/StepToGeom/StepToGeom_MakeCurve.cxx index 36597f98f1..02ff77605a 100644 --- a/src/StepToGeom/StepToGeom_MakeCurve.cxx +++ b/src/StepToGeom/StepToGeom_MakeCurve.cxx @@ -19,9 +19,11 @@ //:o5 abv 17.02.99: bm4_sd_seal_c.stp #58720: translate surface_curve (3d only) //:p0 abv 19.02.99: management of 'done' flag improved -#include +#include #include +#include #include +#include #include #include #include diff --git a/src/StepToGeom/StepToGeom_MakeCurve2d.cxx b/src/StepToGeom/StepToGeom_MakeCurve2d.cxx index bb76c82369..afd82eb0e9 100644 --- a/src/StepToGeom/StepToGeom_MakeCurve2d.cxx +++ b/src/StepToGeom/StepToGeom_MakeCurve2d.cxx @@ -18,7 +18,8 @@ //:p0 abv 19.02.99: management of 'done' flag improved #include -#include +#include +#include #include #include #include diff --git a/src/StepToGeom/StepToGeom_MakeElementarySurface.cxx b/src/StepToGeom/StepToGeom_MakeElementarySurface.cxx index 92e9a9658f..b65d659a34 100644 --- a/src/StepToGeom/StepToGeom_MakeElementarySurface.cxx +++ b/src/StepToGeom/StepToGeom_MakeElementarySurface.cxx @@ -16,7 +16,11 @@ //:p0 abv 19.02.99: management of 'done' flag improved -#include +#include +#include +#include +#include +#include #include #include #include diff --git a/src/StepToGeom/StepToGeom_MakeSurface.cxx b/src/StepToGeom/StepToGeom_MakeSurface.cxx index a35f4d8321..314cc23461 100644 --- a/src/StepToGeom/StepToGeom_MakeSurface.cxx +++ b/src/StepToGeom/StepToGeom_MakeSurface.cxx @@ -21,8 +21,9 @@ #include #include +#include #include -#include +#include #include #include #include diff --git a/src/StepToGeom/StepToGeom_MakeSweptSurface.cxx b/src/StepToGeom/StepToGeom_MakeSweptSurface.cxx index ff6268d0ba..aee1c7a1fe 100644 --- a/src/StepToGeom/StepToGeom_MakeSweptSurface.cxx +++ b/src/StepToGeom/StepToGeom_MakeSweptSurface.cxx @@ -16,7 +16,8 @@ //:p0 abv 19.02.99: management of 'done' flag improved -#include +#include +#include #include #include #include diff --git a/src/TopAbs/TopAbs.hxx b/src/TopAbs/TopAbs.hxx index 51f287338f..1f218ae6b5 100644 --- a/src/TopAbs/TopAbs.hxx +++ b/src/TopAbs/TopAbs.hxx @@ -27,6 +27,22 @@ #include +//! This package gives resources for Topology oriented +//! applications such as : Topological Data Structure, +//! Topological Algorithms. +//! +//! It contains : +//! +//! * The ShapeEnum enumeration to describe the +//! differents topological shapes. +//! +//! * The Orientation enumeration to describe the +//! orientation of a topological shape. +//! +//! * The State enumeration to describes the +//! position of a point relative to a Shape. +//! +//! * Methods to manage the enumerations. class TopAbs { diff --git a/src/TopoDS/TopoDS_FrozenShape.hxx b/src/TopoDS/TopoDS_FrozenShape.hxx index 4804a27526..d711570d43 100644 --- a/src/TopoDS/TopoDS_FrozenShape.hxx +++ b/src/TopoDS/TopoDS_FrozenShape.hxx @@ -22,6 +22,9 @@ #include #include +//! An attempt was made to modify a Shape already +//! shared or protected. + class TopoDS_FrozenShape; DEFINE_STANDARD_HANDLE(TopoDS_FrozenShape, Standard_DomainError) diff --git a/src/TopoDS/TopoDS_LockedShape.hxx b/src/TopoDS/TopoDS_LockedShape.hxx index c8184f895b..9b9c841556 100644 --- a/src/TopoDS/TopoDS_LockedShape.hxx +++ b/src/TopoDS/TopoDS_LockedShape.hxx @@ -22,6 +22,9 @@ #include #include +//! An attempt was made to modify a geometry of Shape already +//! shared or protected. + class TopoDS_LockedShape; DEFINE_STANDARD_HANDLE(TopoDS_LockedShape, Standard_DomainError) diff --git a/src/TopoDS/TopoDS_UnCompatibleShapes.hxx b/src/TopoDS/TopoDS_UnCompatibleShapes.hxx index eb6c367b8d..9f6edf5eb5 100644 --- a/src/TopoDS/TopoDS_UnCompatibleShapes.hxx +++ b/src/TopoDS/TopoDS_UnCompatibleShapes.hxx @@ -22,6 +22,8 @@ #include #include +//! An incorrect insertion was attempted. + class TopoDS_UnCompatibleShapes; DEFINE_STANDARD_HANDLE(TopoDS_UnCompatibleShapes, Standard_DomainError) diff --git a/src/Transfer/Transfer_ProcessForTransient.hxx b/src/Transfer/Transfer_ProcessForTransient.hxx index 614fab0eda..4d5a42c8dc 100644 --- a/src/Transfer/Transfer_ProcessForTransient.hxx +++ b/src/Transfer/Transfer_ProcessForTransient.hxx @@ -47,6 +47,11 @@ class Interface_CheckIterator; class Transfer_ProcessForTransient; DEFINE_STANDARD_HANDLE(Transfer_ProcessForTransient, MMgt_TShared) +//! Manages Transfer of Transient Objects. Produces also +//! ActorOfTransientProcess (deferred class), +//! IteratorOfTransientProcess (for Results), +//! TransferMapOfTransientProcess (internally used) +//! Normally uses as TransientProcess, which adds some specifics class Transfer_ProcessForTransient : public MMgt_TShared { diff --git a/src/V3d/V3d_Coordinate.hxx b/src/V3d/V3d_Coordinate.hxx index f1a4611589..d9dc7e39a8 100644 --- a/src/V3d/V3d_Coordinate.hxx +++ b/src/V3d/V3d_Coordinate.hxx @@ -19,7 +19,8 @@ #include +//! User-defined coordinate in the reference plane of +//! view (Projection or Mapping). typedef Standard_Real V3d_Coordinate; - #endif // _V3d_Coordinate_HeaderFile