diff --git a/Code/Mantid/Vates/VatesAPI/CMakeLists.txt b/Code/Mantid/Vates/VatesAPI/CMakeLists.txt index 9bf2c96d424202df3d4e6925c1774c5c52d5736e..630bf5f3c1bfde208a96305bcac402bbaccf715a 100644 --- a/Code/Mantid/Vates/VatesAPI/CMakeLists.txt +++ b/Code/Mantid/Vates/VatesAPI/CMakeLists.txt @@ -22,12 +22,12 @@ src/MedianAndBelowThresholdRange.cpp src/MetadataToFieldData.cpp src/NoThresholdRange.cpp src/ProgressAction.cpp -src/RebinningKnowledgeSerializer.cpp src/SynchronisingGeometryPresenter.cpp src/TimeStepToTimeStep.cpp src/TimeToTimeStep.cpp src/UserDefinedThresholdRange.cpp src/VatesXMLDefinitions.cpp +src/VatesKnowledgeSerializer.cpp src/vtkDataSetFactory.cpp src/vtkDataSetToGeometry.cpp src/vtkDataSetToImplicitFunction.cpp @@ -74,14 +74,14 @@ inc/MantidVatesAPI/IMDDimensionComparitor.h inc/MantidVatesAPI/MetadataToFieldData.h inc/MantidVatesAPI/NoThresholdRange.h inc/MantidVatesAPI/ProgressAction.h -inc/MantidVatesAPI/RebinningKnowledgeSerializer.h inc/MantidVatesAPI/SQWLoadingPresenter.h inc/MantidVatesAPI/SynchronisingGeometryPresenter.h inc/MantidVatesAPI/ThresholdRange.h inc/MantidVatesAPI/TimeStepToTimeStep.h inc/MantidVatesAPI/TimeToTimeStep.h inc/MantidVatesAPI/UserDefinedThresholdRange.h -inc/MantidVatesAPI/VatesXMLDefinitions.h +inc/MantidVatesAPI/VatesXMLDefinitions.h +inc/MantidVatesAPI/VatesKnowledgeSerializer.h inc/MantidVatesAPI/vtkDataSetFactory.h inc/MantidVatesAPI/vtkDataSetToGeometry.h inc/MantidVatesAPI/vtkDataSetToImplicitFunction.h @@ -130,7 +130,6 @@ test/MDHWInMemoryLoadingPresenterTest.h test/MDHWLoadingPresenterTest.h test/MDHWNexusLoadingPresenterTest.h test/MetadataToFieldDataTest.h -test/RebinningKnowledgeSerializerTest.h test/SQWLoadingPresenterTest.h test/SynchronisingGeometryPresenterTest.h test/TimeStepToTimeStepTest.h @@ -139,6 +138,7 @@ test/UserDefinedThresholdRangeTest.h test/MedianAndBelowThresholdRangeTest.h test/NoThresholdRangeTest.h test/IgnoreZerosThresholdRangeTest.h +test/VatesKnowledgeSerializerTest.h test/vtkDataSetToScaledDataSetTest.h test/vtkDataSetToNonOrthogonalDataSetTest.h ) diff --git a/Code/Mantid/Vates/VatesAPI/inc/MantidVatesAPI/RebinningKnowledgeSerializer.h b/Code/Mantid/Vates/VatesAPI/inc/MantidVatesAPI/VatesKnowledgeSerializer.h similarity index 88% rename from Code/Mantid/Vates/VatesAPI/inc/MantidVatesAPI/RebinningKnowledgeSerializer.h rename to Code/Mantid/Vates/VatesAPI/inc/MantidVatesAPI/VatesKnowledgeSerializer.h index 65a38176f462b99f48544bafafe790ae04dc90f0..9d8d4eb8e09fd6ad68d7f232e071c05b23a6e53a 100644 --- a/Code/Mantid/Vates/VatesAPI/inc/MantidVatesAPI/RebinningKnowledgeSerializer.h +++ b/Code/Mantid/Vates/VatesAPI/inc/MantidVatesAPI/VatesKnowledgeSerializer.h @@ -1,5 +1,5 @@ -#ifndef VATES_REBINNING_KNOWLEDGE_SERIALIZER_H -#define VATES_REBINNING_KNOWLEDGE_SERIALIZER_H +#ifndef VATES_KNOWLEDGE_SERIALIZER_H +#define VATES_KNOWLEDGE_SERIALIZER_H #include <boost/shared_ptr.hpp> #include <string> @@ -24,8 +24,7 @@ enum LocationPolicy{LocationMandatory, LocationNotRequired}; /** - This type assists with the generation of well-formed xml meeting the xsd scehema layed-out for - Rebinning/cutting type operations. The individual components utilised here may not be able to form well-formed + This type assists with the generation of well-formed xml meeting the xsd scehema. The individual components utilised here may not be able to form well-formed xml in their own right and therefore do not have a toXMLString method. This implementation is based on a builder pattern using the create mechanism for xml string generation. @@ -53,7 +52,7 @@ enum LocationPolicy{LocationMandatory, LocationNotRequired}; File change history is stored at: <https://github.com/mantidproject/mantid> Code Documentation is available at: <http://doxygen.mantidproject.org> */ -class DLLExport RebinningKnowledgeSerializer +class DLLExport VatesKnowledgeSerializer { private: @@ -66,7 +65,7 @@ private: LocationPolicy m_locationPolicy; public: - RebinningKnowledgeSerializer(LocationPolicy locationPolicy=LocationMandatory); + VatesKnowledgeSerializer(LocationPolicy locationPolicy=LocationMandatory); /// Set the implicit function to use called. void setImplicitFunction(boost::shared_ptr<const Mantid::Geometry::MDImplicitFunction> spFunction); diff --git a/Code/Mantid/Vates/VatesAPI/src/MDEWLoadingPresenter.cpp b/Code/Mantid/Vates/VatesAPI/src/MDEWLoadingPresenter.cpp index d04f334e6ee6cda62aed91e8ddb587949f450da8..85bb68aee4e86391afe16e4bf9e3de50335b947e 100644 --- a/Code/Mantid/Vates/VatesAPI/src/MDEWLoadingPresenter.cpp +++ b/Code/Mantid/Vates/VatesAPI/src/MDEWLoadingPresenter.cpp @@ -3,7 +3,7 @@ #include "MantidAPI/FrameworkManager.h" #include "MantidGeometry/MDGeometry/NullImplicitFunction.h" -#include "MantidVatesAPI/RebinningKnowledgeSerializer.h" +#include "MantidVatesAPI/VatesKnowledgeSerializer.h" #include "MantidVatesAPI/MetadataToFieldData.h" #include "MantidVatesAPI/VatesXMLDefinitions.h" #include "MantidVatesAPI/Common.h" @@ -148,7 +148,7 @@ namespace Mantid vtkFieldData* outputFD = vtkFieldData::New(); //Serialize metadata - RebinningKnowledgeSerializer serializer(LocationNotRequired); + VatesKnowledgeSerializer serializer(LocationNotRequired); serializer.setWorkspaceName(wsName); serializer.setGeometryXML(xmlBuilder.create()); serializer.setImplicitFunction( Mantid::Geometry::MDImplicitFunction_sptr(new Mantid::Geometry::NullImplicitFunction())); diff --git a/Code/Mantid/Vates/VatesAPI/src/MDHWLoadingPresenter.cpp b/Code/Mantid/Vates/VatesAPI/src/MDHWLoadingPresenter.cpp index 9717418fe4e80a37a40ff580ea5b028573369206..41f7ca8d28d430e643435a18173885fc4cebc068 100644 --- a/Code/Mantid/Vates/VatesAPI/src/MDHWLoadingPresenter.cpp +++ b/Code/Mantid/Vates/VatesAPI/src/MDHWLoadingPresenter.cpp @@ -4,7 +4,7 @@ #include "MantidGeometry/MDGeometry/MDHistoDimension.h" #include "MantidGeometry/MDGeometry/NullImplicitFunction.h" -#include "MantidVatesAPI/RebinningKnowledgeSerializer.h" +#include "MantidVatesAPI/VatesKnowledgeSerializer.h" #include "MantidVatesAPI/MetadataToFieldData.h" #include "MantidVatesAPI/VatesXMLDefinitions.h" #include "MantidVatesAPI/vtkDataSetToNonOrthogonalDataSet.h" @@ -142,7 +142,7 @@ namespace Mantid vtkFieldData* outputFD = vtkFieldData::New(); //Serialize metadata - RebinningKnowledgeSerializer serializer(LocationNotRequired); + VatesKnowledgeSerializer serializer(LocationNotRequired); serializer.setWorkspaceName(wsName); serializer.setGeometryXML(xmlBuilder.create()); serializer.setImplicitFunction( Mantid::Geometry::MDImplicitFunction_sptr(new Mantid::Geometry::NullImplicitFunction())); diff --git a/Code/Mantid/Vates/VatesAPI/src/RebinningKnowledgeSerializer.cpp b/Code/Mantid/Vates/VatesAPI/src/VatesKnowledgeSerializer.cpp similarity index 72% rename from Code/Mantid/Vates/VatesAPI/src/RebinningKnowledgeSerializer.cpp rename to Code/Mantid/Vates/VatesAPI/src/VatesKnowledgeSerializer.cpp index 2391c10e27782e3632a866cecde2bb4a652cd002..b9e9dcd600065b6c9d509a9a710ff933004e8ea5 100644 --- a/Code/Mantid/Vates/VatesAPI/src/RebinningKnowledgeSerializer.cpp +++ b/Code/Mantid/Vates/VatesAPI/src/VatesKnowledgeSerializer.cpp @@ -4,7 +4,7 @@ #include <boost/algorithm/string.hpp> #include <boost/format.hpp> #include "MantidGeometry/MDGeometry/MDGeometryXMLDefinitions.h" -#include "MantidVatesAPI/RebinningKnowledgeSerializer.h" +#include "MantidVatesAPI/VatesKnowledgeSerializer.h" #include "MantidVatesAPI/VatesXMLDefinitions.h" using Mantid::Geometry::MDGeometryXMLDefinitions; @@ -13,7 +13,7 @@ namespace Mantid namespace VATES { -RebinningKnowledgeSerializer::RebinningKnowledgeSerializer(LocationPolicy locationPolicy) : +VatesKnowledgeSerializer::VatesKnowledgeSerializer(LocationPolicy locationPolicy) : m_wsLocationXML(""), m_wsNameXML(""), m_wsName(""), @@ -22,13 +22,13 @@ RebinningKnowledgeSerializer::RebinningKnowledgeSerializer(LocationPolicy locati { } -void RebinningKnowledgeSerializer::setImplicitFunction(boost::shared_ptr<const Mantid::Geometry::MDImplicitFunction> spFunction) +void VatesKnowledgeSerializer::setImplicitFunction(boost::shared_ptr<const Mantid::Geometry::MDImplicitFunction> spFunction) { this->m_spFunction = spFunction; } /// Set the workspace name to apply. -void RebinningKnowledgeSerializer::setWorkspace(boost::shared_ptr<const Mantid::API::IMDWorkspace> workspace) +void VatesKnowledgeSerializer::setWorkspace(boost::shared_ptr<const Mantid::API::IMDWorkspace> workspace) { this->m_wsNameXML = MDGeometryXMLDefinitions::workspaceNameXMLTagStart() + workspace->getName() + MDGeometryXMLDefinitions::workspaceNameXMLTagEnd(); @@ -36,19 +36,19 @@ void RebinningKnowledgeSerializer::setWorkspace(boost::shared_ptr<const Mantid:: this->m_geomXML = workspace->getGeometryXML(); } -void RebinningKnowledgeSerializer::setWorkspaceName(std::string wsName) +void VatesKnowledgeSerializer::setWorkspaceName(std::string wsName) { this->m_wsName = wsName; this->m_wsNameXML = std::string(MDGeometryXMLDefinitions::workspaceNameXMLTagStart() + wsName + MDGeometryXMLDefinitions::workspaceNameXMLTagEnd()); } -void RebinningKnowledgeSerializer::setGeometryXML(std::string geomXML) +void VatesKnowledgeSerializer::setGeometryXML(std::string geomXML) { this->m_geomXML = geomXML; } /// Create the xml string correponding to the set values. -std::string RebinningKnowledgeSerializer::createXMLString() const +std::string VatesKnowledgeSerializer::createXMLString() const { if(true == this->m_geomXML.empty()) @@ -72,22 +72,22 @@ std::string RebinningKnowledgeSerializer::createXMLString() const } } -const std::string& RebinningKnowledgeSerializer::getWorkspaceName() const +const std::string& VatesKnowledgeSerializer::getWorkspaceName() const { return this->m_wsName; } -const std::string& RebinningKnowledgeSerializer::getWorkspaceGeometry() const +const std::string& VatesKnowledgeSerializer::getWorkspaceGeometry() const { return this->m_geomXML; } - bool RebinningKnowledgeSerializer::hasFunctionInfo() const + bool VatesKnowledgeSerializer::hasFunctionInfo() const { return NULL != m_spFunction.get(); } - bool RebinningKnowledgeSerializer::hasGeometryInfo() const + bool VatesKnowledgeSerializer::hasGeometryInfo() const { return !m_geomXML.empty() && !m_wsName.empty(); } diff --git a/Code/Mantid/Vates/VatesAPI/test/RebinningKnowledgeSerializerTest.h b/Code/Mantid/Vates/VatesAPI/test/VatesKnowledgeSerializerTest.h similarity index 88% rename from Code/Mantid/Vates/VatesAPI/test/RebinningKnowledgeSerializerTest.h rename to Code/Mantid/Vates/VatesAPI/test/VatesKnowledgeSerializerTest.h index 8dd93b1472b999015fa03c213308bd813b16703d..6100f48902c027f078d7b676cf4b98cb48704bd7 100644 --- a/Code/Mantid/Vates/VatesAPI/test/RebinningKnowledgeSerializerTest.h +++ b/Code/Mantid/Vates/VatesAPI/test/VatesKnowledgeSerializerTest.h @@ -5,7 +5,7 @@ #include <gtest/gtest.h> #include <cxxtest/TestSuite.h> #include <MantidGeometry/MDGeometry/IMDDimension.h> -#include "MantidVatesAPI/RebinningKnowledgeSerializer.h" +#include "MantidVatesAPI/VatesKnowledgeSerializer.h" #include "MantidAPI/IMDWorkspace.h" #include "MantidGeometry/MDGeometry/MDImplicitFunction.h" #include "MantidKernel/System.h" @@ -15,7 +15,7 @@ using namespace Mantid::VATES; -class RebinningKnowledgeSerializerTest: public CxxTest::TestSuite +class VatesKnowledgeSerializerTest: public CxxTest::TestSuite { private: @@ -39,7 +39,7 @@ public: void testNoWorkspaceThrows() { - RebinningKnowledgeSerializer generator; + VatesKnowledgeSerializer generator; Mantid::Geometry::MDImplicitFunction_sptr impFunction(new MockImplicitFunction); generator.setImplicitFunction(impFunction); TSM_ASSERT_THROWS("Cannot generate the xml without the workspace", generator.createXMLString(), std::runtime_error); @@ -55,7 +55,7 @@ void testNoLocationDoesNotThrow() EXPECT_CALL(*pImpFunction, toXMLString()).Times(1).WillRepeatedly(testing::Return("<ImplicitFunction/>")); Mantid::Geometry::MDImplicitFunction_sptr impFunction(pImpFunction); - RebinningKnowledgeSerializer generator(LocationNotRequired); //Location is not required. + VatesKnowledgeSerializer generator(LocationNotRequired); //Location is not required. generator.setImplicitFunction(impFunction); generator.setWorkspace(workspace); @@ -68,7 +68,7 @@ void testNoNameThrows() Mantid::Geometry::MDImplicitFunction_sptr impFunction(new MockImplicitFunction); MockIMDWorkspace* pWorkspace = new MockIMDWorkspace; boost::shared_ptr<const Mantid::API::IMDWorkspace> workspace(pWorkspace); - RebinningKnowledgeSerializer generator; + VatesKnowledgeSerializer generator; generator.setImplicitFunction(impFunction); generator.setWorkspace(workspace); @@ -83,7 +83,7 @@ void testCreateXMLWithComponents() //Uses individual setters for geometry, locat EXPECT_CALL(*pImpFunction, toXMLString()).Times(1).WillRepeatedly(testing::Return("<ImplicitFunction/>")); Mantid::Geometry::MDImplicitFunction_sptr impFunction(pImpFunction); - RebinningKnowledgeSerializer generator; + VatesKnowledgeSerializer generator; //Apply setters. generator.setImplicitFunction(impFunction); generator.setWorkspaceName("name"); @@ -96,7 +96,7 @@ void testCreateXMLWithComponents() //Uses individual setters for geometry, locat void testCreateXMLWithoutFunction() { - RebinningKnowledgeSerializer generator; + VatesKnowledgeSerializer generator; //Apply setters. generator.setWorkspaceName("name"); generator.setGeometryXML("<DimensionSet/>"); @@ -107,7 +107,7 @@ void testCreateXMLWithoutFunction() void testGetGeometryXML() { - RebinningKnowledgeSerializer generator; + VatesKnowledgeSerializer generator; generator.setWorkspaceName("name"); std::string dimensionXMLString = "<DimensionSet/>"; generator.setGeometryXML(dimensionXMLString); @@ -118,8 +118,8 @@ void testGetGeometryXML() void testHasFunction() { - RebinningKnowledgeSerializer withoutFunction; - RebinningKnowledgeSerializer withFunction; + VatesKnowledgeSerializer withoutFunction; + VatesKnowledgeSerializer withFunction; Mantid::Geometry::MDImplicitFunction_sptr impFunction(new MockImplicitFunction); withFunction.setImplicitFunction(impFunction); @@ -130,21 +130,21 @@ void testHasFunction() void testHasGeometryInfoWithoutGeometry() { //Note that functions do not apply to this test set. - RebinningKnowledgeSerializer withoutGeometry; + VatesKnowledgeSerializer withoutGeometry; withoutGeometry.setWorkspaceName("-"); TSM_ASSERT_EQUALS("No Geometry provided. ::hasGeometryInfo() should return false.", false, withoutGeometry.hasGeometryInfo()); } void testHasGeometryInfoWithoutWSName() { - RebinningKnowledgeSerializer withoutWSName; + VatesKnowledgeSerializer withoutWSName; withoutWSName.setGeometryXML("-"); TSM_ASSERT_EQUALS("No WS name provided. ::hasGeometryInfo() should return false.", false, withoutWSName.hasGeometryInfo()); } void testHasGeometryAndWSInfo() { - RebinningKnowledgeSerializer withFullGeometryAndWSInfo; + VatesKnowledgeSerializer withFullGeometryAndWSInfo; withFullGeometryAndWSInfo.setGeometryXML("-"); withFullGeometryAndWSInfo.setWorkspaceName("-"); TSM_ASSERT_EQUALS("All geometry and ws information has been provided. ::hasGeometryInfo() should return true.", true, withFullGeometryAndWSInfo.hasGeometryInfo()); diff --git a/Code/Mantid/Vates/VatesSimpleGui/ViewWidgets/src/MultisliceView.cpp b/Code/Mantid/Vates/VatesSimpleGui/ViewWidgets/src/MultisliceView.cpp index 0e9005aaf876df26cad8d767d1fa7ee1d1e74fc1..6a6ea3228523ee6e7f8600ed88ec2daa3cb908f1 100644 --- a/Code/Mantid/Vates/VatesSimpleGui/ViewWidgets/src/MultisliceView.cpp +++ b/Code/Mantid/Vates/VatesSimpleGui/ViewWidgets/src/MultisliceView.cpp @@ -5,7 +5,7 @@ #include "MantidGeometry/MDGeometry/MDPlaneImplicitFunction.h" #include "MantidQtSliceViewer/SliceViewerWindow.h" #include "MantidQtFactory/WidgetFactory.h" -#include "MantidVatesAPI/RebinningKnowledgeSerializer.h" +#include "MantidVatesAPI/VatesKnowledgeSerializer.h" // Have to deal with ParaView warnings and Intel compiler the hard way. #if defined(__INTEL_COMPILER) @@ -223,7 +223,7 @@ void MultiSliceView::showCutInSliceViewer(int axisIndex, origin[2] = sliceOffsetOnAxis * orient[2]; // Create the XML holder - VATES::RebinningKnowledgeSerializer rks(VATES::LocationNotRequired); + VATES::VatesKnowledgeSerializer rks(VATES::LocationNotRequired); rks.setWorkspaceName(wsName.toStdString()); rks.setGeometryXML(geomXML);