RuntimeDeviceConfiguration.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//============================================================================
#ifndef viskores_cont_internal_RuntimeDeviceConfiguration_h
#define viskores_cont_internal_RuntimeDeviceConfiguration_h
 
#include <viskores/cont/viskores_cont_export.h>
 
#include <viskores/cont/DeviceAdapterTag.h>
#include <viskores/cont/internal/RuntimeDeviceConfigurationOptions.h>
 
#include <vector>
 
namespace viskores
{
namespace cont
{
namespace internal
{
 
enum class RuntimeDeviceConfigReturnCode
{
  SUCCESS,
  OUT_OF_BOUNDS,
  INVALID_FOR_DEVICE,
  INVALID_VALUE,
  NOT_APPLIED
};
 
class VISKORES_CONT_EXPORT RuntimeDeviceConfigurationBase
{
public:
  VISKORES_CONT virtual ~RuntimeDeviceConfigurationBase() noexcept;
  VISKORES_CONT virtual viskores::cont::DeviceAdapterId GetDevice() const = 0;
 
  VISKORES_CONT void Initialize(const RuntimeDeviceConfigurationOptions& configOptions);
  VISKORES_CONT void Initialize(const RuntimeDeviceConfigurationOptions& configOptions,
                                int& argc,
                                char* argv[]);
 
  VISKORES_CONT virtual RuntimeDeviceConfigReturnCode SetThreads(const viskores::Id& value);
  VISKORES_CONT virtual RuntimeDeviceConfigReturnCode SetDeviceInstance(const viskores::Id& value);
 
  VISKORES_CONT virtual RuntimeDeviceConfigReturnCode GetThreads(viskores::Id& value) const;
  VISKORES_CONT virtual RuntimeDeviceConfigReturnCode GetDeviceInstance(viskores::Id& value) const;
 
  VISKORES_CONT virtual RuntimeDeviceConfigReturnCode GetMaxThreads(viskores::Id& value) const;
  VISKORES_CONT virtual RuntimeDeviceConfigReturnCode GetMaxDevices(viskores::Id& value) const;
 
protected:
  VISKORES_CONT virtual void ParseExtraArguments(int& argc, char* argv[]);
 
  VISKORES_CONT virtual void InitializeSubsystem();
};
 
template <typename DeviceAdapterTag>
class RuntimeDeviceConfiguration;
 
} // namespace viskores::cont::internal
} // namespace viskores::cont
} // namespace viskores
 
#endif // viskores_cont_internal_RuntimeDeviceConfiguration_h