readout_types_test.cc File Reference

Test of readout_types.h types. More...

#include "boost/test/unit_test.hpp"
#include "larcoreobj/SimpleTypesAndConstants/readout_types.h"

Go to the source code of this file.

Macros
#define	READOUT_TYPES_TEST_SKIP_COMPILATION_ERRORS   1
#define	BOOST_TEST_MODULE   ( readout_types_test )

Functions
template<typename ID >
constexpr bool	assertGeoIDlevel ()
void	TestIDvalidity (readout::CryostatID const &id, bool answer)
template<typename TESTID , typename REFID = TESTID>
void	TestCompareSmallerID (TESTID const &id, REFID const &smaller)
	Test comparison operators. More...
template<typename TESTID , typename REFID = TESTID>
void	TestCompareSameID (TESTID const &id, REFID const &same)
	Test comparison operators. More...
template<typename TESTID >
void	TestCompareSelfID (TESTID const &id)
	Test comparison operators. More...
template<typename TESTID , typename REFID = TESTID>
void	TestCompareLargerID (TESTID const &id, REFID const &larger)
	Test comparison operators. More...
template<typename TESTID , typename REFID = TESTID>
void	TestIDcomparison (TESTID const &id, REFID const &smaller, REFID const &same, REFID const &larger)
	Test comparison operators. More...
void	test_CryostatID_defaultConstructor ()
void	test_CryostatID_directConstructor ()
void	test_TPCsetID_defaultConstructor ()
void	test_TPCsetID_integralConstructor ()
void	test_TPCsetID_nestedConstructor ()
void	test_TPCsetID_directConstructor ()
void	test_ROPID_defaultConstructor ()
void	test_ROPID_integralConstructor ()
void	test_ROPID_nestedConstructor ()
void	test_ROPID_directConstructor ()
	BOOST_AUTO_TEST_CASE (CryostatIDtest)
	BOOST_AUTO_TEST_CASE (TPCsetIDtest)
	BOOST_AUTO_TEST_CASE (ROPIDtest)

Detailed Description

Test of readout_types.h types.

Author

Gianluca Petrillo (petri.nosp@m.llo@.nosp@m.fnal..nosp@m.gov)

Date

June 19th, 2015

Definition in file readout_types_test.cc.

Macro Definition Documentation

#define BOOST_TEST_MODULE   ( readout_types_test )

Definition at line 24 of file readout_types_test.cc.

#define READOUT_TYPES_TEST_SKIP_COMPILATION_ERRORS   1

Definition at line 11 of file readout_types_test.cc.

Function Documentation

template<typename ID >

constexpr bool assertGeoIDlevel

(

)

Definition at line 33 of file readout_types_test.cc.

  { return geo::details::geoElementLevel<ID>() == ID::Level; }

BOOST_AUTO_TEST_CASE

(

CryostatIDtest

)

Definition at line 442 of file readout_types_test.cc.

                                     {
  test_CryostatID_defaultConstructor();
  test_CryostatID_directConstructor();
}

BOOST_AUTO_TEST_CASE

(

TPCsetIDtest

)

Definition at line 450 of file readout_types_test.cc.

                                   {
  test_TPCsetID_defaultConstructor();
  test_TPCsetID_nestedConstructor();
  test_TPCsetID_directConstructor();
  test_TPCsetID_integralConstructor();
}

BOOST_AUTO_TEST_CASE

(

ROPIDtest

)

Definition at line 460 of file readout_types_test.cc.

                                {
  test_ROPID_defaultConstructor();
  test_ROPID_nestedConstructor();
  test_ROPID_directConstructor();
  test_ROPID_integralConstructor();
}

void test_CryostatID_defaultConstructor

(

)

Definition at line 165 of file readout_types_test.cc.

                                          {

  BOOST_TEST_MESSAGE("Testing default-constructed cryostat ID");

  readout::CryostatID cid;

  // a default-constructed ID is invalid:
  TestIDvalidity(cid, false);

/* // feature not added
  // test assignment from ID_t
  cid = 1;
  BOOST_TEST(cid.Cryostat == 1);
*/

} // test_CryostatID_defaultConstructor()

void test_CryostatID_directConstructor

(

)

Definition at line 183 of file readout_types_test.cc.

                                         {

  BOOST_TEST_CHECKPOINT("Testing cryostat ID constructed with an integer");

  readout::CryostatID cid(1);

  // an explicitly constructed ID is valid:
  TestIDvalidity(cid, true);

  // check the ID value
  BOOST_TEST(cid.Cryostat == readout::CryostatID::CryostatID_t(1));

  // test comparison operators
  // (exercise copy constructor too)
  readout::CryostatID smaller_cid(0), same_cid(cid), larger_cid(2);

  TestIDcomparison(cid, smaller_cid, same_cid, larger_cid);


  // make sure the ID with cryostat 0 is fine (it's not a bad ID!)
  BOOST_TEST_CHECKPOINT("Testing cryostat ID constructed with an integer 0");

  readout::CryostatID first_cid(0);
  TestIDvalidity(cid, true);

  // check the ID value
  BOOST_TEST(first_cid.Cryostat == readout::CryostatID::CryostatID_t(0));

} // test_CryostatID_directConstructor()

void test_ROPID_defaultConstructor

(

)

Definition at line 315 of file readout_types_test.cc.

                                     {

  BOOST_TEST_CHECKPOINT("Testing default-constructed ROP ID");

  readout::ROPID rid;

  // a default-constructed ID is invalid:
  TestIDvalidity(rid, false);

} // test_ROPID_defaultConstructor()

void test_ROPID_directConstructor

(

)

Definition at line 372 of file readout_types_test.cc.

                                    {

  BOOST_TEST_CHECKPOINT("Testing ROP ID constructed with indices");

  readout::ROPID rid(1, 15, 32);

  // an explicitly constructed ID is valid:
  TestIDvalidity(rid, true);

  // check the ID value
  BOOST_TEST(rid.Cryostat == readout::CryostatID::CryostatID_t( 1));
  BOOST_TEST(rid.TPCset ==       readout::TPCsetID::TPCsetID_t(15));
  BOOST_TEST(rid.ROP ==                readout::ROPID::ROPID_t(32));

  BOOST_TEST_CHECKPOINT("Testing comparison with same TPC set ID");

  readout::ROPID
    smaller_rid(1, 15, 31), same_rid(1, 15, 32), larger_rid(1, 15, 33);
  TestIDcomparison(rid, smaller_rid, same_rid, larger_rid);

  BOOST_TEST_CHECKPOINT("Testing comparison with different TPC set ID (1)");
  readout::ROPID smaller_sid1(1, 14, 33), larger_sid1(1, 16, 31);
  TestCompareSmallerID(rid, smaller_sid1);
  TestCompareLargerID(rid, larger_sid1);
  BOOST_TEST_CHECKPOINT("Testing comparison with different TPC set ID (2)");
  readout::ROPID smaller_sid2(1, 14, 32), larger_sid2(1, 16, 32);
  TestCompareSmallerID(rid, smaller_sid2);
  TestCompareLargerID(rid, larger_sid2);

  BOOST_TEST_CHECKPOINT("Testing comparison with different cryostat ID");
  readout::ROPID smaller_cid1(0, 15, 33), larger_cid1(2, 15, 31);
  TestCompareSmallerID(rid, smaller_cid1);
  TestCompareLargerID(rid, larger_cid1);
  BOOST_TEST_CHECKPOINT("Testing comparison with different cryostat ID (2)");
  readout::ROPID smaller_cid2(0, 15, 32), larger_cid2(2, 15, 32);
  TestCompareSmallerID(rid, smaller_cid2);
  TestCompareLargerID(rid, larger_cid2);

  // test setting and accessing a single index
  BOOST_TEST(rid.getIndex<0U>() == 1);
  rid.writeIndex<0U>() = 2;
  BOOST_TEST(rid.getIndex<0U>() == 2);
  
  BOOST_TEST(rid.getIndex<1U>() == 15);
  rid.writeIndex<1U>() = 19;
  BOOST_TEST(rid.getIndex<1U>() == 19);
  
  BOOST_TEST(rid.getIndex<2U>() == 32);
  rid.writeIndex<2U>() = 76;
  BOOST_TEST(rid.getIndex<2U>() == 76);
  
  // make sure the ID with TPC 0 is fine (it's not a bad ID!)
  BOOST_TEST_CHECKPOINT("Testing ROP ID constructed with a ROP #0");

  readout::ROPID first_rid(0, 0, 0);
  TestIDvalidity(first_rid, true);

  // - check the ID value
  BOOST_TEST(first_rid.Cryostat == readout::CryostatID::CryostatID_t(0));
  BOOST_TEST(first_rid.TPCset ==       readout::TPCsetID::TPCsetID_t(0));
  BOOST_TEST(first_rid.ROP ==                readout::ROPID::ROPID_t(0));

} // test_ROPID_directConstructor()

void test_ROPID_integralConstructor

(

)

Definition at line 327 of file readout_types_test.cc.

                                      {

  BOOST_TEST_CHECKPOINT("Testing integral-constructed ROP ID");

#if READOUT_TYPES_TEST_SKIP_COMPILATION_ERRORS
  BOOST_TEST_MESSAGE("  (test skipped)");
#else
  readout::ROPID rid(1);

  BOOST_TEST_MESSAGE("ROPID(1) = " << std::string(rid));

  readout::ROPID::ROPID_t what = rid;

  BOOST_TEST_MESSAGE("int(ROPID(1)) = " << what);

#endif // READOUT_TYPES_TEST_SKIP_COMPILATION_ERRORS

} // test_ROPID_integralConstructor()

void test_ROPID_nestedConstructor

(

)

Definition at line 347 of file readout_types_test.cc.

                                    {

  BOOST_TEST_CHECKPOINT("Testing ID-constructed ROP ID");

  readout::TPCsetID sid(1, 15);
  readout::ROPID rid(sid, 32);

  // an explicitly constructed ID is valid:
  TestIDvalidity(rid, true);

  // check the ID value
  BOOST_TEST(rid.Cryostat == readout::CryostatID::CryostatID_t( 1));
  BOOST_TEST(rid.TPCset ==       readout::TPCsetID::TPCsetID_t(15));
  BOOST_TEST(rid.ROP ==                readout::ROPID::ROPID_t(32));

  // test comparison operators (exercise copy constructor too)
  BOOST_TEST_CHECKPOINT("Testing comparison with ROP ID");
  readout::ROPID smaller_rid(sid, rid.ROP - 1), same_rid(rid),
    larger_rid(sid, rid.ROP + 1);

  TestIDcomparison(rid, smaller_rid, same_rid, larger_rid);

} // test_ROPID_nestedConstructor()

void test_TPCsetID_defaultConstructor

(

)

Definition at line 215 of file readout_types_test.cc.

                                        {

  BOOST_TEST_CHECKPOINT("Testing default-constructed TPC set ID");

  readout::TPCsetID sid;

  // a default-constructed ID is invalid:
  TestIDvalidity(sid, false);

} // test_TPCsetID_defaultConstructor()

void test_TPCsetID_directConstructor

(

)

Definition at line 272 of file readout_types_test.cc.

                                       {

  BOOST_TEST_CHECKPOINT("Testing TPC set ID constructed with indices");

  readout::TPCsetID sid(1, 15);

  // an explicitly constructed ID is valid:
  TestIDvalidity(sid, true);

  BOOST_TEST_CHECKPOINT("Testing comparison with same cryostat ID");

  readout::TPCsetID smaller_sid(1, 14), same_sid(1, 15), larger_sid(1, 16);
  TestIDcomparison(sid, smaller_sid, same_sid, larger_sid);

  BOOST_TEST_CHECKPOINT("Testing comparison with different cryostat ID");
  readout::TPCsetID smaller_cid(0, 16), larger_cid(2, 14);
  TestCompareSmallerID(sid, smaller_cid);
  TestCompareLargerID(sid, larger_cid);

  // test setting and accessing a single index
  BOOST_TEST(sid.getIndex<0U>() == 1);
  sid.writeIndex<0U>() = 2;
  BOOST_TEST(sid.getIndex<0U>() == 2);
  
  BOOST_TEST(sid.getIndex<1U>() == 15);
  sid.writeIndex<1U>() = 19;
  BOOST_TEST(sid.getIndex<1U>() == 19);
  
  // make sure the ID with TPC set 0 is fine (it's not a bad ID!)
  BOOST_TEST_CHECKPOINT("Testing TPC set ID constructed with a TPC set #0");

  readout::TPCsetID first_sid(0, 0);
  TestIDvalidity(first_sid, true);

  // - check the ID value
  BOOST_TEST(first_sid.Cryostat == readout::CryostatID::CryostatID_t(0));
  BOOST_TEST(first_sid.TPCset ==       readout::TPCsetID::TPCsetID_t(0));


} // test_TPCsetID_directConstructor()

void test_TPCsetID_integralConstructor

(

)

Definition at line 227 of file readout_types_test.cc.

                                         {

  BOOST_TEST_CHECKPOINT("Testing integral-constructed TPC set ID");

#if READOUT_TYPES_TEST_SKIP_COMPILATION_ERRORS
  BOOST_TEST_MESSAGE("  (test skipped)");
#else
  readout::TPCsetID sid(1);

  BOOST_TEST_MESSAGE("TPCsetID(1) = " << std::string(sid));

  readout::TPCsetID::TPCsetID_t what = sid;

  BOOST_TEST_MESSAGE("int(TPCsetID(1)) = " << what);

#endif // READOUT_TYPES_TEST_SKIP_COMPILATION_ERRORS

} // test_TPCsetID_integralConstructor()

void test_TPCsetID_nestedConstructor

(

)

Definition at line 247 of file readout_types_test.cc.

                                       {

  BOOST_TEST_CHECKPOINT("Testing ID-constructed TPC set ID");

  readout::CryostatID cid(1);
  readout::TPCsetID sid(cid, 15);

  // an explicitly constructed ID is valid:
  TestIDvalidity(sid, true);

  // check the ID value
  BOOST_TEST(sid.Cryostat == readout::CryostatID::CryostatID_t( 1));
  BOOST_TEST(sid.TPCset ==       readout::TPCsetID::TPCsetID_t(15));

  // test comparison operators (exercise copy constructor too)
  // - with TPC ID
  BOOST_TEST_CHECKPOINT("Testing comparison with TPC set ID");
  readout::TPCsetID smaller_sid(cid, sid.TPCset - 1), same_sid(sid),
    larger_sid(cid, sid.TPCset + 1);

  TestIDcomparison(sid, smaller_sid, same_sid, larger_sid);

} // test_TPCsetID_nestedConstructor()

template<typename TESTID , typename REFID = TESTID>

void TestCompareLargerID	(	TESTID const &	id,
		REFID const &	larger
	)

Test comparison operators.

Definition at line 140 of file readout_types_test.cc.

                                                                 {
  BOOST_TEST(  id     <  larger  );
  BOOST_TEST(  id     != larger  );
  BOOST_TEST(!(id     == larger) );
  BOOST_TEST(!(larger <      id) );
  BOOST_TEST(larger.cmp(id) > 0);
  BOOST_TEST(id.cmp(larger) < 0);
} // TestCompareLargerID()

template<typename TESTID , typename REFID = TESTID>

void TestCompareSameID	(	TESTID const &	id,
		REFID const &	same
	)

Test comparison operators.

Definition at line 124 of file readout_types_test.cc.

                                                             {
  BOOST_TEST(!(id      <  same) );
  BOOST_TEST(  id      == same  );
  BOOST_TEST(!(id      != same) );
  BOOST_TEST(!(same <     id) );
  BOOST_TEST(same.cmp(id) == 0);
  BOOST_TEST(id.cmp(same) == 0);
} // TestCompareSameID()

template<typename TESTID >

void TestCompareSelfID

(

TESTID const &

id

)

Test comparison operators.

Definition at line 135 of file readout_types_test.cc.

  { return TestCompareSameID(id, id); }

template<typename TESTID , typename REFID = TESTID>

void TestCompareSmallerID	(	TESTID const &	id,
		REFID const &	smaller
	)

Test comparison operators.

Definition at line 113 of file readout_types_test.cc.

                                                                   {
  BOOST_TEST(!(id      <  smaller) );
  BOOST_TEST(!(id      == smaller) );
  BOOST_TEST(  id      != smaller  );
  BOOST_TEST(  smaller <       id  );
  BOOST_TEST(smaller.cmp(id) < 0);
  BOOST_TEST(id.cmp(smaller) > 0);
} // TestCompareSmallerID()

template<typename TESTID , typename REFID = TESTID>

void TestIDcomparison	(	TESTID const &	id,
		REFID const &	smaller,
		REFID const &	same,
		REFID const &	larger
	)

Test comparison operators.

Definition at line 152 of file readout_types_test.cc.

  {
  TestCompareSmallerID(id, smaller);
  TestCompareSameID(id, same);
  TestCompareSelfID(id);
  TestCompareLargerID(id, larger);
} // TestCryostatComparison()

void TestIDvalidity	(	readout::CryostatID const &	id,
		bool	answer
	)

Definition at line 102 of file readout_types_test.cc.

                                                              {
  // - check isValid
  BOOST_TEST(id.isValid == answer);
  // - check operator!
  BOOST_TEST(!id == !answer);
  // - check operator bool
  BOOST_TEST((bool)id == answer);
} // TestIDvalidity()