src/StepBasic/StepBasic_CharacterizedObject.hxx

   1 // Created on: 2000-05-11
   2 // Created by: data exchange team
   3 // Copyright (c) 2000-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _StepBasic_CharacterizedObject_HeaderFile
  17 #define _StepBasic_CharacterizedObject_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_Type.hxx>
  21
  22 #include <Standard_Boolean.hxx>
  23 #include <Standard_Transient.hxx>
  24 class TCollection_HAsciiString;
  25
  26
  27 class StepBasic_CharacterizedObject;
  28 DEFINE_STANDARD_HANDLE(StepBasic_CharacterizedObject, Standard_Transient)
  29
  30 //! Representation of STEP entity CharacterizedObject
  31 class StepBasic_CharacterizedObject : public Standard_Transient
  32 {
  33
  34 public:
  35
  36
  37   //! Empty constructor
  38   Standard_EXPORT StepBasic_CharacterizedObject();
  39
  40   //! Initialize all fields (own and inherited)
  41   Standard_EXPORT void Init (const Handle(TCollection_HAsciiString)& aName, const Standard_Boolean hasDescription, const Handle(TCollection_HAsciiString)& aDescription);
  42
  43   //! Returns field Name
  44   Standard_EXPORT Handle(TCollection_HAsciiString) Name() const;
  45
  46   //! Set field Name
  47   Standard_EXPORT void SetName (const Handle(TCollection_HAsciiString)& Name);
  48
  49   //! Returns field Description
  50   Standard_EXPORT Handle(TCollection_HAsciiString) Description() const;
  51
  52   //! Set field Description
  53   Standard_EXPORT void SetDescription (const Handle(TCollection_HAsciiString)& Description);
  54
  55   //! Returns True if optional field Description is defined
  56   Standard_EXPORT Standard_Boolean HasDescription() const;
  57
  58
  59
  60
  61   DEFINE_STANDARD_RTTIEXT(StepBasic_CharacterizedObject,Standard_Transient)
  62
  63 protected:
  64
  65
  66
  67
  68 private:
  69
  70
  71   Handle(TCollection_HAsciiString) theName;
  72   Handle(TCollection_HAsciiString) theDescription;
  73   Standard_Boolean defDescription;
  74
  75
  76 };
  77
  78
  79
  80
  81
  82
  83
  84 #endif // _StepBasic_CharacterizedObject_HeaderFile