1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-07-30 13:05:50 +03:00
occt/src/IGESDefs/IGESDefs_UnitsData.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

92 lines
3.6 KiB
Plaintext
Executable File

-- Created on: 1993-01-13
-- Created by: CKY / Contract Toubro-Larsen ( Deepak PRABHU )
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
class UnitsData from IGESDefs inherits IGESEntity
---Purpose: defines IGES UnitsData Entity, Type <316> Form <0>
-- in package IGESDefs
-- This class stores data about a model's fundamental units.
uses
HAsciiString from TCollection,
HArray1OfReal from TColStd,
HArray1OfHAsciiString from Interface
raises DimensionMismatch, OutOfRange
is
Create returns mutable UnitsData;
-- Specific methods for the entity
Init (me : mutable;
unitTypes : HArray1OfHAsciiString;
unitValues : HArray1OfHAsciiString;
unitScales : HArray1OfReal)
raises DimensionMismatch;
---Purpose : This method is used to set the fields of the class
-- UnitsData
-- - unitTypes : Types of the units being defined
-- - unitValues : Unit Values of the units
-- - unitScales : Multiplicative Scale Factors
-- raises exception if lengths of unitTypes, unitValues and
-- unitScale are not same
NbUnits(me) returns Integer;
---Purpose : returns the Number of units defined by this entity
UnitType(me ; UnitNum : Integer) returns HAsciiString from TCollection
raises OutOfRange;
---Purpose : returns the Type of the UnitNum'th unit being defined
-- raises exception if UnitNum <= 0 or UnitNum > NbUnits()
UnitValue(me ; UnitNum : Integer) returns HAsciiString from TCollection
raises OutOfRange;
---Purpose : returns the Units of the UnitNum'th unit being defined
-- raises exception if UnitNum <= 0 or UnitNum > NbUnits()
ScaleFactor(me ; UnitNum : Integer) returns Real
raises OutOfRange;
---Purpose : returns the multiplicative scale factor to be apllied to the
-- UnitNum'th unit being defined
-- raises exception if UnitNum <= 0 or UnitNum > NbUnits()
fields
--
-- Class : IGESDefs_UnitsData
--
-- Purpose : Declaration of variables specific to UnitsData
--
-- Reminder : An UnitsData Entity stores data about a model's
-- fundamental units. It consists of no. of data strings.
-- The entity then contains records, each of which
-- contains a pair of string variables and a real
-- scale factor.
theUnitTypes : HArray1OfHAsciiString;
theUnitValues : HArray1OfHAsciiString;
theUnitScales : HArray1OfReal;
end UnitsData;