testParameterStorage.cc

Go to the documentation of this file.

#include <iostream>
#include <string>

#include <tst/Verify.h>

#include <utl/ParameterStorage.h>

#include <cppunit/extensions/HelperMacros.h>

using namespace std;
using namespace utl;
using namespace tst;

class testParameterStorage : public CppUnit::TestFixture {

  CPPUNIT_TEST_SUITE(testParameterStorage);
//CPPUNIT_TEST(testEqualAndCopyCtor);
  CPPUNIT_TEST(testHasSetGet);
  CPPUNIT_TEST_SUITE_END();

  // this is the enum to define the list of allowed parameters, should usually be put in a separate .h file
  // if the user numbers the enum by hand, it is possible to remove deprecated parameters afterwards
  enum Dimension { eHeight = 0,
                   /* eTest = 1, */
                   eWidth = 2,
                   eLength = 3};

private:
  ParameterStorage<Dimension, double> ourParameterStorage;

public:
  
  void
  setUp()
  {
  }

  void
  tearDown()
  {
  }

/*
  void
  testEqualAndCopyCtor()
  {
    ParameterStorage copyParameterStorage<Dimension, double>(ourParameterStorage);
    CPPUNIT_ASSERT(copyParameterStorage == ourParameterStorage);
    CPPUNIT_ASSERT(!(copyParameterStorage != ourParameterStorage));
  }
*/
  
  void
  testHasSetGet()
  {
    
    // verify that parameter eHeight has not been set
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.HasParameter(eHeight), false));
    
    // verify that getting undefined parameter eHeight produces an exception --- how to send result to test framework?
    try {
      ourParameterStorage.GetParameter(eHeight);
    }
    catch (NonExistentComponentException& ex) {
      cerr << "Auger exception: " << ex.GetExceptionName()
           << "\nMessage: " << ex.GetMessage() << endl;
    }

//  CPPUNIT_TEST_EXCEPTION( ourParameterStorage.GetParameter(eHeight) , NonExistentComponentException);   
    
    // set parameter eHeight without lock
    ourParameterStorage.SetParameter(eHeight, 123.4, false);
    
    // verify that parameter eHeight has now been set
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.HasParameter(eHeight), true));
    
    // verify that parameter eHeight can be read out correctly
    CPPUNIT_ASSERT(Verify<CloseTo>(ourParameterStorage.GetParameter(eHeight), 123.4));

    // verify that locking status of parameter eHeight can be read out correctly
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.GetParameterLockStatus(eHeight), false));

    // re-set parameter eHeight without lock
    ourParameterStorage.SetParameter(eHeight, 246.8, false);

    // verify that re-setting of parameter eHeight worked correctly
    CPPUNIT_ASSERT(Verify<CloseTo>(ourParameterStorage.GetParameter(eHeight), 246.8));

    // verify that setting covariance of eHeight, eWidth without parameter eWidth being set leads to an exception
    try {
    ourParameterStorage.SetParameterCovariance(eHeight, eWidth, 0.11, false);
    }
    catch (InvalidConfigurationException& ex) {
      cerr << "Auger exception: " << ex.GetExceptionName()
           << "\nMessage: " << ex.GetMessage() << endl;
    }

    // verify that deleting of parameter eHeight works correctly
    ourParameterStorage.DeleteParameter(eHeight);

    // verify that parameter eHeight has not been set
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.HasParameter(eHeight), false));
    
    // check that deleting unset parameter eLength does not hurt
    ourParameterStorage.DeleteParameter(eLength);
    
    // re-set parameter eHeight with lock
    ourParameterStorage.SetParameter(eHeight, 369.12, true);

    // verify that setting of parameter eHeight worked correctly
    CPPUNIT_ASSERT(Verify<CloseTo>(ourParameterStorage.GetParameter(eHeight), 369.12));

    // verify that parameter eHeight is now locked
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.GetParameterLockStatus(eHeight), true));

    // verify that deleting locked parameter eHeight produces an exception
    try {
      ourParameterStorage.DeleteParameter(eHeight);
    }
    catch (InvalidConfigurationException& ex) {
      cerr << "Auger exception: " << ex.GetExceptionName()
           << "\nMessage: " << ex.GetMessage() << endl;
    }

    // verify that parameter covariance between eHeight and eWidth has not been set
//  reactivate this once proper exceptions are thrown inside ParameterStorage
//  CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.HasParameterCovariance(eHeight, eWidth), false));
//  CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.HasParameterCovariance(eWidth, eHeight), false));
  
    // verify that getting undefined parameter covariance between eHeight and eWeight produces an exception --- how to send result to test framework?
    try {
      ourParameterStorage.GetParameterCovariance(eHeight, eWidth);
    }
    catch (NonExistentComponentException& ex) {
      cerr << "Auger exception: " << ex.GetExceptionName()
           << "\nMessage: " << ex.GetMessage() << endl;
    }

    // set parameter eWidth without lock
    ourParameterStorage.SetParameter(eWidth, 0.25, false);

    // set parameter covariance of eHeight, eWidth without lock
    ourParameterStorage.SetParameterCovariance(eHeight, eWidth, 0.33, false);
  
    // verify that parameter covariance between eHeight and eWidth has now been set
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.HasParameterCovariance(eHeight, eWidth), true));
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.HasParameterCovariance(eWidth, eHeight), true));
    
    // verify that parameter covariance between eHeight and eWidth can be read out correctly
    CPPUNIT_ASSERT(Verify<CloseTo>(ourParameterStorage.GetParameterCovariance(eHeight, eWidth), 0.33));
    CPPUNIT_ASSERT(Verify<CloseTo>(ourParameterStorage.GetParameterCovariance(eWidth, eHeight), 0.33));

    // verify that locking status of parameter-covariance between eHeight and eWidth can be read out correctly
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.GetParameterCovarianceLockStatus(eHeight, eWidth), false));
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.GetParameterCovarianceLockStatus(eWidth, eHeight), false));

    // verify that re-setting parameter-covariance between eHeight and eWidth works, keep lock open
    ourParameterStorage.SetParameterCovariance(eHeight, eWidth, 0.66, false);

    // verify that parameter covariance between eHeight and eWidth can be read out correctly
    CPPUNIT_ASSERT(Verify<CloseTo>(ourParameterStorage.GetParameterCovariance(eHeight, eWidth), 0.66));
    CPPUNIT_ASSERT(Verify<CloseTo>(ourParameterStorage.GetParameterCovariance(eWidth, eHeight), 0.66));

    // verify that deleting parameter covariance between eHeight and eWidth works
    ourParameterStorage.DeleteParameterCovariance(eHeight, eWidth);

    // verify that also the parameter covariances are gone
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.HasParameterCovariance(eHeight, eWidth), false));
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.HasParameterCovariance(eWidth, eHeight), false));

    // once again set parameter-covariance between eHeight and eWidth works, keep lock open
    ourParameterStorage.SetParameterCovariance(eHeight, eWidth, 0.66, false);

    // delete parameter eWidth to check if associated parameter covariance is deleted as well
    ourParameterStorage.DeleteParameter(eWidth);

    // verify that also the parameter covariances are gone
//  reactivate this once proper exceptions are thrown inside ParameterStorage
//  CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.HasParameterCovariance(eHeight, eWidth), false));
//  CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.HasParameterCovariance(eWidth, eHeight), false));

    // set again parameter eWidth, this time with lock
    ourParameterStorage.SetParameter(eWidth, 0.25, true);
    
    // set again parameter covariance of eHeight, eWidth with locking and check that it can be read out and is there
    ourParameterStorage.SetParameterCovariance(eHeight, eWidth, 0.77, true);
    CPPUNIT_ASSERT(Verify<CloseTo>(ourParameterStorage.GetParameterCovariance(eHeight, eWidth), 0.77));

    // verify that locking status of parameter-covariance between eHeight and eWidth is now true
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.GetParameterCovarianceLockStatus(eHeight, eWidth), true));
    CPPUNIT_ASSERT(Verify<Equal>(ourParameterStorage.GetParameterCovarianceLockStatus(eWidth, eHeight), true));
    
    // try to delete parameter covariance of eHeight and eWidth in spite of locked status and verify that exception is raised
    try {
      ourParameterStorage.DeleteParameterCovariance(eHeight, eWidth);
    }
    catch (InvalidConfigurationException& ex) {
      cerr << "Auger exception: " << ex.GetExceptionName()
           << "\nMessage: " << ex.GetMessage() << endl;
    }
     
  }

};

CPPUNIT_TEST_SUITE_REGISTRATION(testParameterStorage);

// Configure (x)emacs for this file ...
// Local Variables:
// mode: c++
// End: