Merge pull request #4009 from opensim-org/fix_object-loading-errors-should-go-to-log

Change std::cerr/std::cout usages to use the log, where appropriate

Author: adamkewley

CHANGELOG.md

@@ -66,6 +66,7 @@ v4.6
   - It will now check for NaNed vectors coming from the underlying expression, skipping emission
     if one is detected (previously: it would emit decorations with `NaN`ed transforms).
 - `PolynomialPathFitter` now allows fitting paths that depend on more than 6 coordinates, matching recent changes to `MultivariatePolynomialFunction` (#4001).
+- If an `Object` cannot be found when loading a list property from XML, a warning will now be emitted to the log (previously: it was emitted to `std::cerr`, #4009).
 
 v4.5.1
 ======

OpenSim/Common/Object.cpp

@@ -953,7 +953,7 @@ try {
 
         // NOT RECOGNIZED
         default :
-            cout<<"Object.UpdateObject: WARN- unrecognized property type."<<endl;
+            log_warn("Object.UpdateObject: WARN- unrecognized property type.");
             break;
         }
     }
@@ -1033,7 +1033,7 @@ void Object::updateXMLNode(SimTK::Xml::Element& aParent,
         // If object is not inlined we don't want to generate node in original document
         // Handle not-inlined objects first.
         if (!aParent.isValid()) {
-            cout<<"Root node must be inlined"<<*this<<endl;
+            log_warn("Root node of an OpenSim::Object must be inlined, skipping XML reading.");
         }
         else {
         // Can we make this more efficient than recreating the node again?
@@ -1211,8 +1211,8 @@ void Object::updateXMLNode(SimTK::Xml::Element& aParent,
             break; 
 
         // NOT RECOGNIZED
-        default :
-            cout<<"Object.UpdateObject: WARN- unrecognized property type."<<endl;
+        default:
+            log_warn("Object.UpdateObject: WARN- unrecognized property type.");
             break;
         }
     }

OpenSim/Common/Object.h

@@ -1406,19 +1406,13 @@ ObjectProperty<T>::readFromXMLElement
             Object::getDefaultInstanceOfType(objTypeTag);
 
         if (!registeredObj) {
-            std::cerr 
-                << "Encountered unrecognized Object typename " 
-                << objTypeTag << " while reading property " << this->getName()
-                << ". There is no registered Object of this type; ignoring.\n";
-            continue;                        
+            log_error("Encountered unrecognized Object typename {} while reading property {}. There is no registered Object of this type. Ignoring.", objTypeTag, this->getName());
+            continue;
         }
 
         // Check that the object type found is derived from T.
         if (!dynamic_cast<const T*>(registeredObj)) {
-            std::cerr << "Object type " << objTypeTag  
-                        << " wrong for " << objectClassName
-                        << " property " << this->getName()
-                        << "; ignoring.\n";
+            log_error("Object type {} wrong for {} property {}. Ignoring.", objTypeTag, objectClassName, this->getName());
             continue;                        
         }
         ++objectsFound;
@@ -1437,16 +1431,18 @@ ObjectProperty<T>::readFromXMLElement
     }
 
     if (objectsFound < this->getMinListSize()) {
-        std::cerr << "Got " << objectsFound 
-                    << " object values for Property "
-                    << this->getName() << " but the minimum is " 
-                    << this->getMinListSize() << ". Continuing anyway.\n"; 
+        log_error("Got {} object values for Property {} but the minimum is {}. Continuing anyway.",
+            objectsFound ,
+            this->getName() ,
+            this->getMinListSize()
+        );
     }
     if (objectsFound > this->getMaxListSize()) {
-        std::cerr << "Got " << objectsFound
-                    << " object values for Property "
-                    << this->getName() << " but the maximum is " 
-                    << this->getMaxListSize() << ". Ignoring the rest.\n"; 
+        log_error("Got {} object values for Property {} but the maximum is {}. Ignoring the rest.",
+            objectsFound,
+            this->getName(),
+            this->getMaxListSize()
+        );
     }
 }