include/opencascade/StepElement_ElementDescriptor.hxx

0001 // Created on: 2002-12-12
0002 // Created by: data exchange team
0003 // Copyright (c) 2002-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _StepElement_ElementDescriptor_HeaderFile
0017 #define _StepElement_ElementDescriptor_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <StepElement_ElementOrder.hxx>
0023 #include <Standard_Transient.hxx>
0024 class TCollection_HAsciiString;
0025
0026 //! Representation of STEP entity ElementDescriptor
0027 class StepElement_ElementDescriptor : public Standard_Transient
0028 {
0029
0030 public:
0031   //! Empty constructor
0032   Standard_EXPORT StepElement_ElementDescriptor();
0033
0034   //! Initialize all fields (own and inherited)
0035   Standard_EXPORT void Init(const StepElement_ElementOrder               aTopologyOrder,
0036                             const occ::handle<TCollection_HAsciiString>& aDescription);
0037
0038   //! Returns field TopologyOrder
0039   Standard_EXPORT StepElement_ElementOrder TopologyOrder() const;
0040
0041   //! Set field TopologyOrder
0042   Standard_EXPORT void SetTopologyOrder(const StepElement_ElementOrder TopologyOrder);
0043
0044   //! Returns field Description
0045   Standard_EXPORT occ::handle<TCollection_HAsciiString> Description() const;
0046
0047   //! Set field Description
0048   Standard_EXPORT void SetDescription(const occ::handle<TCollection_HAsciiString>& Description);
0049
0050   DEFINE_STANDARD_RTTIEXT(StepElement_ElementDescriptor, Standard_Transient)
0051
0052 private:
0053   StepElement_ElementOrder              theTopologyOrder;
0054   occ::handle<TCollection_HAsciiString> theDescription;
0055 };
0056
0057 #endif // _StepElement_ElementDescriptor_HeaderFile