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
0027 class IGESAppli_LevelFunction;
0028 DEFINE_STANDARD_HANDLE(IGESAppli_LevelFunction, IGESData_IGESEntity)
0029
0030 //! defines LevelFunction, Type <406> Form <3>
0031 //! in package IGESAppli
0032 //! Used to transfer the meaning or intended use of a level
0033 //! in the sending system
0034 class IGESAppli_LevelFunction : public IGESData_IGESEntity
0035 {
0036
0037 public:
0038
0039
0040   Standard_EXPORT IGESAppli_LevelFunction();
0041
0042   //! This method is used to set the fields of the class
0043   //! LevelFunction
0044   //! - nbPropVal    : Number of Properties, always = 2
0045   //! - aCode        : Function Description code
0046   //! default = 0
0047   //! - aFuncDescrip : Function Description
0048   //! default = null string
0049   Standard_EXPORT void Init (const Standard_Integer nbPropVal, const Standard_Integer aCode, const Handle(TCollection_HAsciiString)& aFuncDescrip);
0050
0051   //! is always 2
0052   Standard_EXPORT Standard_Integer NbPropertyValues() const;
0053
0054   //! returns the function description code . Default = 0
0055   Standard_EXPORT Standard_Integer FuncDescriptionCode() const;
0056
0057   //! returns the function description
0058   //! Default = null string
0059   Standard_EXPORT Handle(TCollection_HAsciiString) FuncDescription() const;
0060
0061
0062
0063
0064   DEFINE_STANDARD_RTTIEXT(IGESAppli_LevelFunction,IGESData_IGESEntity)
0065
0066 protected:
0067
0068
0069
0070
0071 private:
0072
0073
0074   Standard_Integer theNbPropertyValues;
0075   Standard_Integer theFuncDescripCode;
0076   Handle(TCollection_HAsciiString) theFuncDescrip;
0077
0078
0079 };
0080
0081
0082
0083
0084
0085
0086
0087 #endif // _IGESAppli_LevelFunction_HeaderFile