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