CFx SDK Documentation  2022 SP0
BcfFile.h
Go to the documentation of this file.
1 // Copyright (C) 2002-2020, Open Design Alliance (the "Alliance").
3 // All rights reserved.
4 //
5 // This software and its documentation and related materials are owned by
6 // the Alliance. The software may only be incorporated into application
7 // programs owned by members of the Alliance, subject to a signed
8 // Membership Agreement and Supplemental Software License Agreement with the
9 // Alliance. The structure and organization of this software are the valuable
10 // trade secrets of the Alliance and its suppliers. The software is also
11 // protected by copyright law and international treaty provisions. Application
12 // programs incorporating this software must include the following statement
13 // with their copyright notices:
14 //
15 // This application incorporates Open Design Alliance software pursuant to a license
16 // agreement with Open Design Alliance.
17 // Open Design Alliance Copyright (C) 2002-2020 by Open Design Alliance.
18 // All rights reserved.
19 //
20 // By use of this software, its documentation or related materials, you
21 // acknowledge and accept the above terms.
23 
24 #ifndef _BFC_FILE_H
25 #define _BFC_FILE_H
26 
27 #include "BcfCommon.h"
28 
29 #include "BcfElement.h"
30 #include "BcfFileAttributesGroup.h"
31 
35 namespace OdBcf {
36 
37  class OdBcfTimeStamp;
39 
44  {
45  public:
50  };
51 
52  class OdBcfSession;
53 
57  class BCF_EXPORT OdBcfFile : public OdBcfElement, protected OdBcfFileData
58  {
59  public:
60 
61  //DOM-IGNORE-BEGIN
63  //DOM-IGNORE-END
64 
69 
75  virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;
76 
82  virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;
83 
88  virtual bool validate() const ODRX_OVERRIDE;
89 
90  DECLARE_ACCESSORS(Filename, OdString, m_filename);
91  DECLARE_ACCESSORS(Reference, OdString, m_reference);
92  DECLARE_ACCESSORS(FileAttributes, OdBcfFileAttributesGroup, m_fileAttributes);
94 
95  OdBcfFile& operator = (const OdBcfFileData& val);
96 
97  //DOM-IGNORE-BEGIN
98  protected:
99 
100  friend OdBcfSession;
101  //DOM-IGNORE-END
102  };
103 
108 
109 } //namespace OdBcf
110 
111 #endif // _BFC_FILE_H
#define DECLARE_ACCESSORS(MethodName, VariableType, VariableName)
Definition: BcfCommon.h:91
#define BCF_EXPORT
#define ODRX_OVERRIDE
OdResult
Definition: OdResult.h:29
OdString m_filename
Definition: BcfFile.h:46
OdBcfFileAttributesGroup m_fileAttributes
Definition: BcfFile.h:48
OdBcfTimeStampPtr m_pDate
Definition: BcfFile.h:49
OdString m_reference
Definition: BcfFile.h:47
virtual bool validate() const ODRX_OVERRIDE
ODRX_DECLARE_MEMBERS(OdBcfFile)
virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE
virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE
OdSmartPtr< OdBcfTimeStamp > OdBcfTimeStampPtr
Definition: BcfComment.h:37