nest::AllMask< D > Class Template Reference

Mask which covers all of space. More...

#include <mask.h>

Inheritance diagram for nest::AllMask< D >:

Collaboration diagram for nest::AllMask< D >:

Public Member Functions
	~AllMask ()
bool	inside (const Position< D > &) const
bool	inside (const Box< D > &) const
bool	outside (const Box< D > &) const
Box< D >	get_bbox () const
	The whole mask is inside (i.e., false everywhere outside) the bounding box.
Mask< D > *	clone () const
	Clone method.
Public Member Functions inherited from nest::Mask< D >
	~Mask () override
bool	inside (const std::vector< double > &pt) const override
AbstractMask *	intersect_mask (const AbstractMask &other) const override
	Create the intersection of this mask with another.
AbstractMask *	union_mask (const AbstractMask &other) const override
	Create the union of this mask with another.
AbstractMask *	minus_mask (const AbstractMask &other) const override
	Create the difference of this mask and another.
virtual bool	inside (const std::vector< double > &) const=0
Public Member Functions inherited from nest::AbstractMask
virtual	~AbstractMask ()
virtual Dictionary	get_dict () const

Detailed Description

template<int D>
class nest::AllMask< D >

Mask which covers all of space.

Constructor & Destructor Documentation

~AllMask()

template<int D>

nest::AllMask< D >::~AllMask ( )

inline

Member Function Documentation

clone()

template<int D>

Mask< D > * nest::AllMask< D >::clone ( ) const

inlinevirtual

Clone method.

Returns

dynamically allocated copy of mask object

Implements nest::Mask< D >.

get_bbox()

template<int D>

Box< D > nest::AllMask< D >::get_bbox ( ) const

inlinevirtual

The whole mask is inside (i.e., false everywhere outside) the bounding box.

Returns

bounding box

Implements nest::Mask< D >.

inside() [1/2]

template<int D>

bool nest::AllMask< D >::inside ( const Box< D > &  ) const

inlinevirtual

Returns

true always for this mask

Implements nest::Mask< D >.

inside() [2/2]

template<int D>

bool nest::AllMask< D >::inside ( const Position< D > &  ) const

inlinevirtual

Returns

true always for this mask.

Implements nest::Mask< D >.

outside()

template<int D>

bool nest::AllMask< D >::outside ( const Box< D > &  ) const

inlinevirtual

Returns

false always for this mask

Reimplemented from nest::Mask< D >.

---

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

• mask.h