include/opencascade/StepBasic_GeneralProperty.hxx

0001 // Created on: 2000-05-10
0002 // Created by: Andrey BETENEV
0003 // Copyright (c) 2000-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 _StepBasic_GeneralProperty_HeaderFile
0017 #define _StepBasic_GeneralProperty_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <Standard_Boolean.hxx>
0023 #include <Standard_Transient.hxx>
0024 class TCollection_HAsciiString;
0025
0026 //! Representation of STEP entity GeneralProperty
0027 class StepBasic_GeneralProperty : public Standard_Transient
0028 {
0029
0030 public:
0031   //! Empty constructor
0032   Standard_EXPORT StepBasic_GeneralProperty();
0033
0034   //! Initialize all fields (own and inherited)
0035   Standard_EXPORT void Init(const occ::handle<TCollection_HAsciiString>& aId,
0036                             const occ::handle<TCollection_HAsciiString>& aName,
0037                             const bool                                   hasDescription,
0038                             const occ::handle<TCollection_HAsciiString>& aDescription);
0039
0040   //! Returns field Id
0041   Standard_EXPORT occ::handle<TCollection_HAsciiString> Id() const;
0042
0043   //! Set field Id
0044   Standard_EXPORT void SetId(const occ::handle<TCollection_HAsciiString>& Id);
0045
0046   //! Returns field Name
0047   Standard_EXPORT occ::handle<TCollection_HAsciiString> Name() const;
0048
0049   //! Set field Name
0050   Standard_EXPORT void SetName(const occ::handle<TCollection_HAsciiString>& Name);
0051
0052   //! Returns field Description
0053   Standard_EXPORT occ::handle<TCollection_HAsciiString> Description() const;
0054
0055   //! Set field Description
0056   Standard_EXPORT void SetDescription(const occ::handle<TCollection_HAsciiString>& Description);
0057
0058   //! Returns True if optional field Description is defined
0059   Standard_EXPORT bool HasDescription() const;
0060
0061   DEFINE_STANDARD_RTTIEXT(StepBasic_GeneralProperty, Standard_Transient)
0062
0063 private:
0064   occ::handle<TCollection_HAsciiString> theId;
0065   occ::handle<TCollection_HAsciiString> theName;
0066   occ::handle<TCollection_HAsciiString> theDescription;
0067   bool                                  defDescription;
0068 };
0069
0070 #endif // _StepBasic_GeneralProperty_HeaderFile