include/opencascade/Transfer_TransientListBinder.hxx

0001 // Created on: 1994-10-03
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1994-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Transfer_TransientListBinder_HeaderFile
0018 #define _Transfer_TransientListBinder_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024 #include <NCollection_Sequence.hxx>
0025 #include <NCollection_HSequence.hxx>
0026 #include <Transfer_Binder.hxx>
0027 #include <Standard_Integer.hxx>
0028 class Standard_Transient;
0029
0030 //! This binder binds several (a list of) Transients with a starting
0031 //! entity, when this entity itself corresponds to a simple list
0032 //! of Transients. Each part is not seen as a sub-result of an
0033 //! independent component, but as an item of a built-in list
0034 class Transfer_TransientListBinder : public Transfer_Binder
0035 {
0036
0037 public:
0038   Standard_EXPORT Transfer_TransientListBinder();
0039
0040   Standard_EXPORT Transfer_TransientListBinder(
0041     const occ::handle<NCollection_HSequence<occ::handle<Standard_Transient>>>& list);
0042
0043   Standard_EXPORT bool IsMultiple() const override;
0044
0045   Standard_EXPORT occ::handle<Standard_Type> ResultType() const override;
0046
0047   Standard_EXPORT const char* ResultTypeName() const override;
0048
0049   //! Adds an item to the result list
0050   Standard_EXPORT void AddResult(const occ::handle<Standard_Transient>& res);
0051
0052   Standard_EXPORT occ::handle<NCollection_HSequence<occ::handle<Standard_Transient>>> Result()
0053     const;
0054
0055   //! Changes an already defined sub-result
0056   Standard_EXPORT void SetResult(const int num, const occ::handle<Standard_Transient>& res);
0057
0058   Standard_EXPORT int NbTransients() const;
0059
0060   Standard_EXPORT const occ::handle<Standard_Transient>& Transient(const int num) const;
0061
0062   DEFINE_STANDARD_RTTIEXT(Transfer_TransientListBinder, Transfer_Binder)
0063
0064 private:
0065   occ::handle<NCollection_HSequence<occ::handle<Standard_Transient>>> theres;
0066 };
0067
0068 #endif // _Transfer_TransientListBinder_HeaderFile