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
0026 class IGESBasic_ExternalRefFileName;
0027 DEFINE_STANDARD_HANDLE(IGESBasic_ExternalRefFileName, IGESData_IGESEntity)
0028
0029 //! defines ExternalRefFileName, Type <416> Form <0-2>
0030 //! in package IGESBasic
0031 //! Used when single definition from the reference file is
0032 //! required or for external logical references where an
0033 //! entity in one file relates to an entity in another file
0034 class IGESBasic_ExternalRefFileName : public IGESData_IGESEntity
0035 {
0036
0037 public:
0038
0039
0040   Standard_EXPORT IGESBasic_ExternalRefFileName();
0041
0042   //! This method is used to set the fields of the class
0043   //! ExternalRefFileName
0044   //! - aFileIdent : External Reference File Identifier
0045   //! - anExtName  : External Reference Entity Symbolic Name
0046   Standard_EXPORT void Init (const Handle(TCollection_HAsciiString)& aFileIdent, const Handle(TCollection_HAsciiString)& anExtName);
0047
0048   //! Changes FormNumber to be 2 if <mode> is True (For Entity)
0049   //! or 0 if <mode> is False (For Definition)
0050   Standard_EXPORT void SetForEntity (const Standard_Boolean mode);
0051
0052   //! returns External Reference File Identifier
0053   Standard_EXPORT Handle(TCollection_HAsciiString) FileId() const;
0054
0055   //! returns External Reference Entity Symbolic Name
0056   Standard_EXPORT Handle(TCollection_HAsciiString) ReferenceName() const;
0057
0058
0059
0060
0061   DEFINE_STANDARD_RTTIEXT(IGESBasic_ExternalRefFileName,IGESData_IGESEntity)
0062
0063 protected:
0064
0065
0066
0067
0068 private:
0069
0070
0071   Handle(TCollection_HAsciiString) theExtRefFileIdentifier;
0072   Handle(TCollection_HAsciiString) theExtRefEntitySymbName;
0073
0074
0075 };
0076
0077
0078
0079
0080
0081
0082
0083 #endif // _IGESBasic_ExternalRefFileName_HeaderFile