HorizontalLine Class Reference

Description

An infinite horizontal line.

Definition at line 55 of file Line.h.

Inheritance diagram for HorizontalLine:

Collaboration diagram for HorizontalLine:

Public Member Functions
	HorizontalLine (double y)
HorizontalLine *	clone () const override
bool	contains (const Bin1D &binx, const Bin1D &biny) const override
	Returns true if area defined by two bins is inside or on border of polygon (more precisely, if mid point of two bins satisfy this condition). More...
bool	contains (double x, double y) const override
	Returns true if point with given coordinates is inside or on border of the shape. More...
double	getYpos () const
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Member Functions
virtual void	print (std::ostream &ostr) const

Private Attributes
const char *const	m_name
double	m_y

Constructor & Destructor Documentation

HorizontalLine()

HorizontalLine::HorizontalLine

(

double

y

)

Parameters

y	The value at which it crosses y-axes

Definition at line 87 of file Line.cpp.

    : IShape2D("HorizontalLine")
    , m_y(y)
{
}

Referenced by clone().

Member Function Documentation

clone()

HorizontalLine* HorizontalLine::clone ( ) const

inlineoverridevirtual

Implements IShape2D.

Definition at line 58 of file Line.h.

{ return new HorizontalLine(m_y); }

References HorizontalLine(), and m_y.

Here is the call graph for this function:

contains() [1/2]

bool HorizontalLine::contains ( const Bin1D &  binx, const Bin1D &  biny  ) const

overridevirtual

Returns true if area defined by two bins is inside or on border of polygon (more precisely, if mid point of two bins satisfy this condition).

Implements IShape2D.

Definition at line 98 of file Line.cpp.

{
    return m_y >= biny.m_lower && m_y <= biny.m_upper;
}

References Bin1D::m_lower, Bin1D::m_upper, and m_y.

contains() [2/2]

bool HorizontalLine::contains ( double  x, double  y  ) const

overridevirtual

Returns true if point with given coordinates is inside or on border of the shape.

Implements IShape2D.

Definition at line 93 of file Line.cpp.

{
    return BaseUtils::algo::almostEqual(y, m_y);
}

References BaseUtils::algo::almostEqual(), and m_y.

Here is the call graph for this function:

getYpos()

double HorizontalLine::getYpos ( ) const

inline

Definition at line 63 of file Line.h.

{ return m_y; }

References m_y.

print()

virtual void IShape2D::print ( std::ostream &  ostr ) const

inlineprotectedvirtualinherited

Reimplemented in Polygon.

Definition at line 49 of file IShape2D.h.

{ ostr << m_name; }

References IShape2D::m_name.

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 32 of file ICloneable.h.

Member Data Documentation

m_name

const char* const IShape2D::m_name

privateinherited

Definition at line 52 of file IShape2D.h.

Referenced by IShape2D::print().

m_y

double HorizontalLine::m_y

private

Definition at line 66 of file Line.h.

Referenced by clone(), contains(), and getYpos().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Mask/Line.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Mask/Line.cpp