nest::LayerMetadata Class Reference

Class containing spatial information to be used as metadata in a NodeCollection. More...

#include <spatial.h>

Inheritance diagram for nest::LayerMetadata:

Collaboration diagram for nest::LayerMetadata:

Public Member Functions
	LayerMetadata (AbstractLayerPTR)
	~LayerMetadata () override
void	set_status (const Dictionary &, bool) override
void	get_status (Dictionary &d, NodeCollection const *const nc) const override
	Retrieve status information sliced according to slicing of node collection.
void	get_status (Dictionary &d, const NodeCollectionPTR nc) const override
const AbstractLayerPTR	get_layer () const
	Returns pointer to object with layer representation.
std::string	get_type () const override
void	set_first_node_id (size_t node_id) override
size_t	get_first_node_id () const override
bool	operator== (const NodeCollectionMetadataPTR rhs) const override
Public Member Functions inherited from nest::NodeCollectionMetadata
	NodeCollectionMetadata ()=default
virtual	~NodeCollectionMetadata ()=default

Private Attributes
const AbstractLayerPTR	layer_
	layer object
size_t	first_node_id_

Detailed Description

Class containing spatial information to be used as metadata in a NodeCollection.

Constructor & Destructor Documentation

LayerMetadata()

nest::LayerMetadata::LayerMetadata

(

AbstractLayerPTR

layer

)

~LayerMetadata()

nest::LayerMetadata::~LayerMetadata ( )

inlineoverride

Member Function Documentation

get_first_node_id()

size_t nest::LayerMetadata::get_first_node_id ( ) const

inlineoverridevirtual

Implements nest::NodeCollectionMetadata.

References first_node_id_.

get_layer()

const AbstractLayerPTR nest::LayerMetadata::get_layer ( ) const

inline

Returns pointer to object with layer representation.

References layer_.

Referenced by nest::get_layer().

Here is the caller graph for this function:

get_status() [1/2]

void nest::LayerMetadata::get_status ( Dictionary &  d, const NodeCollectionPTR  nc  ) const

inlineoverridevirtual

Implements nest::NodeCollectionMetadata.

References get_status().

Here is the call graph for this function:

get_status() [2/2]

void nest::LayerMetadata::get_status ( Dictionary &  , NodeCollection const *const    ) const

inlineoverridevirtual

Retrieve status information sliced according to slicing of node collection.

Note

If nullptr is passed for NodeCollection*, full metadata irrespective of any slicing is returned. This is used by NodeCollectionMetadata::operator==() which does not have access to the NodeCollection.

This method is provided both accepting a naked pointer and a NodeCollectionPTR to allow calling from node collection itself, passing this, and with pointer provided from outside.

Implements nest::NodeCollectionMetadata.

References layer_.

Referenced by get_status(), and operator==().

Here is the caller graph for this function:

get_type()

std::string nest::LayerMetadata::get_type ( ) const

inlineoverridevirtual

Implements nest::NodeCollectionMetadata.

operator==()

bool nest::LayerMetadata::operator== ( const NodeCollectionMetadataPTR  rhs ) const

inlineoverridevirtual

Implements nest::NodeCollectionMetadata.

References get_status().

Here is the call graph for this function:

set_first_node_id()

void nest::LayerMetadata::set_first_node_id ( size_t  node_id )

inlineoverridevirtual

Implements nest::NodeCollectionMetadata.

References first_node_id_.

set_status()

void nest::LayerMetadata::set_status ( const Dictionary &  , bool    )

inlineoverridevirtual

Implements nest::NodeCollectionMetadata.

Member Data Documentation

first_node_id_

size_t nest::LayerMetadata::first_node_id_

private

Referenced by get_first_node_id(), and set_first_node_id().

layer_

const AbstractLayerPTR nest::LayerMetadata::layer_

private

layer object

Referenced by get_layer(), and get_status().

---

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

• spatial.h
• spatial.cpp