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