include/opencascade/IGESBasic_ExternalRefFileName.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( Anand NATRAJAN )
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESBasic_ExternalRefFileName_HeaderFile
0018 #define _IGESBasic_ExternalRefFileName_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <IGESData_IGESEntity.hxx>
0023 class TCollection_HAsciiString;
0024
0025 //! defines ExternalRefFileName, Type <416> Form <0-2>
0026 //! in package IGESBasic
0027 //! Used when single definition from the reference file is
0028 //! required or for external logical references where an
0029 //! entity in one file relates to an entity in another file
0030 class IGESBasic_ExternalRefFileName : public IGESData_IGESEntity
0031 {
0032
0033 public:
0034   Standard_EXPORT IGESBasic_ExternalRefFileName();
0035
0036   //! This method is used to set the fields of the class
0037   //! ExternalRefFileName
0038   //! - aFileIdent : External Reference File Identifier
0039   //! - anExtName  : External Reference Entity Symbolic Name
0040   Standard_EXPORT void Init(const occ::handle<TCollection_HAsciiString>& aFileIdent,
0041                             const occ::handle<TCollection_HAsciiString>& anExtName);
0042
0043   //! Changes FormNumber to be 2 if <mode> is True (For Entity)
0044   //! or 0 if <mode> is False (For Definition)
0045   Standard_EXPORT void SetForEntity(const bool mode);
0046
0047   //! returns External Reference File Identifier
0048   Standard_EXPORT occ::handle<TCollection_HAsciiString> FileId() const;
0049
0050   //! returns External Reference Entity Symbolic Name
0051   Standard_EXPORT occ::handle<TCollection_HAsciiString> ReferenceName() const;
0052
0053   DEFINE_STANDARD_RTTIEXT(IGESBasic_ExternalRefFileName, IGESData_IGESEntity)
0054
0055 private:
0056   occ::handle<TCollection_HAsciiString> theExtRefFileIdentifier;
0057   occ::handle<TCollection_HAsciiString> theExtRefEntitySymbName;
0058 };
0059
0060 #endif // _IGESBasic_ExternalRefFileName_HeaderFile