Salome HOME
refs# 1917 + protection against null shapes wires in GetMiddlePoint()
[modules/hydro.git] / src / HYDROPy / HYDROData_Region.sip
1 // Copyright (C) 2014-2015  EDF-R&D
2 // This library is free software; you can redistribute it and/or
3 // modify it under the terms of the GNU Lesser General Public
4 // License as published by the Free Software Foundation; either
5 // version 2.1 of the License, or (at your option) any later version.
6 //
7 // This library is distributed in the hope that it will be useful,
8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
10 // Lesser General Public License for more details.
11 //
12 // You should have received a copy of the GNU Lesser General Public
13 // License along with this library; if not, write to the Free Software
14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
15 //
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
17 //
18
19 %ExportedHeaderCode
20 #include <HYDROData_Region.h>
21 %End
22
23 class HYDROData_Region : public HYDROData_Entity
24 {
25
26 %ConvertToSubClassCode
27     switch ( sipCpp->GetKind() )
28     {
29       case KIND_REGION:
30         sipClass = sipClass_HYDROData_Region;
31         break;
32
33       default:
34         // We don't recognise the type.
35         sipClass = NULL;
36     }
37 %End
38
39 %TypeHeaderCode
40 #include <HYDROData_Region.h>
41 %End
42
43 public:      
44
45   /**
46    * Add new one reference zone for region.
47    */
48   void AddZone( HYDROData_Zone theZone ) [void (const opencascade::handle<HYDROData_Zone>&)];
49   %MethodCode
50
51     Handle(HYDROData_Zone) aZone =
52       Handle(HYDROData_Zone)::DownCast( createHandle( a0 ) );
53     if ( !aZone.IsNull() )
54     {
55       Py_BEGIN_ALLOW_THREADS
56       sipSelfWasArg ? sipCpp->HYDROData_Region::AddZone( aZone ) : 
57                       sipCpp->AddZone( aZone );
58       Py_END_ALLOW_THREADS
59     }
60
61   %End
62
63   /**
64    * Returns all reference zone of region.
65    */
66   HYDROData_SequenceOfObjects GetZones() const;
67
68   /**
69    * Removes reference zone from region.
70    */
71   void RemoveZone( HYDROData_Zone theZone ) [void (const opencascade::handle<HYDROData_Zone>&)];
72   %MethodCode
73
74     Handle(HYDROData_Zone) aZone =
75       Handle(HYDROData_Zone)::DownCast( createHandle( a0 ) );
76     if ( !aZone.IsNull() )
77     {
78       Py_BEGIN_ALLOW_THREADS
79       sipSelfWasArg ? sipCpp->HYDROData_Region::RemoveZone( aZone ) : 
80                       sipCpp->RemoveZone( aZone );
81       Py_END_ALLOW_THREADS
82     }
83
84   %End
85
86   /**
87    * Removes all reference zones from region.
88    */
89   void RemoveZones();
90
91
92 protected:
93
94   /**
95    * Creates new object in the internal data structure. Use higher level objects 
96    * to create objects with real content.
97    */
98   HYDROData_Region();
99
100   /**
101    * Destructs properties of the object and object itself, removes it from the document.
102    */
103   ~HYDROData_Region();
104 };
105
106