NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | Protected Attributes | List of all members
nest::UnionMask< D > Class Template Reference

Mask combining two masks with a Boolean OR, the sum. More...

#include <mask.h>

Inheritance diagram for nest::UnionMask< D >:
nest::Mask< D > nest::AbstractMask

Public Member Functions

 UnionMask (const Mask< D > &m1, const Mask< D > &m2)
 Construct the union of the two given masks. More...
 
 UnionMask (const UnionMask &m)
 Copy constructor. More...
 
 ~UnionMask ()
 
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
 
AbstractMaskintersect_mask (const AbstractMask &other) const
 Create the intersection of this mask with another. More...
 
AbstractMaskunion_mask (const AbstractMask &other) const
 Create the union of this mask with another. More...
 
AbstractMaskminus_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::UnionMask< D >

Mask combining two masks with a Boolean OR, the sum.

Constructor & Destructor Documentation

template<int D>
nest::UnionMask< D >::UnionMask ( const Mask< D > &  m1,
const Mask< D > &  m2 
)
inline

Construct the union of the two given masks.

Copies are made of the supplied Mask objects.

template<int D>
nest::UnionMask< D >::UnionMask ( const UnionMask< D > &  m)
inline

Copy constructor.

template<int D>
nest::UnionMask< D >::~UnionMask ( )
inline

Member Function Documentation

template<int D>
Mask< D > * nest::UnionMask< D >::clone ( ) const
virtual

Clone method.

Returns
dynamically allocated copy of mask object

Implements nest::Mask< D >.

template<int D>
Box< D > nest::UnionMask< 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 >.

References nest::Box< D >::lower_left, and nest::Box< D >::upper_right.

template<int D>
bool nest::UnionMask< D >::inside ( const Position< D > &  ) const
virtual
Returns
true if point is inside mask.

Implements nest::Mask< D >.

template<int D>
bool nest::UnionMask< 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::UnionMask< 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::UnionMask< D >::mask1_
protected
template<int D>
Mask<D> * nest::UnionMask< D >::mask2_
protected

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