include/opencascade/StepBasic_DocumentFile.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_DocumentFile_HeaderFile
0017 #define _StepBasic_DocumentFile_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <StepBasic_Document.hxx>
0023 class StepBasic_CharacterizedObject;
0024 class TCollection_HAsciiString;
0025 class StepBasic_DocumentType;
0026
0027 //! Representation of STEP entity DocumentFile
0028 class StepBasic_DocumentFile : public StepBasic_Document
0029 {
0030
0031 public:
0032   //! Empty constructor
0033   Standard_EXPORT StepBasic_DocumentFile();
0034
0035   //! Initialize all fields (own and inherited)
0036   Standard_EXPORT void Init(
0037     const occ::handle<TCollection_HAsciiString>& aDocument_Id,
0038     const occ::handle<TCollection_HAsciiString>& aDocument_Name,
0039     const bool                                   hasDocument_Description,
0040     const occ::handle<TCollection_HAsciiString>& aDocument_Description,
0041     const occ::handle<StepBasic_DocumentType>&   aDocument_Kind,
0042     const occ::handle<TCollection_HAsciiString>& aCharacterizedObject_Name,
0043     const bool                                   hasCharacterizedObject_Description,
0044     const occ::handle<TCollection_HAsciiString>& aCharacterizedObject_Description);
0045
0046   //! Returns data for supertype CharacterizedObject
0047   Standard_EXPORT occ::handle<StepBasic_CharacterizedObject> CharacterizedObject() const;
0048
0049   //! Set data for supertype CharacterizedObject
0050   Standard_EXPORT void SetCharacterizedObject(
0051     const occ::handle<StepBasic_CharacterizedObject>& CharacterizedObject);
0052
0053   DEFINE_STANDARD_RTTIEXT(StepBasic_DocumentFile, StepBasic_Document)
0054
0055 private:
0056   occ::handle<StepBasic_CharacterizedObject> theCharacterizedObject;
0057 };
0058
0059 #endif // _StepBasic_DocumentFile_HeaderFile