1 // Copyright (C) 2013-2015 CEA/DEN, EDF R&D, OPEN CASCADE
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 // File: CurveCreator_Operation.hxx
21 // Author: Sergey KHROMOV
23 #ifndef _CurveCreator_Operation_HeaderFile
24 #define _CurveCreator_Operation_HeaderFile
26 #include "CurveCreator.hxx"
27 #include "CurveCreator_ICurve.hxx"
28 #include "CurveCreator_PosPoint.hxx"
33 class CurveCreator_Curve;
37 * This is the support class that describes a modification operation that
38 * can be applied to CurveCreator_Curve.
40 class CurveCreator_Operation
46 * This is a type of CurveCreator_Curve modification operation.
50 Unknown = 0, //!< Unknown method.
51 AddPoints, //!< Method CurveCreator_Curve::addPoints
52 RemovePoints, //!< Method CurveCreator_Curve::removePoints
53 InsertPoints, //!< Method CurveCreator_Curve::insertPoints
54 SetType, //!< Method CurveCreator_Curve::setType
55 Clear, //!< Method CurveCreator_Curve::clear
56 SetCoordinates, //!< Method CurveCreator_Curve::setCoordinates
57 SetClosed, //!< Method CurveCreator_Curve::setClosed
58 MoveSection, //!< Method CurveCreator_Curve::moveSection
59 Join, //!< Method CurveCreator_Curve::join
60 AddSection, //!< Method CurveCreator_Curve::addSection
61 RemoveSection, //!< Method CurveCreator_Curve::removeSection
62 RenameSection //!< Method CurveCreator_Curve::renameSection
68 CurveCreator_Operation();
73 ~CurveCreator_Operation();
76 * This method initializes the object with an operation without parameters.
77 * It is applicable to the following operations:
81 * @return true in case of success; false otherwise.
83 bool init(const Type theType);
86 * This method initializes the object with an operation with one integer
87 * parameter. It is applicable to the following operations:
89 * <LI>RemoveSection</LI>
91 * @return true in case of success; false otherwise.
93 bool init(const Type theType, const int theIntParam);
96 * This method initializes the object with an operation with two integer
97 * parameters. It is applicable to the following operations:
101 * <LI>MoveSection</LI>
102 * <LI>Join (with 2 int arguments)</LI>
104 * @return true in case of success; false otherwise.
106 bool init(const Type theType, const int theIntParam1,
107 const int theIntParam2);
110 * This method initializes the object with an operation with two integer
111 * parameters. It is applicable to the following operations:
113 * <LI>Join (with a list of int arguments)</LI>
115 * @return true in case of success; false otherwise.
117 bool init(const Type theType, const std::list<int> theParamList);
120 * This method initializes the object with an operation with
121 * list of pairs of integer parameters.
122 * It is applicable to the following operations:
124 * <LI>RemovePoints</LI>
126 * @return true in case of success; false otherwise.
128 bool init(const Type theType,
129 const CurveCreator_ICurve::SectionToPointList &theParamList1);
132 * This method initializes the object with an operation with one
133 * CurveCreator::Coordinates parameter and one integer parameter.
134 * It is applicable to the following operations:
138 * @return true in case of success; false otherwise.
140 bool init(const Type theType, const CurveCreator::Coordinates &theCoords,
141 const int theIntParam);
144 * This method initializes the object with an operation with
145 * list of pairs of integer parameters and CurveCreator::Coordinates parameters.
146 * It is applicable to the following operations:
148 * <LI>InsertPoints</LI>
150 * @return true in case of success; false otherwise.
152 bool init(const Type theType,
153 const CurveCreator_ICurve::SectionToPointCoordsList &theParamList1);
156 * This method initializes the object with an operation with one
157 * string, one CurveCreator::Coordinates parameter and two integer parameters.
158 * It is applicable to the following operations:
160 * <LI>AddSection</LI>
161 * <LI>InsertPoints</LI>
162 * <LI>SetCoordinates</LI>
164 * @return true in case of success; false otherwise.
166 bool init(const CurveCreator_Operation::Type theType,
167 const std::string& theName,
168 const CurveCreator::Coordinates &theCoords,
169 const int theIntParam1,
170 const int theIntParam2);
174 * This method initializes the object with an operation with one
175 * string parameter and one integer.
176 * It is applicable to the following operations:
178 * <LI>RenameSection</LI>
180 * @return true in case of success; false otherwise.
182 bool init(const CurveCreator_Operation::Type theType,
183 const std::string &theName,
184 const int theIntParam1 );
187 * This method applies the current operation to theCurve.
189 void apply(CurveCreator_Curve *theCurve);
194 * This method allocates required memory for the operation data.
195 * Returns myPData for convenience purpose.
197 void *allocate(const size_t theSize);
200 * This method clears initialized data pointers.
205 * This method returns the coordinates read from thePInt.
207 void getCoords(int *thePInt, CurveCreator::Coordinates &theCoords) const;