include/opencascade/StepBasic_Document.hxx

0001 // Created on: 2000-05-11
0002 // Created by: data exchange team
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_Document_HeaderFile
0017 #define _StepBasic_Document_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 class StepBasic_DocumentType;
0026
0027
0028 class StepBasic_Document;
0029 DEFINE_STANDARD_HANDLE(StepBasic_Document, Standard_Transient)
0030
0031 //! Representation of STEP entity Document
0032 class StepBasic_Document : public Standard_Transient
0033 {
0034
0035 public:
0036
0037
0038   //! Empty constructor
0039   Standard_EXPORT StepBasic_Document();
0040
0041   //! Initialize all fields (own and inherited)
0042   Standard_EXPORT void Init (const Handle(TCollection_HAsciiString)& aId, const Handle(TCollection_HAsciiString)& aName, const Standard_Boolean hasDescription, const Handle(TCollection_HAsciiString)& aDescription, const Handle(StepBasic_DocumentType)& aKind);
0043
0044   //! Returns field Id
0045   Standard_EXPORT Handle(TCollection_HAsciiString) Id() const;
0046
0047   //! Set field Id
0048   Standard_EXPORT void SetId (const Handle(TCollection_HAsciiString)& Id);
0049
0050   //! Returns field Name
0051   Standard_EXPORT Handle(TCollection_HAsciiString) Name() const;
0052
0053   //! Set field Name
0054   Standard_EXPORT void SetName (const Handle(TCollection_HAsciiString)& Name);
0055
0056   //! Returns field Description
0057   Standard_EXPORT Handle(TCollection_HAsciiString) Description() const;
0058
0059   //! Set field Description
0060   Standard_EXPORT void SetDescription (const Handle(TCollection_HAsciiString)& Description);
0061
0062   //! Returns True if optional field Description is defined
0063   Standard_EXPORT Standard_Boolean HasDescription() const;
0064
0065   //! Returns field Kind
0066   Standard_EXPORT Handle(StepBasic_DocumentType) Kind() const;
0067
0068   //! Set field Kind
0069   Standard_EXPORT void SetKind (const Handle(StepBasic_DocumentType)& Kind);
0070
0071
0072
0073
0074   DEFINE_STANDARD_RTTIEXT(StepBasic_Document,Standard_Transient)
0075
0076 protected:
0077
0078
0079
0080
0081 private:
0082
0083
0084   Handle(TCollection_HAsciiString) theId;
0085   Handle(TCollection_HAsciiString) theName;
0086   Handle(TCollection_HAsciiString) theDescription;
0087   Handle(StepBasic_DocumentType) theKind;
0088   Standard_Boolean defDescription;
0089
0090
0091 };
0092
0093
0094
0095
0096
0097
0098
0099 #endif // _StepBasic_Document_HeaderFile