umpire::resource::MemoryResourceFactory Class Reference

Abstract factory class for constructing MemoryResource objects. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/umpire/checkouts/develop/src/umpire/resource/MemoryResourceFactory.hpp>

Inheritance diagram for umpire::resource::MemoryResourceFactory:

Public Member Functions
virtual	~MemoryResourceFactory ()=default
virtual bool	isValidMemoryResourceFor (const std::string &name) noexcept=0
virtual std::unique_ptr< resource::MemoryResource >	create (const std::string &name, int id)=0
	Construct a MemoryResource with the given name and id. More...
virtual std::unique_ptr< resource::MemoryResource >	create (const std::string &name, int id, MemoryResourceTraits traits)=0
	Construct a MemoryResource with the given name and id. More...
virtual MemoryResourceTraits	getDefaultTraits ()=0

Detailed Description

Abstract factory class for constructing MemoryResource objects.

Concrete implementations of this class are used by the MemoryResourceRegistry to construct MemoryResource objects.

See also

MemoryResourceRegistry

Constructor & Destructor Documentation

~MemoryResourceFactory()

virtual umpire::resource::MemoryResourceFactory::~MemoryResourceFactory ( )

virtualdefault

Member Function Documentation

isValidMemoryResourceFor()

virtual bool umpire::resource::MemoryResourceFactory::isValidMemoryResourceFor ( const std::string &  name )

pure virtualnoexcept

Implemented in umpire::resource::OpenMPTargetResourceFactory.

create() [1/2]

virtual std::unique_ptr<resource::MemoryResource> umpire::resource::MemoryResourceFactory::create ( const std::string &  name, int  id  )

pure virtual

Construct a MemoryResource with the given name and id.

Parameters

name	Name of the MemoryResource.
id	ID of the MemoryResource.
traits	Traits for the MemoryResource

Implemented in umpire::resource::OpenMPTargetResourceFactory.

create() [2/2]

virtual std::unique_ptr<resource::MemoryResource> umpire::resource::MemoryResourceFactory::create ( const std::string &  name, int  id, MemoryResourceTraits  traits  )

pure virtual

Construct a MemoryResource with the given name and id.

Parameters

name	Name of the MemoryResource.
id	ID of the MemoryResource.
traits	Traits for the MemoryResource

Implemented in umpire::resource::OpenMPTargetResourceFactory.

getDefaultTraits()

virtual MemoryResourceTraits umpire::resource::MemoryResourceFactory::getDefaultTraits ( )

pure virtual

Implemented in umpire::resource::OpenMPTargetResourceFactory.