include/opencascade/TDataStd_ReferenceList.hxx

0001 // Created on: 2007-05-29
0002 // Created by: Vlad Romashko
0003 // Copyright (c) 2007-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 _TDataStd_ReferenceList_HeaderFile
0017 #define _TDataStd_ReferenceList_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <TDF_Label.hxx>
0022 #include <NCollection_List.hxx>
0023 #include <TDF_Attribute.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <Standard_OStream.hxx>
0026 #include <Standard_GUID.hxx>
0027
0028 class TDF_Label;
0029 class TDF_RelocationTable;
0030 class TDF_DataSet;
0031
0032 //! Contains a list of references.
0033 class TDataStd_ReferenceList : public TDF_Attribute
0034 {
0035
0036 public:
0037   //! Static methods
0038   //! ==============
0039   //! Returns the ID of the list of references (labels) attribute.
0040   Standard_EXPORT static const Standard_GUID& GetID();
0041
0042   //! Finds or creates a list of reference values (labels) attribute.
0043   Standard_EXPORT static occ::handle<TDataStd_ReferenceList> Set(const TDF_Label& label);
0044
0045   //! Finds or creates a list of reference values (labels) attribute with explicit user defined
0046   //! <guid>.
0047   Standard_EXPORT static occ::handle<TDataStd_ReferenceList> Set(const TDF_Label&     label,
0048                                                                  const Standard_GUID& theGuid);
0049
0050   Standard_EXPORT TDataStd_ReferenceList();
0051
0052   Standard_EXPORT bool IsEmpty() const;
0053
0054   Standard_EXPORT int Extent() const;
0055
0056   Standard_EXPORT void Prepend(const TDF_Label& value);
0057
0058   Standard_EXPORT void Append(const TDF_Label& value);
0059
0060   //! Sets the explicit GUID (user defined) for the attribute.
0061   Standard_EXPORT void SetID(const Standard_GUID& theGuid) override;
0062
0063   //! Sets default GUID for the attribute.
0064   Standard_EXPORT void SetID() override;
0065
0066   //! Inserts the <value> before the first meet of <before_value>.
0067   Standard_EXPORT bool InsertBefore(const TDF_Label& value, const TDF_Label& before_value);
0068
0069   //! Inserts the label before the <index> position.
0070   //! The indices start with 1 .. Extent().
0071   Standard_EXPORT bool InsertBefore(const int index, const TDF_Label& before_value);
0072
0073   //! Inserts the <value> after the first meet of <after_value>.
0074   Standard_EXPORT bool InsertAfter(const TDF_Label& value, const TDF_Label& after_value);
0075
0076   //! Inserts the label after the <index> position.
0077   //! The indices start with 1 .. Extent().
0078   Standard_EXPORT bool InsertAfter(const int index, const TDF_Label& after_value);
0079
0080   //! Removes the first meet of the <value>.
0081   Standard_EXPORT bool Remove(const TDF_Label& value);
0082
0083   //! Removes a label at "index" position.
0084   Standard_EXPORT bool Remove(const int index);
0085
0086   Standard_EXPORT void Clear();
0087
0088   Standard_EXPORT const TDF_Label& First() const;
0089
0090   Standard_EXPORT const TDF_Label& Last() const;
0091
0092   Standard_EXPORT const NCollection_List<TDF_Label>& List() const;
0093
0094   Standard_EXPORT const Standard_GUID& ID() const override;
0095
0096   Standard_EXPORT void Restore(const occ::handle<TDF_Attribute>& With) override;
0097
0098   Standard_EXPORT occ::handle<TDF_Attribute> NewEmpty() const override;
0099
0100   Standard_EXPORT void Paste(const occ::handle<TDF_Attribute>&       Into,
0101                              const occ::handle<TDF_RelocationTable>& RT) const override;
0102
0103   Standard_EXPORT void References(const occ::handle<TDF_DataSet>& DS) const override;
0104
0105   Standard_EXPORT Standard_OStream& Dump(Standard_OStream& anOS) const override;
0106
0107   //! Dumps the content of me into the stream
0108   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;
0109
0110   DEFINE_STANDARD_RTTIEXT(TDataStd_ReferenceList, TDF_Attribute)
0111
0112 private:
0113   NCollection_List<TDF_Label> myList;
0114   Standard_GUID               myID;
0115 };
0116
0117 #endif // _TDataStd_ReferenceList_HeaderFile