src/IGESBasic/IGESBasic_Name.hxx

   1 // Created on: 1993-01-09
   2 // Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESBasic_Name_HeaderFile
  18 #define _IGESBasic_Name_HeaderFile
  19
  20 #include <Standard.hxx>
  21
  22 #include <Standard_Integer.hxx>
  23 #include <IGESData_NameEntity.hxx>
  24 class TCollection_HAsciiString;
  25
  26
  27 class IGESBasic_Name;
  28 DEFINE_STANDARD_HANDLE(IGESBasic_Name, IGESData_NameEntity)
  29
  30 //! defines Name, Type <406> Form <15>
  31 //! in package IGESBasic
  32 //! Used to specify a user defined name
  33 class IGESBasic_Name : public IGESData_NameEntity
  34 {
  35
  36 public:
  37
  38
  39   Standard_EXPORT IGESBasic_Name();
  40
  41   //! This method is used to set the fields of the class Name
  42   //! - nbPropVal  : Number of property values, always = 1
  43   //! - aName      : Stores the Name
  44   Standard_EXPORT void Init (const Standard_Integer nbPropVal, const Handle(TCollection_HAsciiString)& aName);
  45
  46   //! returns the number of property values, which should be 1
  47   Standard_EXPORT Standard_Integer NbPropertyValues() const;
  48
  49   //! returns the user defined Name
  50   Standard_EXPORT Handle(TCollection_HAsciiString) Value() const Standard_OVERRIDE;
  51
  52
  53
  54
  55   DEFINE_STANDARD_RTTIEXT(IGESBasic_Name,IGESData_NameEntity)
  56
  57 protected:
  58
  59
  60
  61
  62 private:
  63
  64
  65   Standard_Integer theNbPropertyValues;
  66   Handle(TCollection_HAsciiString) theName;
  67
  68
  69 };
  70
  71
  72
  73
  74
  75
  76
  77 #endif // _IGESBasic_Name_HeaderFile