include/opencascade/StepBasic_Action.hxx

0001 // Created on: 1999-11-26
0002 // Created by: Andrey BETENEV
0003 // Copyright (c) 1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _StepBasic_Action_HeaderFile
0018 #define _StepBasic_Action_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Boolean.hxx>
0024 #include <Standard_Transient.hxx>
0025 class TCollection_HAsciiString;
0026 class StepBasic_ActionMethod;
0027
0028 //! Representation of STEP entity Action
0029 class StepBasic_Action : public Standard_Transient
0030 {
0031
0032 public:
0033   //! Empty constructor
0034   Standard_EXPORT StepBasic_Action();
0035
0036   //! Initialize all fields (own and inherited)
0037   Standard_EXPORT void Init(const occ::handle<TCollection_HAsciiString>& aName,
0038                             const bool                                   hasDescription,
0039                             const occ::handle<TCollection_HAsciiString>& aDescription,
0040                             const occ::handle<StepBasic_ActionMethod>&   aChosenMethod);
0041
0042   //! Returns field Name
0043   Standard_EXPORT occ::handle<TCollection_HAsciiString> Name() const;
0044
0045   //! Set field Name
0046   Standard_EXPORT void SetName(const occ::handle<TCollection_HAsciiString>& Name);
0047
0048   //! Returns field Description
0049   Standard_EXPORT occ::handle<TCollection_HAsciiString> Description() const;
0050
0051   //! Set field Description
0052   Standard_EXPORT void SetDescription(const occ::handle<TCollection_HAsciiString>& Description);
0053
0054   //! Returns True if optional field Description is defined
0055   Standard_EXPORT bool HasDescription() const;
0056
0057   //! Returns field ChosenMethod
0058   Standard_EXPORT occ::handle<StepBasic_ActionMethod> ChosenMethod() const;
0059
0060   //! Set field ChosenMethod
0061   Standard_EXPORT void SetChosenMethod(const occ::handle<StepBasic_ActionMethod>& ChosenMethod);
0062
0063   DEFINE_STANDARD_RTTIEXT(StepBasic_Action, Standard_Transient)
0064
0065 private:
0066   occ::handle<TCollection_HAsciiString> theName;
0067   occ::handle<TCollection_HAsciiString> theDescription;
0068   occ::handle<StepBasic_ActionMethod>   theChosenMethod;
0069   bool                                  defDescription;
0070 };
0071
0072 #endif // _StepBasic_Action_HeaderFile