include/opencascade/StepBasic_ActionMethod.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_ActionMethod_HeaderFile
0018 #define _StepBasic_ActionMethod_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
0027 //! Representation of STEP entity ActionMethod
0028 class StepBasic_ActionMethod : public Standard_Transient
0029 {
0030
0031 public:
0032   //! Empty constructor
0033   Standard_EXPORT StepBasic_ActionMethod();
0034
0035   //! Initialize all fields (own and inherited)
0036   Standard_EXPORT void Init(const occ::handle<TCollection_HAsciiString>& aName,
0037                             const bool                                   hasDescription,
0038                             const occ::handle<TCollection_HAsciiString>& aDescription,
0039                             const occ::handle<TCollection_HAsciiString>& aConsequence,
0040                             const occ::handle<TCollection_HAsciiString>& aPurpose);
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 Consequence
0058   Standard_EXPORT occ::handle<TCollection_HAsciiString> Consequence() const;
0059
0060   //! Set field Consequence
0061   Standard_EXPORT void SetConsequence(const occ::handle<TCollection_HAsciiString>& Consequence);
0062
0063   //! Returns field Purpose
0064   Standard_EXPORT occ::handle<TCollection_HAsciiString> Purpose() const;
0065
0066   //! Set field Purpose
0067   Standard_EXPORT void SetPurpose(const occ::handle<TCollection_HAsciiString>& Purpose);
0068
0069   DEFINE_STANDARD_RTTIEXT(StepBasic_ActionMethod, Standard_Transient)
0070
0071 private:
0072   occ::handle<TCollection_HAsciiString> theName;
0073   occ::handle<TCollection_HAsciiString> theDescription;
0074   occ::handle<TCollection_HAsciiString> theConsequence;
0075   occ::handle<TCollection_HAsciiString> thePurpose;
0076   bool                                  defDescription;
0077 };
0078
0079 #endif // _StepBasic_ActionMethod_HeaderFile