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

Mask which covers all of space. More...

#include <mask.h>

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

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

Detailed Description

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

Mask which covers all of space.

Constructor & Destructor Documentation

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

Member Function Documentation

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

Clone method.

Returns
dynamically allocated copy of mask object

Implements nest::Mask< D >.

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

template<int D>
bool nest::AllMask< D >::inside ( const Position< D > &  ) const
inlinevirtual
Returns
true always for this mask.

Implements nest::Mask< D >.

template<int D>
bool nest::AllMask< D >::inside ( const Box< D > &  ) const
inlinevirtual
Returns
true always for this mask

Implements nest::Mask< D >.

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: