include/opencascade/PCDM_ReferenceIterator.hxx

0001 // Created on: 1997-12-01
0002 // Created by: Jean-Louis Frenkel
0003 // Copyright (c) 1997-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 _PCDM_ReferenceIterator_HeaderFile
0018 #define _PCDM_ReferenceIterator_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <PCDM_SequenceOfReference.hxx>
0024 #include <CDM_MetaDataLookUpTable.hxx>
0025
0026 class Message_Messenger;
0027 class CDM_Document;
0028 class CDM_MetaData;
0029 class CDM_Application;
0030
0031 class PCDM_ReferenceIterator;
0032 DEFINE_STANDARD_HANDLE(PCDM_ReferenceIterator, Standard_Transient)
0033
0034
0035 class PCDM_ReferenceIterator : public Standard_Transient
0036 {
0037
0038 public:
0039
0040
0041   //! Warning! The constructor does not initialization.
0042   Standard_EXPORT PCDM_ReferenceIterator(const Handle(Message_Messenger)& theMessageDriver);
0043
0044   Standard_EXPORT void LoadReferences (const Handle(CDM_Document)& aDocument, const Handle(CDM_MetaData)& aMetaData, const Handle(CDM_Application)& anApplication, const Standard_Boolean UseStorageConfiguration);
0045
0046   Standard_EXPORT virtual void Init (const Handle(CDM_MetaData)& aMetaData);
0047
0048
0049
0050
0051   DEFINE_STANDARD_RTTIEXT(PCDM_ReferenceIterator,Standard_Transient)
0052
0053 protected:
0054
0055
0056
0057
0058 private:
0059
0060
0061   Standard_EXPORT virtual Standard_Boolean More() const;
0062
0063   Standard_EXPORT virtual void Next();
0064
0065   Standard_EXPORT virtual Handle(CDM_MetaData) MetaData (CDM_MetaDataLookUpTable& theLookUpTable,
0066                                                          const Standard_Boolean UseStorageConfiguration) const;
0067
0068   Standard_EXPORT virtual Standard_Integer ReferenceIdentifier() const;
0069
0070   //! returns the version of the document in the reference
0071   Standard_EXPORT virtual Standard_Integer DocumentVersion() const;
0072
0073 private:
0074   PCDM_SequenceOfReference myReferences;
0075   Standard_Integer myIterator;
0076   Handle(Message_Messenger) myMessageDriver;
0077 };
0078
0079
0080
0081
0082
0083
0084
0085 #endif // _PCDM_ReferenceIterator_HeaderFile