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