/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#ifndef __TNW_FILEINFO_H__
#define __TNW_FILEINFO_H__

#include "NwSavedGroupItem.h"
#include "NwSheetType.h"

class OdNwPropertyAttribute;
typedef OdSmartPtr<OdNwPropertyAttribute> OdNwPropertyAttributePtr;

/** \details
  This class represents saved viewpoint animations.

  <group OdNw_Classes>
*/
class NWDBEXPORT OdNwFileInfo : public OdNwSavedGroupItem
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwFileInfo);
  //DOM-IGNORE-END

public:
  /** \details
    Default constructor. Creates a new object of the OdNwFileInfo class.
  */
  OdNwFileInfo();

public:
  
  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwFileInfo();

public:
  /** \details
    Returns the index of the sheet by Id.

    \returns Returns the index of the sheet by Id. On fail it returns -1.
  */
  OdInt32 getIndexOfSheetId(const OdString& sheetId) const;
  /** \details
    Returns the id of current sheet.

    \returns Returns OdString representation of current sheet.
  */
  OdString getCurrentSheet() const;
  /** \details
    Returns source GUID for the document.

    \returns Returns OdGUID object for source GUID of the document.
  */
  OdGUID getSourceGuid() const;
  /** \details
    Returns the properties of file info.

    \param aAttributes  [out] OdArray with smart pointers to attributes.

    \returns eOk if the operation is successful, or an appropriate error code
    otherwise.
  */
  OdResult getAttributes(OdArray<OdNwPropertyAttributePtr>& aAttributes) const;

  /** \details
    Adds a new sheet to the sheets collection of the database.

    \param sSheetId [in] String with the unique sheet string identifier.
    \param sDisplayName [in] String with the display name of new sheet.
    \param sheetType [in] sheet type of new sheet.
    \param pResCode [out] Receives eOk if the sheet is added successfully, or an appropriate error code otherwise.

    \returns ID of the new OdNwSheetInfo object if successful, or null pointer otherwise.

    \remarks
    sheetType can be one of the following:

    <table>
    Name                              Value   Description
    NwSheetType::Sheet3d              0       SI meter. 3D type of sheet.
    NwSheetType::Sheet2d              1       2D type of sheet.
    </table>

    Appending of NwSheetType::Sheet2d is not implemented yet.
  */
  OdNwObjectId addSheet(const OdString& sSheetId, const OdString& sDisplayName, NwSheetType::Enum sheetType, OdResult* pResCode = NULL);
};

typedef OdSmartPtr<OdNwFileInfo> OdNwFileInfoPtr;

#endif //__TNW_FILEINFO_H__