HiCR::backend::hwloc::InstanceManager Class Reference

#include <instanceManager.hpp>

Inheritance diagram for HiCR::backend::hwloc::InstanceManager:

Public Member Functions
	InstanceManager ()
	~InstanceManager () override=default
__INLINE__ void	finalize () override
__INLINE__ void	abort (int errorCode) override
__INLINE__ HiCR::Instance::instanceId_t	getRootInstanceId () const override
Public Member Functions inherited from HiCR::InstanceManager
	InstanceManager ()=default
__INLINE__ instanceList_t &	getInstances ()
__INLINE__ std::shared_ptr< HiCR::Instance >	getCurrentInstance () const
__INLINE__ std::shared_ptr< HiCR::InstanceTemplate >	createInstanceTemplate (const HiCR::Topology &requestedTopology=HiCR::Topology())
__INLINE__ std::shared_ptr< HiCR::Instance >	createInstance (const HiCR::InstanceTemplate instanceTemplate)
__INLINE__ void	terminateInstance (const std::shared_ptr< HiCR::Instance > instance)
__INLINE__ void	addInstance (HiCR::Instance::instanceId_t instanceId)

Static Public Member Functions
static __INLINE__ std::unique_ptr< HiCR::InstanceManager >	createDefault (int *argc, char ***argv)

Additional Inherited Members
Public Types inherited from HiCR::InstanceManager
using	RPCTargetIndex_t = uint64_t
using	RPCFunction_t = std::function< void()>
using	instanceList_t = std::vector< std::shared_ptr< HiCR::Instance > >
Protected Member Functions inherited from HiCR::InstanceManager
virtual std::shared_ptr< HiCR::Instance >	createInstanceImpl (const HiCR::InstanceTemplate instanceTemplate)
virtual std::shared_ptr< HiCR::Instance >	addInstanceImpl (HiCR::Instance::instanceId_t instanceId)
virtual void	terminateInstanceImpl (const std::shared_ptr< HiCR::Instance > instance)
__INLINE__ void	setCurrentInstance (const std::shared_ptr< HiCR::Instance > &instance)
__INLINE__ void	addInstance (const std::shared_ptr< HiCR::Instance > &instance)

Detailed Description

Implementation of the HiCR hwloc Instance Manager

Constructor & Destructor Documentation

InstanceManager()

HiCR::backend::hwloc::InstanceManager::InstanceManager ( )

inline

Constructor for the hwloc instance manager

~InstanceManager()

HiCR::backend::hwloc::InstanceManager::~InstanceManager ( )

overridevirtualdefault

Default destructor

Reimplemented from HiCR::InstanceManager.

Member Function Documentation

abort()

__INLINE__ void HiCR::backend::hwloc::InstanceManager::abort ( int  errorCode )

inlineoverridevirtual

This function calls the internal implementation of the abort procedure for the given instance manager

Parameters

[in]

errorCode

The error code to publish upon aborting execution

Implements HiCR::InstanceManager.

createDefault()

static __INLINE__ std::unique_ptr< HiCR::InstanceManager > HiCR::backend::hwloc::InstanceManager::createDefault ( int *  argc, char ***  argv  )

inlinestatic

This function represents the default intializer for this backend

Parameters

[in]	argc	A pointer to the argc value, as passed to main() necessary for new HiCR instances to count with argument information upon creation.
[in]	argv	A pointer to the argv value, as passed to main() necessary for new HiCR instances to count with argument information upon creation.

Returns

A unique pointer to the newly instantiated backend class

finalize()

__INLINE__ void HiCR::backend::hwloc::InstanceManager::finalize ( )

inlineoverridevirtual

This function calls the internal implementation of the finalization procedure for the given instance manager

Implements HiCR::InstanceManager.

getRootInstanceId()

__INLINE__ HiCR::Instance::instanceId_t HiCR::backend::hwloc::InstanceManager::getRootInstanceId ( ) const

inlineoverridevirtual

Returns the id of the backend's root instance id

Returns

The id of the root instance id

Implements HiCR::InstanceManager.

---

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

• /home/runner/work/HiCR/HiCR/include/hicr/backends/hwloc/instanceManager.hpp