nest::NodeCollectionMetadata Class Reference

Class for Metadata attached to NodeCollection. More...

#include <node_collection.h>

Inheritance diagram for nest::NodeCollectionMetadata:

Public Member Functions
	NodeCollectionMetadata ()=default
virtual	~NodeCollectionMetadata ()=default
virtual void	set_status (const Dictionary &, bool)=0
virtual void	get_status (Dictionary &, NodeCollection const *const) const =0
	Retrieve status information sliced according to slicing of node collection.
virtual void	get_status (Dictionary &, const NodeCollectionPTR) const =0
virtual void	set_first_node_id (size_t)=0
virtual size_t	get_first_node_id () const =0
virtual std::string	get_type () const =0
virtual bool	operator== (const NodeCollectionMetadataPTR) const =0

Detailed Description

Class for Metadata attached to NodeCollection.

NEST modules that want to add metadata to NodeCollections they create need to implement their own concrete subclass.

Constructor & Destructor Documentation

NodeCollectionMetadata()

nest::NodeCollectionMetadata::NodeCollectionMetadata ( )

default

~NodeCollectionMetadata()

virtual nest::NodeCollectionMetadata::~NodeCollectionMetadata ( )

virtualdefault

Member Function Documentation

get_first_node_id()

virtual size_t nest::NodeCollectionMetadata::get_first_node_id ( ) const

pure virtual

Implemented in nest::LayerMetadata.

get_status() [1/2]

virtual void nest::NodeCollectionMetadata::get_status ( Dictionary &  , const NodeCollectionPTR    ) const

pure virtual

Implemented in nest::LayerMetadata.

get_status() [2/2]

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

pure virtual

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.

Implemented in nest::LayerMetadata.

get_type()

virtual std::string nest::NodeCollectionMetadata::get_type ( ) const

pure virtual

Implemented in nest::LayerMetadata.

operator==()

virtual bool nest::NodeCollectionMetadata::operator== ( const NodeCollectionMetadataPTR  ) const

pure virtual

Implemented in nest::LayerMetadata.

set_first_node_id()

virtual void nest::NodeCollectionMetadata::set_first_node_id ( size_t  )

pure virtual

Implemented in nest::LayerMetadata.

set_status()

virtual void nest::NodeCollectionMetadata::set_status ( const Dictionary &  , bool    )

pure virtual

Implemented in nest::LayerMetadata.

---

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

• node_collection.h