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
0028 class StepBasic_ActionMethod;
0029 DEFINE_STANDARD_HANDLE(StepBasic_ActionMethod, Standard_Transient)
0030
0031 //! Representation of STEP entity ActionMethod
0032 class StepBasic_ActionMethod : public Standard_Transient
0033 {
0034
0035 public:
0036
0037
0038   //! Empty constructor
0039   Standard_EXPORT StepBasic_ActionMethod();
0040
0041   //! Initialize all fields (own and inherited)
0042   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);
0043
0044   //! Returns field Name
0045   Standard_EXPORT Handle(TCollection_HAsciiString) Name() const;
0046
0047   //! Set field Name
0048   Standard_EXPORT void SetName (const Handle(TCollection_HAsciiString)& Name);
0049
0050   //! Returns field Description
0051   Standard_EXPORT Handle(TCollection_HAsciiString) Description() const;
0052
0053   //! Set field Description
0054   Standard_EXPORT void SetDescription (const Handle(TCollection_HAsciiString)& Description);
0055
0056   //! Returns True if optional field Description is defined
0057   Standard_EXPORT Standard_Boolean HasDescription() const;
0058
0059   //! Returns field Consequence
0060   Standard_EXPORT Handle(TCollection_HAsciiString) Consequence() const;
0061
0062   //! Set field Consequence
0063   Standard_EXPORT void SetConsequence (const Handle(TCollection_HAsciiString)& Consequence);
0064
0065   //! Returns field Purpose
0066   Standard_EXPORT Handle(TCollection_HAsciiString) Purpose() const;
0067
0068   //! Set field Purpose
0069   Standard_EXPORT void SetPurpose (const Handle(TCollection_HAsciiString)& Purpose);
0070
0071
0072
0073
0074   DEFINE_STANDARD_RTTIEXT(StepBasic_ActionMethod,Standard_Transient)
0075
0076 protected:
0077
0078
0079
0080
0081 private:
0082
0083
0084   Handle(TCollection_HAsciiString) theName;
0085   Handle(TCollection_HAsciiString) theDescription;
0086   Handle(TCollection_HAsciiString) theConsequence;
0087   Handle(TCollection_HAsciiString) thePurpose;
0088   Standard_Boolean defDescription;
0089
0090
0091 };
0092
0093
0094
0095
0096
0097
0098
0099 #endif // _StepBasic_ActionMethod_HeaderFile