OCCT

// Created on: 1995-11-13
// Created by: Jean-Louis Frenkel
// Copyright (c) 1995-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _CDF_Store_HeaderFile
#define _CDF_Store_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <TCollection_ExtendedString.hxx>
#include <PCDM_StoreStatus.hxx>
#include <CDF_StoreSetNameStatus.hxx>
#include <TCollection_HExtendedString.hxx>

#include <Message_ProgressRange.hxx>

class CDF_StoreList;
class CDM_Document;

class CDF_Store
{
public:
  DEFINE_STANDARD_ALLOC

  //! creates a store list from the document of the current selection.
  Standard_EXPORT CDF_Store(const occ::handle<CDM_Document>& aDocument);

  //! returns the folder in which the current document will be stored.
  Standard_EXPORT occ::handle<TCollection_HExtendedString> Folder() const;

  //! returns the name under which the current document will be stored
  Standard_EXPORT occ::handle<TCollection_HExtendedString> Name() const;

  //! returns true if the current document is already stored
  Standard_EXPORT bool IsStored() const;

  Standard_EXPORT bool IsModified() const;

  Standard_EXPORT bool CurrentIsConsistent() const;

  Standard_EXPORT bool IsConsistent() const;

  Standard_EXPORT bool HasAPreviousVersion() const;

  Standard_EXPORT occ::handle<TCollection_HExtendedString> PreviousVersion() const;

  //! returns true if the currentdocument is the main one, ie the document
  //! of the current selection.
  Standard_EXPORT bool IsMainDocument() const;

  //! defines the folder in which the document should be
  //! stored. returns true if the Folder exists,
  //! false otherwise.
  Standard_EXPORT bool SetFolder(const TCollection_ExtendedString& aFolder);

  //! defines the name under which the document should be stored.
  Standard_EXPORT CDF_StoreSetNameStatus SetName(const char16_t* const aName);

  Standard_EXPORT void SetComment(const char16_t* const aComment);

  Standard_EXPORT occ::handle<TCollection_HExtendedString> Comment() const;

  //! defines the name under which the document should be stored.
  //! uses for example after modification of the folder.
  Standard_EXPORT CDF_StoreSetNameStatus RecheckName();

  Standard_EXPORT bool SetPreviousVersion(const char16_t* const aPreviousVersion);

  Standard_EXPORT void Realize(const Message_ProgressRange& theRange = Message_ProgressRange());

  //! returns the complete path of the created meta-data.
  Standard_EXPORT const char16_t* Path() const;

  //! returns the path of the previous store is the object
  //! is already stored, otherwise an empty string;
  Standard_EXPORT occ::handle<TCollection_HExtendedString> MetaDataPath() const;

  //! returns the description of the format of the main object.
  Standard_EXPORT occ::handle<TCollection_HExtendedString> Description() const;

  Standard_EXPORT void SetCurrent(const char16_t* const aPresentation);

  //! the two following methods can be used just after
  //! Realize or Import -- method to know if
  //! these methods worked correctly, and if not why.
  Standard_EXPORT void SetMain();

  Standard_EXPORT PCDM_StoreStatus StoreStatus() const;

  Standard_EXPORT const char16_t* AssociatedStatusText() const;

  //! defines the name under which the document should be stored.
  Standard_EXPORT CDF_StoreSetNameStatus SetName(const TCollection_ExtendedString& aName);

  //! defines the folder in which the document should be
  //! stored. returns true if the Folder exists,
  //! false otherwise.
  Standard_EXPORT bool SetFolder(const char16_t* const aFolder);

private:
  Standard_EXPORT CDF_Store();

  Standard_EXPORT void FindDefault();

  Standard_EXPORT void Init();

  occ::handle<CDF_StoreList> myList;
  occ::handle<CDM_Document>  myMainDocument;
  occ::handle<CDM_Document>  myCurrentDocument;
  bool                       myHasSubComponents;
  bool                       myIsMainDocument;
  TCollection_ExtendedString myPath;
  TCollection_ExtendedString myText;
  PCDM_StoreStatus           myStatus;
};

#endif // _CDF_Store_HeaderFile