Fixing Doxygen warnings

[u/mrichter/AliRoot.git] / MUON / mapping / AliMpArea.cxx

/**************************************************************************
 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 *                                                                        *
 * Author: The ALICE Off-line Project.                                    *
 * Contributors are mentioned in the code where appropriate.              *
 *                                                                        *
 * Permission to use, copy, modify and distribute this software and its   *
 * documentation strictly for non-commercial purposes is hereby granted   *
 * without fee, provided that the above copyright notice appears in all   *
 * copies and that both the copyright notice and this permission notice   *
 * appear in the supporting documentation. The authors make no claims     *
 * about the suitability of this software for any purpose. It is          *
 * provided "as is" without express or implied warranty.                  *
 **************************************************************************/

// $Id$
// $MpId: AliMpArea.cxx,v 1.8 2006/05/24 13:58:29 ivana Exp $
// Category: basic

//-----------------------------------------------------------------------------
// Class AliMpArea
// ----------------
// Class that defines a rectangle area positioned in plane..
// Included in AliRoot: 2003/05/02
// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
//-----------------------------------------------------------------------------

#include "AliMpArea.h"

#include "AliLog.h"
#include "AliMpConstants.h"

#include <Riostream.h>

/// \cond CLASSIMP
ClassImp(AliMpArea)
/// \endcond

//_____________________________________________________________________________
AliMpArea::AliMpArea(Double_t x, Double_t y, 
                     Double_t dx, Double_t dy)
  : TObject(),
    fPositionX(x),
    fPositionY(y),
    fDimensionX(dx),
    fDimensionY(dy),
    fValidity(true) 
{
/// Standard constructor

  // Check dimensions
  if (  fDimensionX < - AliMpConstants::LengthTolerance() || 
        fDimensionY < - AliMpConstants::LengthTolerance() || 
      ( fDimensionX < AliMpConstants::LengthTolerance() && 
        fDimensionY < AliMpConstants::LengthTolerance() ) )
  {
    fDimensionX = 0.;
    fDimensionY = 0.;
    fValidity = false;
  }  
}

//_____________________________________________________________________________
AliMpArea::AliMpArea()
  : TObject(),
    fPositionX(0.),
    fPositionY(0.),
    fDimensionX(0.),
    fDimensionY(0.),
    fValidity(false) 
{
/// Default constructor
}

//_____________________________________________________________________________
AliMpArea::AliMpArea(const AliMpArea& rhs):
  TObject(rhs),
  fPositionX(rhs.fPositionX),
  fPositionY(rhs.fPositionY),
  fDimensionX(rhs.fDimensionX), 
  fDimensionY(rhs.fDimensionY), 
  fValidity(rhs.fValidity) 
{
/// Copy constructor
}

//_____________________________________________________________________________
AliMpArea::~AliMpArea() 
{
/// Destructor
}

//
// operators
//

//______________________________________________________________________________
AliMpArea& AliMpArea::operator = (const AliMpArea& right)
{
/// Assignment operator

  // check assignment to self
  if (this == &right) return *this;

  // base class assignment
  TObject::operator=(right);

  fPositionX = right.fPositionX;
  fPositionY = right.fPositionY;
  fDimensionX = right.fDimensionX;
  fDimensionY = right.fDimensionY;
  fValidity = right.fValidity;

  return *this;
} 

//
// public methods
//

//_____________________________________________________________________________
Double_t AliMpArea::LeftBorder() const
{
/// Return the position of the left edge.

  return fPositionX - fDimensionX;
}

//_____________________________________________________________________________
Double_t AliMpArea::RightBorder() const
{
/// Return the position of right edge.

  return fPositionX + fDimensionX;
}

//_____________________________________________________________________________
Double_t AliMpArea::UpBorder() const
{
/// Return the position of the up edge.

  return fPositionY + fDimensionY;
}

//_____________________________________________________________________________
Double_t AliMpArea::DownBorder() const
{
/// Return the position of the down edge.

  return fPositionY - fDimensionY;
}

//_____________________________________________________________________________
void AliMpArea::LeftDownCorner(Double_t& x, Double_t& y) const
{
/// Return position of the left down corner.

  x = LeftBorder();
  y = DownBorder();
}  

//_____________________________________________________________________________
void AliMpArea::LeftUpCorner(Double_t& x, Double_t& y) const
{
/// Return position of the left up corner.

  x = LeftBorder();
  y = UpBorder();
}  

//_____________________________________________________________________________
void AliMpArea::RightDownCorner(Double_t& x, Double_t& y) const
{
/// Return position of the right down corner.

  x = RightBorder();
  y = DownBorder();
}  


//_____________________________________________________________________________
void AliMpArea::RightUpCorner(Double_t& x, Double_t& y) const
{
/// Return position of the right up corner.

  x = RightBorder();
  y = UpBorder();
}  

//_____________________________________________________________________________
Bool_t AliMpArea::Contains(const AliMpArea& area) const
{
/// Whether area is contained within this
  
//  return
//    ( area.LeftBorder() > LeftBorder() - AliMpConstants::LengthTolerance() &&
//      area.RightBorder() < RightBorder() +  AliMpConstants::LengthTolerance() &&
//      area.DownBorder() > DownBorder() - AliMpConstants::LengthTolerance() &&
//      area.UpBorder() < UpBorder() + AliMpConstants::LengthTolerance() );

  if ( area.LeftBorder() < LeftBorder() ||
       area.RightBorder() > RightBorder() ||
       area.DownBorder() < DownBorder() ||
       area.UpBorder() > UpBorder() ) 
  {
    return kFALSE;
  }
  else
  {
    return kTRUE;
  }
}

//_____________________________________________________________________________
AliMpArea AliMpArea::Intersect(const AliMpArea& area) const
{ 
/// Return the common part of area and this

  Double_t xmin = TMath::Max(area.LeftBorder(),LeftBorder());
  Double_t xmax = TMath::Min(area.RightBorder(),RightBorder());
  Double_t ymin = TMath::Max(area.DownBorder(),DownBorder());
  Double_t ymax = TMath::Min(area.UpBorder(),UpBorder());

  return AliMpArea( (xmin+xmax)/2.0, (ymin+ymax)/2.0 ,
                    (xmax-xmin)/2.0, (ymax-ymin)/2.0 );
}

//_____________________________________________________________________________
Bool_t AliMpArea::Overlap(const AliMpArea& area) const
{
/// Return true if this overlaps with given area

  if ( LeftBorder() > area.RightBorder() - AliMpConstants::LengthTolerance() ||
       RightBorder() < area.LeftBorder() + AliMpConstants::LengthTolerance() )
  {
    return kFALSE;
  }

  if ( DownBorder() > area.UpBorder() - AliMpConstants::LengthTolerance() ||
       UpBorder() < area.DownBorder() + AliMpConstants::LengthTolerance() )
  {
    return kFALSE;
  }
  return kTRUE;
  
}

//_____________________________________________________________________________
void
AliMpArea::Print(Option_t* opt) const
{
/// Printing
/// When option is set to B (borders), the area boreders will be printed 
/// instead of default parameters

  
  if ( opt[0] == 'B' ) {
    cout << "Area x-borders: (" 
         << LeftBorder() << ", " << RightBorder() << ") " 
	 << " y-borders: (" 
         << DownBorder() << ", " << UpBorder() << ") " 
	 << endl;
    return;

  }       

  cout << (*this) << endl;
}

//_____________________________________________________________________________
void      
AliMpArea::GetParameters(Double_t& x, Double_t& y,
                         Double_t& dx, Double_t& dy) const
{
/// Fill the parameters: x, y position and dimensions
                         
  x = fPositionX;
  y = fPositionY;
  dx = fDimensionX;
  dy = fDimensionY;
}  

//_____________________________________________________________________________
ostream& operator<< (ostream &stream,const AliMpArea& area)
{
/// Output streaming

  stream << "Area: position: (" 
         << area.GetPositionX() << ", " << area.GetPositionY() << ") " 
	 << " dimensions: (" 
         << area.GetDimensionX() << ", " << area.GetDimensionY() << ") " 
  << " valid: " << (area.IsValid()==true ? "YES":"NO")
	 << endl;
  return stream;
}