BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
InfinitePlane Class Reference

Description

The infinite plane is used for masking the entire detector.

Definition at line 28 of file InfinitePlane.h.

Inheritance diagram for InfinitePlane:
[legend]
Collaboration diagram for InfinitePlane:
[legend]

Public Member Functions

 InfinitePlane ()
 
InfinitePlaneclone () const override
 
bool contains (const Bin1D &, const Bin1D &) 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, double) const override
 Returns true if point with given coordinates is inside or on border of the shape. More...
 
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
 

Constructor & Destructor Documentation

◆ InfinitePlane()

InfinitePlane::InfinitePlane ( )
inline

Definition at line 30 of file InfinitePlane.h.

31  : IShape2D("InfinitePlane")
32  {
33  }
IShape2D(const char *name)
Definition: IShape2D.h:28

Referenced by clone().

Member Function Documentation

◆ clone()

InfinitePlane* InfinitePlane::clone ( ) const
inlineoverridevirtual

Implements IShape2D.

Definition at line 34 of file InfinitePlane.h.

34 { return new InfinitePlane(); }

References InfinitePlane().

Here is the call graph for this function:

◆ contains() [1/2]

bool InfinitePlane::contains ( const Bin1D binx,
const Bin1D biny 
) const
inlineoverridevirtual

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 37 of file InfinitePlane.h.

37 { return true; }

◆ contains() [2/2]

bool InfinitePlane::contains ( double  x,
double  y 
) const
inlineoverridevirtual

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

Implements IShape2D.

Definition at line 36 of file InfinitePlane.h.

36 { return true; }

◆ print()

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

Reimplemented in Polygon.

Definition at line 49 of file IShape2D.h.

49 { ostr << m_name; }
const char *const m_name
Definition: IShape2D.h:52

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().


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