VerticalLine Class Reference

Description

An infinite vertical line.

Definition at line 38 of file Line.h.

Inheritance diagram for VerticalLine:

Collaboration diagram for VerticalLine:

Public Member Functions
	VerticalLine (double x)
VerticalLine *	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	getXpos () 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_x

Constructor & Destructor Documentation

VerticalLine()

VerticalLine::VerticalLine

(

double

x

)

Parameters

x	The value at which it crosses x-axes

Definition at line 68 of file Line.cpp.

    : IShape2D("VerticalLine")
    , m_x(x)
{
}

Referenced by clone().

Member Function Documentation

clone()

VerticalLine* VerticalLine::clone ( ) const

inlineoverridevirtual

Implements IShape2D.

Definition at line 41 of file Line.h.

{ return new VerticalLine(m_x); }

References VerticalLine(), and m_x.

Here is the call graph for this function:

contains() [1/2]

bool VerticalLine::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 79 of file Line.cpp.

{
    return m_x >= binx.m_lower && m_x <= binx.m_upper;
}

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

contains() [2/2]

bool VerticalLine::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 74 of file Line.cpp.

{
    return BaseUtils::algo::almostEqual(x, m_x);
}

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

Here is the call graph for this function:

getXpos()

double VerticalLine::getXpos ( ) const

inline

Definition at line 46 of file Line.h.

{ return m_x; }

References m_x.

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_x

double VerticalLine::m_x

private

Definition at line 49 of file Line.h.

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

---

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