CFx SDK Documentation  2023 SP0
BcfComment.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_COMMENT_H
25 #define _BFC_COMMENT_H
26 
27 #include "BcfCommon.h"
28 #include "OdGUID.h"
29 
30 #include "BcfElement.h"
31 
35 namespace OdBcf {
36 
37  class OdBcfTimeStamp;
39 
40  class OdBcfGUIDAttribute;
42 
47  {
48  public:
49 
50  //DOM-IGNORE-BEGIN
52  //DOM-IGNORE-END
53 
58 
64  virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;
65 
71  virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;
72 
77  virtual bool validate() const ODRX_OVERRIDE;
78 
80  DECLARE_CONST_ACCESSORS(Author, OdString, m_author);
81  DECLARE_ACCESSORS( Comment, OdString, m_comment);
82  DECLARE_ACCESSORS( Viewpoint, OdBcfGUIDAttributePtr, m_pViewpoint);
83  DECLARE_ACCESSORS( ModifiedDate, OdBcfTimeStampPtr, m_pModifiedDate);
84  DECLARE_ACCESSORS( ModifiedAuthor, OdString, m_modifiedAuthor);
86 
87  //DOM-IGNORE-BEGIN
88  protected:
90  OdString m_author;
91  OdString m_comment;
92  OdBcfGUIDAttributePtr m_pViewpoint;
93  OdBcfTimeStampPtr m_pModifiedDate;
94  OdString m_modifiedAuthor;
95  OdGUID m_guid;
96 
97  DECLARE_GET( Date, OdBcfTimeStampPtr, m_pDate);
98  DECLARE_GET( Author, OdString, m_author);
99  DECLARE_GET( Guid, OdGUID, m_guid);
100  DECLARE_SET( Date, OdBcfTimeStampPtr, m_pDate);
101  DECLARE_SET( Author, OdString, m_author);
102  DECLARE_SET( Guid, OdGUID, m_guid);
103  //DOM-IGNORE-END
104  };
105 
110 
111 } //namespace OdBcf
112 
113 #endif // _BFC_COMMENT_H
#define DECLARE_ACCESSORS(MethodName, VariableType, VariableName)
Definition: BcfCommon.h:91
#define DECLARE_GET(MethodName, VariableType, VariableName)
Definition: BcfCommon.h:62
#define DECLARE_CONST_ACCESSORS(MethodName, VariableType, VariableName)
Definition: BcfCommon.h:73
#define DECLARE_SET(MethodName, VariableType, VariableName)
Definition: BcfCommon.h:51
#define BCF_EXPORT
#define ODRX_OVERRIDE
OdResult
Definition: OdResult.h:29
virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE
ODRX_DECLARE_MEMBERS(OdBcfComment)
virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE
virtual bool validate() const ODRX_OVERRIDE
Definition: OdGUID.h:29
OdSmartPtr< OdBcfTimeStamp > OdBcfTimeStampPtr
Definition: BcfComment.h:37
OdSmartPtr< OdBcfGUIDAttribute > OdBcfGUIDAttributePtr
Definition: BcfComment.h:40