include/opencascade/IGESBasic_Name.hxx

0001 // Created on: 1993-01-09
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 _IGESBasic_Name_HeaderFile
0018 #define _IGESBasic_Name_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <IGESData_NameEntity.hxx>
0024 class TCollection_HAsciiString;
0025
0026 class IGESBasic_Name;
0027 DEFINE_STANDARD_HANDLE(IGESBasic_Name, IGESData_NameEntity)
0028
0029 //! defines Name, Type <406> Form <15>
0030 //! in package IGESBasic
0031 //! Used to specify a user defined name
0032 class IGESBasic_Name : public IGESData_NameEntity
0033 {
0034
0035 public:
0036   Standard_EXPORT IGESBasic_Name();
0037
0038   //! This method is used to set the fields of the class Name
0039   //! - nbPropVal  : Number of property values, always = 1
0040   //! - aName      : Stores the Name
0041   Standard_EXPORT void Init(const Standard_Integer                  nbPropVal,
0042                             const Handle(TCollection_HAsciiString)& aName);
0043
0044   //! returns the number of property values, which should be 1
0045   Standard_EXPORT Standard_Integer NbPropertyValues() const;
0046
0047   //! returns the user defined Name
0048   Standard_EXPORT Handle(TCollection_HAsciiString) Value() const Standard_OVERRIDE;
0049
0050   DEFINE_STANDARD_RTTIEXT(IGESBasic_Name, IGESData_NameEntity)
0051
0052 protected:
0053 private:
0054   Standard_Integer                 theNbPropertyValues;
0055   Handle(TCollection_HAsciiString) theName;
0056 };
0057
0058 #endif // _IGESBasic_Name_HeaderFile