Class IntervalAndCargo

A simple record type that stores an interval and a cargo value.

/*!
 * @class IntervalAndCargo
 * 
 * @headerfile <seqan/misc/interval_tree.h>
 * 
 * @brief A simple record type that stores an interval and a cargo value.
 * 
 * @signature template <[typename TValue[, typename TCargo]]> class
 *            IntervalAndCargo;
 * 
 * @tparam TValue The value type. Default: <tt>int</tt>.
 * @tparam TCargo The cargo type. Default: <tt>int</tt>.
 * 
 * @fn IntervalAndCargo::IntervalAndCargo
 * 
 * @brief Constructor
 * 
 * @signature IntervalAndCargo::IntervalAndCargo();
 * @signature IntervalAndCargo::IntervalAndCargo(i1, i2, cargo);
 * 
 * @param[in] i1 The first element in the interval.
 * @param[in] i2 The last element in the interval.
 * @param[in] cargo The cargo to store together with the interval.
 * 
 * @fn IntervalAndCargo#leftBoundary
 * 
 * @brief Access to left boundary.
 * 
 * @signature TBoundary leftBoundary(interval);
 * 
 * @param[in] interval The IntervalAndCargo to query for its left boundary.
 * 
 * @return TBoundary Reference to the left boundary value.
 * 
 * @fn IntervalAndCargo#rightBoundary
 * 
 * @brief Access to right boundary.
 * 
 * @signature TBoundary rightBoundary(interval);
 * 
 * @param[in] interval The IntervalAndCargo to query for its right boundary.
 * 
 * @return TBoundary Reference to the right boundary value.
 * 
 * @fn IntervalAndCargo#getLeftBoundary
 * 
 * @brief Access to getLeft boundary.
 * 
 * @signature TBoundary getLeftBoundary(interval);
 * 
 * @param[in] interval The IntervalAndCargo to query for its left boundary.
 * 
 * @return TBoundary Copy of the left boundary value.
 * 
 * @fn IntervalAndCargo#getRightBoundary
 * 
 * @brief Access to getRight boundary.
 * 
 * @signature TBoundary getRightBoundary(interval);
 * 
 * @param[in] interval The IntervalAndCargo to query for its right boundary.
 * 
 * @return TBoundary Copy of the right boundary value.
 * 
 * @fn IntervalAndCargo#cargo
 * 
 * @brief Access to the cargo.
 * 
 * @signature TCargo cargo(interval);
 * 
 * @param[in] interval The IntervalAndCargo to query for its cargo.
 * 
 * @return TCargo Reference to the cargo member.
 * 
 * @fn IntervalAndCargo#getCargo
 * 
 * @brief Access to the cargo.
 * 
 * @signature TCargo getCargo(interval);
 * 
 * @param[in] interval The IntervalAndCargo to query for its cargo.
 * 
 * @return TCargo Copy of the cargo member.
 * 
 * @mfn IntervalAndCargo#Value
 * 
 * @brief Return the value type.
 * 
 * @signature Value<TIntervalAndCargo>::Type;
 * 
 * @mfn IntervalAndCargo#Cargo
 * 
 * @brief Return the cargo type.
 * 
 * @signature Cargo<TIntervalAndCargo>::Type;
 * 
 * @var TValue IntervalAndCargo::i1;
 * 
 * @brief The first element in the interval.
 * 
 * @var TValue IntervalAndCargo::i2;
 * 
 * @brief The last element in the interval.
 * 
 * @var TCargo IntervalAndCargo::cargo;
 * 
 * @brief The stored cargo.
 */