Salome HOME
Validators return InfoMessage instead of string as an error
[modules/shaper.git] / src / GeomValidators / GeomValidators_ShapeType.cpp
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3
4 #include "GeomValidators_ShapeType.h"
5 #include "GeomValidators_Tools.h"
6
7 #include <GeomAPI_Curve.h>
8 #include <GeomDataAPI_Point2D.h>
9
10 #include <ModelAPI_Result.h>
11 #include <ModelAPI_ResultConstruction.h>
12 #include <ModelAPI_AttributeRefAttr.h>
13 #include <ModelAPI_AttributeSelectionList.h>
14 #include <ModelAPI_AttributeReference.h>
15
16 #include <Events_InfoMessage.h>
17
18 #include <string>
19 #include <map>
20
21
22 typedef std::map<std::string, GeomValidators_ShapeType::TypeOfShape> EdgeTypes;
23
24 static EdgeTypes MyShapeTypes;
25 GeomValidators_ShapeType::TypeOfShape GeomValidators_ShapeType::shapeType(const std::string& theType)
26 {
27   if (MyShapeTypes.size() == 0) {
28     MyShapeTypes["empty"]     = Empty;
29     MyShapeTypes["vertex"]    = Vertex;
30     MyShapeTypes["edge"]      = Edge;
31     MyShapeTypes["line"]      = Line;
32     MyShapeTypes["circle"]    = Circle;
33     MyShapeTypes["wire"]      = Wire;
34     MyShapeTypes["face"]      = Face;
35     MyShapeTypes["plane"]     = Plane;
36     MyShapeTypes["shell"]     = Shell;
37     MyShapeTypes["solid"]     = Solid;
38     MyShapeTypes["compsolid"] = CompSolid;
39     MyShapeTypes["compound"]  = Compound;
40   }
41   std::string aType = std::string(theType.c_str());
42   if (MyShapeTypes.find(aType) != MyShapeTypes.end())
43     return MyShapeTypes[aType];
44
45   Events_InfoMessage("Shape type defined in XML is not implemented!").send();
46   return AnyShape;
47 }
48
49 std::string getShapeTypeDescription(const GeomValidators_ShapeType::TypeOfShape& theType)
50 {
51   std::string aValue = "";
52
53   if (MyShapeTypes.size() != 0) {
54     std::map<std::string, GeomValidators_ShapeType::TypeOfShape>::const_iterator anIt = MyShapeTypes.begin(),
55                                                                                  aLast = MyShapeTypes.end();
56     for (; anIt != aLast; anIt++) {
57       if (anIt->second == theType)
58         aValue = anIt->first;
59         break;
60     }
61   }
62   return aValue;
63 }
64
65 bool GeomValidators_ShapeType::isValid(const AttributePtr& theAttribute,
66                                        const std::list<std::string>& theArguments,
67                                        Events_InfoMessage& theError) const
68 {
69   bool aValid = false;
70
71   std::list<std::string>::const_iterator anIt = theArguments.begin(), aLast = theArguments.end();
72   // returns true if the attribute satisfies at least one of given arguments
73   for (; anIt != aLast; anIt++) {
74     TypeOfShape aShapeType = shapeType(*anIt);
75     // if arguments contain any shape type value, the validator returns true
76     if (aShapeType == AnyShape) {
77       aValid = true;
78       break;
79     }
80     if (isValidAttribute(theAttribute, aShapeType, theError)) {
81       aValid = true;
82       break;
83     }
84   }
85   if (!aValid && theError.empty()) {
86     std::string aTypes;
87     std::list<std::string>::const_iterator anIt = theArguments.begin(), aLast = theArguments.end();
88     // returns true if the attribute satisfies at least one of given arguments
89     for (; anIt != aLast; anIt++) {
90       if (!aTypes.empty())
91         aTypes += ", ";
92     }
93     theError = "It does not contain element with acceptable shape type. The type should be one of the next: "
94                + aTypes;
95   }
96
97   return aValid;
98 }
99
100 bool GeomValidators_ShapeType::isValidAttribute(const AttributePtr& theAttribute,
101                                                 const TypeOfShape theShapeType,
102                                                 Events_InfoMessage& theError) const
103 {
104   bool aValid = true;
105
106   std::string anAttributeType = theAttribute->attributeType();
107   if (anAttributeType == ModelAPI_AttributeSelection::typeId()) {
108     AttributeSelectionPtr anAttr = std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(theAttribute);
109     GeomShapePtr aShape = anAttr->value();
110     if (aShape.get())
111       aValid = isValidShape(aShape, theShapeType, theError);
112     else
113       aValid = isValidObject(anAttr->context(), theShapeType, theError);
114   }
115   else if (anAttributeType == ModelAPI_AttributeRefAttr::typeId()) {
116     AttributeRefAttrPtr anAttr = std::dynamic_pointer_cast<ModelAPI_AttributeRefAttr>(theAttribute);
117     if (anAttr->isObject()) {
118       aValid = isValidObject(anAttr->object(), theShapeType, theError);
119     }
120     else if (theShapeType == Vertex) {
121       AttributePtr aRefAttr = anAttr->attr();
122       if (!aRefAttr.get()){
123         aValid = false;
124         theError = "It has reference to an empty attribute";
125       }
126       else {
127         std::string anAttributeType = aRefAttr->attributeType();
128         aValid = anAttributeType == GeomDataAPI_Point2D::typeId();
129         if (!aValid)
130           theError = "Shape type is \"" + anAttributeType +
131                      "\", it should be \"" + getShapeTypeDescription(theShapeType) + "\"";
132       }
133     }
134   }
135   else if (anAttributeType == ModelAPI_AttributeReference::typeId()) {
136     AttributeReferencePtr anAttr =
137                               std::dynamic_pointer_cast<ModelAPI_AttributeReference>(theAttribute);
138     aValid = isValidObject(anAttr->value(), theShapeType, theError);
139   }
140   else if (anAttributeType == ModelAPI_AttributeSelectionList::typeId()) {
141     AttributeSelectionListPtr aListAttr =
142                           std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(theAttribute);
143     // the Empty value means that the attribute selection list is valid if it is empty
144     if (aListAttr->size() == 0 && theShapeType == Empty) {
145       return true;
146     }
147     aValid = false; // the list should have elements if the shape type is not Empty
148     for (int i = 0; i < aListAttr->size(); i++) {
149       aValid = isValidAttribute(aListAttr->value(i), theShapeType, theError);
150       if (!aValid) // if at least one attribute is invalid, the result is false
151         break;
152     }
153   }
154   else {
155     aValid = false;
156     theError = "The attribute with the " + anAttributeType  + " type is not processed";
157   }
158   return aValid;
159 }
160
161 bool GeomValidators_ShapeType::isValidObject(const ObjectPtr& theObject,
162                                              const TypeOfShape theShapeType,
163                                              Events_InfoMessage& theError) const
164 {
165   bool aValid = true;
166   if (!theObject.get()) {
167     if(theShapeType != Empty) {
168       aValid = false;
169       theError = "The object is empty";
170     }
171   }
172   else {
173     ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
174     if( theShapeType==Plane )
175     {
176       ResultConstructionPtr aResultConstruction = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(theObject);
177       FeaturePtr aFeature = ModelAPI_Feature::feature(theObject);
178       const std::string& aKind = aFeature->getKind();
179       return aResult.get() != NULL && aKind == "Plane";
180     }
181     if (!aResult.get()) {
182       aValid = false;
183       theError = "The result is empty";
184     }
185     else {
186       aValid = isValidShape(aResult->shape(), theShapeType, theError);
187     }
188   }
189   return aValid;
190 }
191
192 bool GeomValidators_ShapeType::isValidShape(const GeomShapePtr theShape,
193                                             const TypeOfShape theShapeType,
194                                             Events_InfoMessage& theError) const
195 {
196   bool aValid = true;
197
198   if (!theShape.get()) {
199     aValid = false;
200     theError = "The shape is empty";
201   }
202   else {
203     switch (theShapeType) {
204     case Vertex:
205       aValid = theShape->isVertex();
206       break;
207     case Edge:
208       aValid = theShape->isEdge();
209       break;
210     case Line:
211       aValid = theShape->isEdge() && !GeomAPI_Curve(theShape).isCircle();
212       break;
213     case Circle:
214       aValid = theShape->isEdge() && GeomAPI_Curve(theShape).isCircle();
215       break;
216     case Wire:
217       aValid = theShape->shapeType() == GeomAPI_Shape::WIRE;
218       break;
219     case Face:
220       aValid = theShape->isFace();
221       break;
222     case Shell:
223       aValid = theShape->shapeType() == GeomAPI_Shape::SHELL;
224       break;
225     case Solid:
226       aValid = theShape->isSolid() || theShape->isCompSolid() ||
227                theShape->isCompoundOfSolids();
228       break;
229     case CompSolid:
230       aValid = theShape->shapeType() == GeomAPI_Shape::COMPSOLID;
231       break;
232     case Compound:
233       aValid = theShape->isCompound();
234       break;
235     default:
236       aValid = false;
237       break;
238     }
239   }
240   return aValid;
241 }