NEST: nest::DifferenceMask< D > Class Template Reference

NEST 2.6.0,not_revisioned_source_dir@0

Mask combining two masks with a minus operation, the difference. More...

#include <mask.h>

Inheritance diagram for nest::DifferenceMask< D >:

Public Member Functions
	DifferenceMask (const Mask< D > &m1, const Mask< D > &m2)
	Construct the difference of the two given masks. More...

	DifferenceMask (const DifferenceMask &m)
	Copy constructor. More...

	~DifferenceMask ()

bool	inside (const Position< D > &p) const

bool	inside (const Box< D > &b) const

bool	outside (const Box< D > &b) const

Box< D >	get_bbox () const
	The whole mask is inside (i.e., false everywhere outside) the bounding box. More...

Mask< D > *	clone () const
	Clone method. More...

Public Member Functions inherited from nest::Mask< D >
	~Mask ()

bool	inside (const std::vector< double_t > &pt) const

AbstractMask *	intersect_mask (const AbstractMask &other) const
	Create the intersection of this mask with another. More...

AbstractMask *	union_mask (const AbstractMask &other) const
	Create the union of this mask with another. More...

AbstractMask *	minus_mask (const AbstractMask &other) const
	Create the difference of this mask and another. More...

Public Member Functions inherited from nest::AbstractMask
virtual	~AbstractMask ()
	Virtual destructor. More...

virtual DictionaryDatum	get_dict () const

Protected Attributes
Mask< D > *	mask1_

Mask< D > *	mask2_

Detailed Description

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

Mask combining two masks with a minus operation, the difference.

Constructor & Destructor Documentation

template<int D>

nest::DifferenceMask< D >::DifferenceMask	(	const Mask< D > &	m1,
		const Mask< D > &	m2
	)

inline

Construct the difference of the two given masks.

Copies are made of the supplied Mask objects.

template<int D>

nest::DifferenceMask< D >::DifferenceMask ( const DifferenceMask< D > & m )

inline

Copy constructor.

template<int D>

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

inline

References nest::DifferenceMask< D >::mask1_, and nest::DifferenceMask< D >::mask2_.

Member Function Documentation

template<int D>

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

virtual

Clone method.

Returns: dynamically allocated copy of mask object

Implements nest::Mask< D >.

template<int D>

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

virtual

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

Returns: bounding box

Implements nest::Mask< D >.

template<int D>

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

virtual

Returns: true if point is inside mask.

Implements nest::Mask< D >.

template<int D>

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

virtual

Returns: true if the whole box is inside the mask.

Note: a return value of false is not a guarantee that the whole box is not inside the mask.

Implements nest::Mask< D >.

template<int D>

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

virtual

Returns: true if the whole box is outside the mask.

Note: a return value of false is not a guarantee that the whole box is not outside the mask.

Reimplemented from nest::Mask< D >.

Member Data Documentation

template<int D>

Mask<D>* nest::DifferenceMask< D >::mask1_

protected

Referenced by nest::DifferenceMask< D >::~DifferenceMask().

template<int D>

Mask<D> * nest::DifferenceMask< D >::mask2_

protected

Referenced by nest::DifferenceMask< D >::~DifferenceMask().

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