celeritas::test::AuxMockParams Class Reference

Mock class for shared host data that has associated thread-local data. More...

#include <AuxMockParams.hh>

Inheritance diagram for celeritas::test::AuxMockParams:

Public Types
Type aliases
using	VecInt = std::vector< int >
template<MemSpace M>
using	StateT = AuxStateData< AuxMockStateData, M >
Public Types inherited from celeritas::AuxParamsInterface
using	UPState = std::unique_ptr< AuxStateInterface >
	Default destructor.
Public Types inherited from celeritas::ParamsDataInterface< AuxMockParamsData >
using	HostRef = HostCRef< AuxMockParamsData >
using	DeviceRef = DeviceCRef< AuxMockParamsData >

Public Member Functions
	AuxMockParams (std::string &&label, AuxId auxid, int num_bins, VecInt const &integers)
	Construct with properties.
User interface
Short name for the data
std::string_view	label () const final
	Index of this class instance in its registry.
AuxId	aux_id () const final
	Index of this class instance in its registry.
UPState	create_state (MemSpace, StreamId, size_type) const final
	Build state data for a stream.
Data interface
Access data on host
HostRef const &	host_ref () const final
	Access data on device.
DeviceRef const &	device_ref () const final
	Access data on device.
Public Member Functions inherited from celeritas::AuxParamsInterface
virtual	~AuxParamsInterface ()
	Default destructor.
Public Member Functions inherited from celeritas::ParamsDataInterface< AuxMockParamsData >
AuxMockParamsData< Ownership::const_reference, M > const &	ref () const
AuxMockParamsData< Ownership::const_reference, M > const &	ref () const
	Dispatch a "ref" call to host or device data.

Additional Inherited Members
Protected Member Functions inherited from celeritas::AuxParamsInterface
	AuxParamsInterface ()=default
	CELER_DEFAULT_COPY_MOVE (AuxParamsInterface)
	Default destructor.
Protected Member Functions inherited from celeritas::ParamsDataInterface< AuxMockParamsData >
	CELER_DEFAULT_COPY_MOVE (ParamsDataInterface)

Detailed Description

Mock class for shared host data that has associated thread-local data.

Member Function Documentation

aux_id()

AuxId celeritas::test::AuxMockParams::aux_id ( ) const

inlinefinalvirtual

Index of this class instance in its registry.

Implements celeritas::AuxParamsInterface.

create_state()

auto celeritas::test::AuxMockParams::create_state ( MemSpace  memspace, StreamId  stream, size_type  size  ) const

finalvirtual

Build state data for a stream.

Implements celeritas::AuxParamsInterface.

device_ref()

DeviceRef const & celeritas::test::AuxMockParams::device_ref ( ) const

inlinefinalvirtual

Access data on device.

Implements celeritas::ParamsDataInterface< AuxMockParamsData >.

host_ref()

HostRef const & celeritas::test::AuxMockParams::host_ref ( ) const

inlinefinalvirtual

Access data on device.

Implements celeritas::ParamsDataInterface< AuxMockParamsData >.

label()

std::string_view celeritas::test::AuxMockParams::label ( ) const

inlinefinalvirtual

Index of this class instance in its registry.

Implements celeritas::AuxParamsInterface.

---

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

• AuxMockParams.hh
• AuxMockParams.cc