BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
InfinitePlane Class Reference
Tools
Inheritance diagram for InfinitePlane:
Collaboration diagram for InfinitePlane:

Public Member Functions

 InfinitePlane ()
 
InfinitePlane * clone () const
 
bool contains (double, double) const
 
bool contains (const Bin1D &, const Bin1D &) const
 
virtual void transferToCPP ()
 

Protected Member Functions

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

Private Attributes

const char *const m_name
 

Detailed Description

The infinite plane is used for masking everything once and forever.

Definition at line 23 of file InfinitePlane.h.

Constructor & Destructor Documentation

◆ InfinitePlane()

InfinitePlane::InfinitePlane ( )
inline

Definition at line 26 of file InfinitePlane.h.

26 : IShape2D("InfinitePlane") {}
IShape2D::IShape2D
IShape2D(const char *name)
Definition: IShape2D.h:29

Referenced by clone().

Member Function Documentation

◆ clone()

InfinitePlane* InfinitePlane::clone ( ) const
inlinevirtual

Implements IShape2D.

Definition at line 27 of file InfinitePlane.h.

27 { return new InfinitePlane(); }

References InfinitePlane().

Here is the call graph for this function:

◆ contains() [1/2]

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

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

Implements IShape2D.

Definition at line 29 of file InfinitePlane.h.

29 { return true; }

◆ contains() [2/2]

bool InfinitePlane::contains ( const Bin1D &  binx,
const Bin1D &  biny 
) const
inlinevirtual

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

30 { return true; }

◆ print()

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

Reimplemented in Polygon.

Definition at line 46 of file IShape2D.h.

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

References IShape2D::m_name.

◆ transferToCPP()

virtual void ICloneable::transferToCPP ( )
inlinevirtualinherited

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

Definition at line 34 of file ICloneable.h.

Member Data Documentation

◆ m_name

const char* const IShape2D::m_name
privateinherited

Definition at line 49 of file IShape2D.h.

Referenced by IShape2D::print().

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