Bcf_3_0File.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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-2024 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 _BCF_3_0_FILE_H
#define _BCF_3_0_FILE_H
 
#include "BcfCommon.h"
 
#include "BcfElement.h"
#include "Bcf_3_0FileAttributesGroup.h"

namespace OdBcf {
 
  class OdBcfTimeStamp;
  typedef OdSmartPtr<OdBcfTimeStamp> OdBcfTimeStampPtr;
}

namespace OdBcf_3_0 {

  class BCF_3_0_EXPORT OdBcfFileData
  {
  public:
    OdBcfFileData();

    OdString                 m_filename;

    OdBcf::OdBcfTimeStampPtr m_pDate;

    OdString                 m_reference;
    
    OdBcfFileAttributesGroup m_fileAttributes;
  };
 
  class OdBcfSession;

  class BCF_3_0_EXPORT OdBcfFile : public OdBcf::OdBcfElement, protected OdBcfFileData
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfFile);
    //DOM-IGNORE-END

    virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;

    virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;

    void setFilename(const OdString &filenameValue);

    OdString& getFilename();

    const OdString& getFilename() const;

    bool isFilenameUnset() const;

    void setReference(const OdString &referenceValue);

    OdString& getReference();

    const OdString& getReference() const;

    bool isReferenceUnset() const;

    void setFileAttributes(const OdBcfFileAttributesGroup &fileAttributesValue);

    OdBcfFileAttributesGroup& getFileAttributes();

    const OdBcfFileAttributesGroup& getFileAttributes() const;

    bool isFileAttributesUnset() const;

    void setDate(const OdBcf::OdBcfTimeStampPtr &dateValue);

    OdBcf::OdBcfTimeStampPtr& getDate();

    const OdBcf::OdBcfTimeStampPtr& getDate() const;

    bool isDateUnset() const;

    OdBcfFile& operator = (const OdBcfFileData& val);
 
    //DOM-IGNORE-BEGIN
  protected:

    virtual bool validateData() const ODRX_OVERRIDE;
 
    friend OdBcfSession;
    //DOM-IGNORE-END
  };

  typedef OdSmartPtr<OdBcfFile> OdBcfFilePtr;
 
} //namespace OdBcf_3_0
 
#endif // _BCF_3_0_FILE_H