Condition macros [Concept]

Macros used for to enforce preconditions and postconditions. More...

Defines
#define	OPENMS_PRECONDITION(condition, message)
	Precondition macro.
#define	OPENMS_POSTCONDITION(condition, message)
	Postcondition macro.

---

Detailed Description

Macros used for to enforce preconditions and postconditions.

These macros are enabled if debug info is enabled and optimization is disabled in configure. Otherwise they are replaced by an empty string, so they won't cost any performance.

The macros throw Exception::Precondition or Exception::Postcondition respectively if the condition fails.

---

Define Documentation

#define OPENMS_POSTCONDITION	(		condition,
			message
	)

Postcondition macro.

Referenced by FeatureFinderAlgorithmPicked< PeakType, FeatureType >::intensityScore_(), and FeatureFinderAlgorithmPicked< PeakType, FeatureType >::isotopeScore_().

#define OPENMS_PRECONDITION	(		condition,
			message
	)

Precondition macro.

Referenced by MSExperiment< SimPointType >::areaBegin(), MSExperiment< SimPointType >::areaBeginConst(), EmgScoring::calcElutionFitScore(), SimpleExtender< PeakType, FeatureType >::checkNeighbour_(), XMLHandler::cvStringToEnum_(), DPosition< DIMENSION >::DPosition(), DRange< 3 >::DRange(), SimpleExtender< PeakType, FeatureType >::extend(), SpectrumCanvas::getCurrentLayer(), PeakIndex::getFeature(), SpectrumCanvas::getLayer(), SpectrumCanvas::getLayer_(), SpectrumCanvas::getLayerFlag(), ProductModel< 2 >::getModel(), FeaFiModule< PeakType, FeatureType >::getNextMz(), FeaFiModule< PeakType, FeatureType >::getNextRt(), PeakIndex::getPeak(), FeaFiModule< PeakType, FeatureType >::getPeakIntensity(), FeaFiModule< PeakType, FeatureType >::getPeakMz(), FeaFiModule< PeakType, FeatureType >::getPeakRt(), FeaFiModule< PeakType, FeatureType >::getPrevMz(), FeaFiModule< PeakType, FeatureType >::getPrevRt(), PeakIndex::getSpectrum(), DPosition< DIMENSION >::getX(), DPosition< DIMENSION >::getY(), SimpleExtender< PeakType, FeatureType >::isTooFarFromCentroid_(), OfflinePrecursorIonSelection::makePrecursorSelectionForKnownLCMSMap(), Matrix< DoubleReal >::operator<(), Matrix< DoubleReal >::operator==(), DistanceMatrix< Value >::operator==(), DPosition< DIMENSION >::operator[](), MultiGradient::precalculatedColorByIndex(), MultiGradient::precalculatedColorIndex(), SpectrumCanvas::setLabel(), SpectrumCanvas::setLayerFlag(), ProductModel< 2 >::setModel(), DPosition< DIMENSION >::setX(), and DPosition< DIMENSION >::setY().