JG ROOT Tools libraries  version 5.0 - august 2014
RContourBase Class Referenceabstract

#include <RContourBase.hh>

Inheritance diagram for RContourBase:
RContourBase1D RContourBase2D RContourBaseGate RContourBaseCircle RContourBaseEllipse RContourBasePolygon

Public Member Functions

 RContourBase ()
 
 RContourBase (const RContourBase &ct)
 
RContourBaseoperator= (const RContourBase &ct)
 
virtual ~RContourBase ()
 
virtual bool Compare (const RContourBase *ct_ptr) const =0
 
virtual bool operator== (const RContourBase &ct) const
 
virtual bool operator!= (const RContourBase &ct) const
 
virtual void SetFlipAxis (const bool flip=true)
 
virtual bool GetFlipAxis () const
 
virtual bool CheckPoint (const Double_t x, const Double_t y) const
 
virtual bool CheckPoint (const RPoint2D &p) const =0
 
virtual bool CheckValue (const Double_t val) const =0
 
virtual Int_t Dimension () const =0
 
virtual Int_t Type () const =0
 
virtual string TypeName () const =0
 
virtual bool Write (ostream &os) const
 
virtual bool Write (FILE *fptr) const
 
virtual TList * CreateObjectList () const =0
 
 ClassDef (RContourBase, 0)
 

Static Public Member Functions

static RContourBaseReadNew (istream &is)
 
static RContourBaseReadNew (FILE *fptr)
 

Protected Member Functions

virtual bool WriteData (ostream &os) const =0
 
virtual bool WriteData (FILE *fptr) const =0
 

Protected Attributes

bool flip_axis
 Axis inversion.
 

Private Member Functions

 GObjectV (RContourBase)
 

Detailed Description

Base class for 1D and 2D contours definition.

Constructor & Destructor Documentation

RContourBase::RContourBase ( )

Default constructor.

References flip_axis.

RContourBase::RContourBase ( const RContourBase ct)

Copy constructor.

Parameters
ctcontour to copy

References flip_axis.

RContourBase::~RContourBase ( )
virtual

Destructor.

Member Function Documentation

RContourBase::GObjectV ( RContourBase  )
private

Macro from GCpp library that defines the following functions:

  • ClassName(): return the real class name of the object
  • StaticClassName(): return the used class name of the object (that may be a base class of the real object).
  • IsInstanceOf<T>(): return true if the current object is an instance of the template class name argument
  • Clone(): return an allocated copy of the object.
RContourBase & RContourBase::operator= ( const RContourBase ct)

Affectation operator.

Parameters
ctcontour to copy

References flip_axis.

virtual bool RContourBase::Compare ( const RContourBase ct_ptr) const
pure virtual

Abstract function for contours comparison operators.

Parameters
ct_ptrcontour pointer

Implemented in RContourBaseEllipse, RContourBaseGate, RContourBasePolygon, and RContourBaseCircle.

Referenced by operator!=(), and operator==().

bool RContourBase::operator== ( const RContourBase ct) const
inlinevirtual

Comparison operator.

Parameters
ctoperand contour

References Compare().

bool RContourBase::operator!= ( const RContourBase ct) const
inlinevirtual

Comparison operator.

Parameters
ctoperand contour

References Compare().

void RContourBase::SetFlipAxis ( const bool  flip = true)
inlinevirtual

Set X/Y axis inversion for contour.

Parameters
flipinversion status

References flip_axis.

Referenced by RGContourEdit::GateFlipHVButton(), and RContour::SetFlipAxis().

bool RContourBase::GetFlipAxis ( ) const
inlinevirtual

Get X/Y axis inversion for contour.

References flip_axis.

Referenced by RGContourEdit::DrawAssociatedObject(), RGContourEdit::GateFlipHVButton(), and RContour::GetFlipAxis().

bool RContourBase::CheckPoint ( const Double_t  x,
const Double_t  y 
) const
inlinevirtual

Test if (x,y) point is in the contour.

Parameters
xpoint X position
ypoint Y position

Reimplemented in RContourBaseEllipse, RContourBasePolygon, RContourBaseCircle, RContourBase2D, and RContourBase1D.

Referenced by RContour::CheckPoint().

virtual bool RContourBase::CheckPoint ( const RPoint2D p) const
pure virtual

Check whether a point is inside a contour: for 2D contour, a test is performed, for 1D contour result is always false.

Parameters
ppoint to check

Implemented in RContourBaseEllipse, RContourBasePolygon, RContourBaseCircle, RContourBase2D, and RContourBase1D.

virtual bool RContourBase::CheckValue ( const Double_t  val) const
pure virtual

Check whether a value is inside a 1D contour (always false for a 2D contour.

Parameters
valvalue to check

Implemented in RContourBaseGate, and RContourBase2D.

Referenced by RContourBase1D::CheckPoint(), and RContour::CheckValue().

virtual Int_t RContourBase::Dimension ( ) const
pure virtual

Return contour dimension.

Implemented in RContourBase2D, and RContourBase1D.

Referenced by RContour::Dimension().

virtual string RContourBase::TypeName ( ) const
pure virtual

Return contour type name.

Implemented in RContourBaseEllipse, RContourBaseGate, RContourBasePolygon, and RContourBaseCircle.

Referenced by RContour::TypeName(), and Write().

bool RContourBase::Write ( ostream &  os) const
virtual

Ecriture du contour dans un flux de sortie.

Parameters
osflux de sortie

References Type(), TypeName(), and WriteData().

Referenced by RContour::Write().

bool RContourBase::Write ( FILE *  fptr) const
virtual

Ecriture du contour dans un fichier de sortie.

Parameters
fptrpointeur de fichier

References Type(), TypeName(), and WriteData().

RContourBase * RContourBase::ReadNew ( istream &  is)
static

Fonction d'allocation d'un nouveau contour par lecture dans un flux d'entrée.

Parameters
isflux d'entrée

References RContourBasePolygon::ReadNew(), and RContourBaseGate::ReadNew().

Referenced by RContour::Read().

RContourBase * RContourBase::ReadNew ( FILE *  fptr)
static

Fonction d'allocation d'un nouveau contour par lecture dans un fichier d'entrée.

Parameters
fptrpointeur de fichier

References RContourBaseCircle::ReadNew(), RContourBasePolygon::ReadNew(), RContourBaseGate::ReadNew(), and RContourBaseEllipse::ReadNew().

virtual TList* RContourBase::CreateObjectList ( ) const
pure virtual

Creation of associated ROOT objects list.

Implemented in RContourBaseEllipse, RContourBaseGate, RContourBasePolygon, and RContourBaseCircle.

Referenced by RContour::CreateObjectList().

virtual bool RContourBase::WriteData ( ostream &  os) const
protectedpure virtual

Write contour data in an output C++ stream.

Parameters
osoutput C++ stream

Implemented in RContourBaseEllipse, RContourBaseGate, RContourBasePolygon, and RContourBaseCircle.

Referenced by Write().

virtual bool RContourBase::WriteData ( FILE *  fptr) const
protectedpure virtual

Write contour data in an output C-style file.

Parameters
fptrC-style file pointer

Implemented in RContourBaseEllipse, RContourBaseGate, RContourBasePolygon, and RContourBaseCircle.

RContourBase::ClassDef ( RContourBase  ,
 
)

For ROOT dictionary.


The documentation for this class was generated from the following files: