src/StepBasic/StepBasic_ActionMethod.hxx

   1 // Created on: 1999-11-26
   2 // Created by: Andrey BETENEV
   3 // Copyright (c) 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 _StepBasic_ActionMethod_HeaderFile
  18 #define _StepBasic_ActionMethod_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Boolean.hxx>
  24 #include <Standard_Transient.hxx>
  25 class TCollection_HAsciiString;
  26
  27
  28 class StepBasic_ActionMethod;
  29 DEFINE_STANDARD_HANDLE(StepBasic_ActionMethod, Standard_Transient)
  30
  31 //! Representation of STEP entity ActionMethod
  32 class StepBasic_ActionMethod : public Standard_Transient
  33 {
  34
  35 public:
  36
  37
  38   //! Empty constructor
  39   Standard_EXPORT StepBasic_ActionMethod();
  40
  41   //! Initialize all fields (own and inherited)
  42   Standard_EXPORT void Init (const Handle(TCollection_HAsciiString)& aName, const Standard_Boolean hasDescription, const Handle(TCollection_HAsciiString)& aDescription, const Handle(TCollection_HAsciiString)& aConsequence, const Handle(TCollection_HAsciiString)& aPurpose);
  43
  44   //! Returns field Name
  45   Standard_EXPORT Handle(TCollection_HAsciiString) Name() const;
  46
  47   //! Set field Name
  48   Standard_EXPORT void SetName (const Handle(TCollection_HAsciiString)& Name);
  49
  50   //! Returns field Description
  51   Standard_EXPORT Handle(TCollection_HAsciiString) Description() const;
  52
  53   //! Set field Description
  54   Standard_EXPORT void SetDescription (const Handle(TCollection_HAsciiString)& Description);
  55
  56   //! Returns True if optional field Description is defined
  57   Standard_EXPORT Standard_Boolean HasDescription() const;
  58
  59   //! Returns field Consequence
  60   Standard_EXPORT Handle(TCollection_HAsciiString) Consequence() const;
  61
  62   //! Set field Consequence
  63   Standard_EXPORT void SetConsequence (const Handle(TCollection_HAsciiString)& Consequence);
  64
  65   //! Returns field Purpose
  66   Standard_EXPORT Handle(TCollection_HAsciiString) Purpose() const;
  67
  68   //! Set field Purpose
  69   Standard_EXPORT void SetPurpose (const Handle(TCollection_HAsciiString)& Purpose);
  70
  71
  72
  73
  74   DEFINE_STANDARD_RTTIEXT(StepBasic_ActionMethod,Standard_Transient)
  75
  76 protected:
  77
  78
  79
  80
  81 private:
  82
  83
  84   Handle(TCollection_HAsciiString) theName;
  85   Handle(TCollection_HAsciiString) theDescription;
  86   Handle(TCollection_HAsciiString) theConsequence;
  87   Handle(TCollection_HAsciiString) thePurpose;
  88   Standard_Boolean defDescription;
  89
  90
  91 };
  92
  93
  94
  95
  96
  97
  98
  99 #endif // _StepBasic_ActionMethod_HeaderFile