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