include/opencascade/IGESAppli_LevelFunction.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESAppli_LevelFunction_HeaderFile
0018 #define _IGESAppli_LevelFunction_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <IGESData_IGESEntity.hxx>
0024 class TCollection_HAsciiString;
0025
0026 //! defines LevelFunction, Type <406> Form <3>
0027 //! in package IGESAppli
0028 //! Used to transfer the meaning or intended use of a level
0029 //! in the sending system
0030 class IGESAppli_LevelFunction : public IGESData_IGESEntity
0031 {
0032
0033 public:
0034   Standard_EXPORT IGESAppli_LevelFunction();
0035
0036   //! This method is used to set the fields of the class
0037   //! LevelFunction
0038   //! - nbPropVal    : Number of Properties, always = 2
0039   //! - aCode        : Function Description code
0040   //! default = 0
0041   //! - aFuncDescrip : Function Description
0042   //! default = null string
0043   Standard_EXPORT void Init(const int                                    nbPropVal,
0044                             const int                                    aCode,
0045                             const occ::handle<TCollection_HAsciiString>& aFuncDescrip);
0046
0047   //! is always 2
0048   Standard_EXPORT int NbPropertyValues() const;
0049
0050   //! returns the function description code. Default = 0
0051   Standard_EXPORT int FuncDescriptionCode() const;
0052
0053   //! returns the function description
0054   //! Default = null string
0055   Standard_EXPORT occ::handle<TCollection_HAsciiString> FuncDescription() const;
0056
0057   DEFINE_STANDARD_RTTIEXT(IGESAppli_LevelFunction, IGESData_IGESEntity)
0058
0059 private:
0060   int                                   theNbPropertyValues;
0061   int                                   theFuncDescripCode;
0062   occ::handle<TCollection_HAsciiString> theFuncDescrip;
0063 };
0064
0065 #endif // _IGESAppli_LevelFunction_HeaderFile