CreateDataPackClass Class Reference

Singleton class. Used to create Nest datapacks in a manner that makes them accessible to the NRP. More...

#include <create_datapack_class.h>

Public Member Functions
	CreateDataPackClass (boost::python::dict nest, boost::python::dict devMap)
	Constructor. More...
boost::python::object	createAndRegisterDataPack (boost::python::tuple args, boost::python::dict kwargs)
	Create new Nest datapack and add it to devMap. More...
void	registerDataPack (boost::python::str devName, boost::python::object nodeCollection)
	Register an existing datapack. More...
boost::python::dict	pyDevMap ()
	Python Call Function to get NRP datapack mapping. More...
const boost::python::dict &	devMap () const
	Get datapack map. More...
	CreateDataPackClass (boost::python::dict nest, boost::python::dict devMap)
	Constructor. More...
boost::python::object	createAndRegisterDataPack (boost::python::tuple args, boost::python::dict kwargs)
	Create new Nest datapack and add it to devMap. More...
void	registerDataPack (boost::python::str devName, boost::python::object nodeCollection)
	Register an existing datapack. More...
boost::python::dict	pyDevMap ()
	Python Call Function to get NRP datapack mapping. More...
const boost::python::dict &	devMap () const
	Get datapack map. More...

Static Public Member Functions
static boost::python::object	pyCreateDataPack (boost::python::tuple args, boost::python::dict kwargs)
	Python function to create datapack and register it in _devMap. More...
static boost::python::object	pyRegisterDataPack (boost::python::tuple args, boost::python::dict kwargs)
	pyRegisterDataPack More...
static boost::python::object	pyCreateDataPack (boost::python::tuple args, boost::python::dict kwargs)
	Python function to create datapack and register it in _devMap. More...
static boost::python::object	pyRegisterDataPack (boost::python::tuple args, boost::python::dict kwargs)
	pyRegisterDataPack More...

Detailed Description

Singleton class. Used to create Nest datapacks in a manner that makes them accessible to the NRP.

Constructor & Destructor Documentation

CreateDataPackClass() [1/2]

CreateDataPackClass::CreateDataPackClass	(	boost::python::dict	nest,
		boost::python::dict	devMap
	)

Constructor.

Parameters

nest	Nest Dict
devMap	DataPack Mapping

CreateDataPackClass() [2/2]

CreateDataPackClass::CreateDataPackClass	(	boost::python::dict	nest,
		boost::python::dict	devMap
	)

Constructor.

Parameters

nest	Nest Dict
devMap	DataPack Mapping

Member Function Documentation

createAndRegisterDataPack() [1/2]

boost::python::api::object CreateDataPackClass::createAndRegisterDataPack	(	boost::python::tuple	args,
		boost::python::dict	kwargs
	)

Create new Nest datapack and add it to devMap.

Parameters

args	Python Args. First argument must be string with datapack label. This will be used to reference the datapack from the NRP side. All other args will be passed to nest.Create(...)
kwargs	Python Keyword Args. Will be passed to nest.Create(...)

Returns

Returns either Nest NodeCollection (Nest 3.x) or python::tuple of nest GIDs (Nest 2.x)

createAndRegisterDataPack() [2/2]

boost::python::object CreateDataPackClass::createAndRegisterDataPack	(	boost::python::tuple	args,
		boost::python::dict	kwargs
	)

Create new Nest datapack and add it to devMap.

Parameters

args	Python Args. First argument must be string with datapack label. This will be used to reference the datapack from the NRP side. All other args will be passed to nest.Create(...)
kwargs	Python Keyword Args. Will be passed to nest.Create(...)

Returns

Returns either Nest NodeCollection (Nest 3.x) or python::tuple of nest GIDs (Nest 2.x)

devMap() [1/2]

const boost::python::dict & CreateDataPackClass::devMap

(

)

const

Get datapack map.

Returns

Returns datapack map

devMap() [2/2]

const boost::python::dict& CreateDataPackClass::devMap

(

)

const

Get datapack map.

Returns

Returns datapack map

pyCreateDataPack() [1/2]

boost::python::object CreateDataPackClass::pyCreateDataPack ( boost::python::tuple  args, boost::python::dict  kwargs  )

static

Python function to create datapack and register it in _devMap.

Parameters

args	Python Args. args[0] is CreateDataPackClass, args[1] is the NRP datapack name. The remaining args will be passed to nest.Create(...)
kwargs	Python Keyword Args. Will be passed to nest.Create(...)

Returns

Returns either Nest NodeCollection (Nest 3.x) or python::tuple of nest GIDs (Nest 2.x)

pyCreateDataPack() [2/2]

static boost::python::object CreateDataPackClass::pyCreateDataPack ( boost::python::tuple  args, boost::python::dict  kwargs  )

static

Python function to create datapack and register it in _devMap.

Parameters

args	Python Args. args[0] is CreateDataPackClass, args[1] is the NRP datapack name. The remaining args will be passed to nest.Create(...)
kwargs	Python Keyword Args. Will be passed to nest.Create(...)

Returns

Returns either Nest NodeCollection (Nest 3.x) or python::tuple of nest GIDs (Nest 2.x)

pyDevMap() [1/2]

boost::python::dict CreateDataPackClass::pyDevMap

(

)

Python Call Function to get NRP datapack mapping.

Returns

Returns dict with datapack mapping

pyDevMap() [2/2]

boost::python::dict CreateDataPackClass::pyDevMap

(

)

Python Call Function to get NRP datapack mapping.

Returns

Returns dict with datapack mapping

pyRegisterDataPack() [1/2]

static boost::python::object CreateDataPackClass::pyRegisterDataPack ( boost::python::tuple  args, boost::python::dict  kwargs  )

static

pyRegisterDataPack

Parameters

args	Python Args. args[0] is CreateDataPackClass, args[1] is the NRP datapack name, args[2] is a NodeCollection object
kwargs	Python Kwargs. Not used

pyRegisterDataPack() [2/2]

boost::python::object CreateDataPackClass::pyRegisterDataPack ( boost::python::tuple  args, boost::python::dict  kwargs  )

static

pyRegisterDataPack

Parameters

args	Python Args. args[0] is CreateDataPackClass, args[1] is the NRP datapack name, args[2] is a NodeCollection object
kwargs	Python Kwargs. Not used

registerDataPack() [1/2]

void CreateDataPackClass::registerDataPack	(	boost::python::str	devName,
		boost::python::object	nodeCollection
	)

Register an existing datapack.

Parameters

devName	NRP DataPack name
nodeCollection	NodeCollection of datapack data

registerDataPack() [2/2]

void CreateDataPackClass::registerDataPack	(	boost::python::str	devName,
		boost::python::object	nodeCollection
	)

Register an existing datapack.

Parameters

devName	NRP DataPack name
nodeCollection	NodeCollection of datapack data

---

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

• nrp_nest_engines/nrp_nest_json_engine/nrp_nest_json_engine/python/create_datapack_class.h
• nrp_nest_engines/nrp_nest_json_engine/nrp_nest_json_engine/python/create_datapack_class.cpp