include/opencascade/XCAFDoc_Datum.hxx

0001 // Created on: 2004-01-15
0002 // Created by: Sergey KUUL
0003 // Copyright (c) 2004-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _XCAFDoc_Datum_HeaderFile
0017 #define _XCAFDoc_Datum_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <TDF_Attribute.hxx>
0023 class TCollection_HAsciiString;
0024 class Standard_GUID;
0025 class TDF_Label;
0026 class TDF_RelocationTable;
0027 class XCAFDimTolObjects_DatumObject;
0028
0029 // resolve name collisions with WinAPI headers
0030 #ifdef GetObject
0031   #undef GetObject
0032 #endif
0033
0034 class XCAFDoc_Datum;
0035 DEFINE_STANDARD_HANDLE(XCAFDoc_Datum, TDF_Attribute)
0036
0037 //! attribute to store datum
0038 class XCAFDoc_Datum : public TDF_Attribute
0039 {
0040
0041 public:
0042   Standard_EXPORT XCAFDoc_Datum();
0043
0044   Standard_EXPORT static const Standard_GUID& GetID();
0045
0046   Standard_EXPORT static Handle(XCAFDoc_Datum) Set(
0047     const TDF_Label&                        label,
0048     const Handle(TCollection_HAsciiString)& aName,
0049     const Handle(TCollection_HAsciiString)& aDescription,
0050     const Handle(TCollection_HAsciiString)& anIdentification);
0051
0052   Standard_EXPORT static Handle(XCAFDoc_Datum) Set(const TDF_Label& theLabel);
0053
0054   Standard_EXPORT void Set(const Handle(TCollection_HAsciiString)& aName,
0055                            const Handle(TCollection_HAsciiString)& aDescription,
0056                            const Handle(TCollection_HAsciiString)& anIdentification);
0057
0058   Standard_EXPORT Handle(TCollection_HAsciiString) GetName() const;
0059
0060   Standard_EXPORT Handle(TCollection_HAsciiString) GetDescription() const;
0061
0062   Standard_EXPORT Handle(TCollection_HAsciiString) GetIdentification() const;
0063
0064   //! Returns dimension object data taken from the paren's label and its sub-labels.
0065   Standard_EXPORT Handle(XCAFDimTolObjects_DatumObject) GetObject() const;
0066
0067   //! Updates parent's label and its sub-labels with data taken from theDatumObject.
0068   //! Old data associated with the label will be lost.
0069   Standard_EXPORT void SetObject(const Handle(XCAFDimTolObjects_DatumObject)& theDatumObject);
0070
0071   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0072
0073   Standard_EXPORT void Restore(const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
0074
0075   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0076
0077   Standard_EXPORT void Paste(const Handle(TDF_Attribute)&       Into,
0078                              const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0079
0080   //! Dumps the content of me into the stream
0081   Standard_EXPORT virtual void DumpJson(Standard_OStream& theOStream,
0082                                         Standard_Integer  theDepth = -1) const Standard_OVERRIDE;
0083
0084   DEFINE_STANDARD_RTTIEXT(XCAFDoc_Datum, TDF_Attribute)
0085
0086 private:
0087   Handle(TCollection_HAsciiString) myName;
0088   Handle(TCollection_HAsciiString) myDescription;
0089   Handle(TCollection_HAsciiString) myIdentification;
0090 };
0091
0092 #endif // _XCAFDoc_Datum_HeaderFile