src/StepBasic/StepBasic_Document.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_Document_HeaderFile
  17 #define _StepBasic_Document_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 class StepBasic_DocumentType;
  26
  27
  28 class StepBasic_Document;
  29 DEFINE_STANDARD_HANDLE(StepBasic_Document, Standard_Transient)
  30
  31 //! Representation of STEP entity Document
  32 class StepBasic_Document : public Standard_Transient
  33 {
  34
  35 public:
  36
  37
  38   //! Empty constructor
  39   Standard_EXPORT StepBasic_Document();
  40
  41   //! Initialize all fields (own and inherited)
  42   Standard_EXPORT void Init (const Handle(TCollection_HAsciiString)& aId, const Handle(TCollection_HAsciiString)& aName, const Standard_Boolean hasDescription, const Handle(TCollection_HAsciiString)& aDescription, const Handle(StepBasic_DocumentType)& aKind);
  43
  44   //! Returns field Id
  45   Standard_EXPORT Handle(TCollection_HAsciiString) Id() const;
  46
  47   //! Set field Id
  48   Standard_EXPORT void SetId (const Handle(TCollection_HAsciiString)& Id);
  49
  50   //! Returns field Name
  51   Standard_EXPORT Handle(TCollection_HAsciiString) Name() const;
  52
  53   //! Set field Name
  54   Standard_EXPORT void SetName (const Handle(TCollection_HAsciiString)& Name);
  55
  56   //! Returns field Description
  57   Standard_EXPORT Handle(TCollection_HAsciiString) Description() const;
  58
  59   //! Set field Description
  60   Standard_EXPORT void SetDescription (const Handle(TCollection_HAsciiString)& Description);
  61
  62   //! Returns True if optional field Description is defined
  63   Standard_EXPORT Standard_Boolean HasDescription() const;
  64
  65   //! Returns field Kind
  66   Standard_EXPORT Handle(StepBasic_DocumentType) Kind() const;
  67
  68   //! Set field Kind
  69   Standard_EXPORT void SetKind (const Handle(StepBasic_DocumentType)& Kind);
  70
  71
  72
  73
  74   DEFINE_STANDARD_RTTIEXT(StepBasic_Document,Standard_Transient)
  75
  76 protected:
  77
  78
  79
  80
  81 private:
  82
  83
  84   Handle(TCollection_HAsciiString) theId;
  85   Handle(TCollection_HAsciiString) theName;
  86   Handle(TCollection_HAsciiString) theDescription;
  87   Handle(StepBasic_DocumentType) theKind;
  88   Standard_Boolean defDescription;
  89
  90
  91 };
  92
  93
  94
  95
  96
  97
  98
  99 #endif // _StepBasic_Document_HeaderFile