1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-26 11:05:31 +03:00
occt/src/IGESDefs/IGESDefs_UnitsData.hxx
luz paz 21c7c45701 0031939: Coding - correction of spelling errors in comments
Fix various typos

Fixed via `codespell v2.0.dev`
2020-11-21 12:19:49 +03:00

99 lines
3.1 KiB
C++

// Created on: 1993-01-13
// Created by: CKY / Contract Toubro-Larsen ( Deepak PRABHU )
// Copyright (c) 1993-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.
#ifndef _IGESDefs_UnitsData_HeaderFile
#define _IGESDefs_UnitsData_HeaderFile
#include <Standard.hxx>
#include <Standard_Type.hxx>
#include <Interface_HArray1OfHAsciiString.hxx>
#include <TColStd_HArray1OfReal.hxx>
#include <IGESData_IGESEntity.hxx>
#include <Standard_Integer.hxx>
#include <Standard_Real.hxx>
class Standard_DimensionMismatch;
class Standard_OutOfRange;
class TCollection_HAsciiString;
class IGESDefs_UnitsData;
DEFINE_STANDARD_HANDLE(IGESDefs_UnitsData, IGESData_IGESEntity)
//! defines IGES UnitsData Entity, Type <316> Form <0>
//! in package IGESDefs
//! This class stores data about a model's fundamental units.
class IGESDefs_UnitsData : public IGESData_IGESEntity
{
public:
Standard_EXPORT IGESDefs_UnitsData();
//! 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
Standard_EXPORT void Init (const Handle(Interface_HArray1OfHAsciiString)& unitTypes, const Handle(Interface_HArray1OfHAsciiString)& unitValues, const Handle(TColStd_HArray1OfReal)& unitScales);
//! returns the Number of units defined by this entity
Standard_EXPORT Standard_Integer NbUnits() const;
//! returns the Type of the UnitNum'th unit being defined
//! raises exception if UnitNum <= 0 or UnitNum > NbUnits()
Standard_EXPORT Handle(TCollection_HAsciiString) UnitType (const Standard_Integer UnitNum) const;
//! returns the Units of the UnitNum'th unit being defined
//! raises exception if UnitNum <= 0 or UnitNum > NbUnits()
Standard_EXPORT Handle(TCollection_HAsciiString) UnitValue (const Standard_Integer UnitNum) const;
//! returns the multiplicative scale factor to be applied to the
//! UnitNum'th unit being defined
//! raises exception if UnitNum <= 0 or UnitNum > NbUnits()
Standard_EXPORT Standard_Real ScaleFactor (const Standard_Integer UnitNum) const;
DEFINE_STANDARD_RTTIEXT(IGESDefs_UnitsData,IGESData_IGESEntity)
protected:
private:
Handle(Interface_HArray1OfHAsciiString) theUnitTypes;
Handle(Interface_HArray1OfHAsciiString) theUnitValues;
Handle(TColStd_HArray1OfReal) theUnitScales;
};
#endif // _IGESDefs_UnitsData_HeaderFile