mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-07-31 03:00:57 +00:00
75 lines
2.3 KiB
C++
75 lines
2.3 KiB
C++
//============================================================================
|
|
// 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 vtk_m_cont_internal_RuntimeDeviceOption_h
|
|
#define vtk_m_cont_internal_RuntimeDeviceOption_h
|
|
|
|
#include <vtkm/cont/vtkm_cont_export.h>
|
|
|
|
#include <vtkm/cont/internal/OptionParser.h>
|
|
#include <vtkm/cont/internal/OptionParserArguments.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
namespace internal
|
|
{
|
|
|
|
enum class RuntimeDeviceOptionSource
|
|
{
|
|
COMMAND_LINE,
|
|
ENVIRONMENT,
|
|
IN_CODE,
|
|
NOT_SET
|
|
};
|
|
|
|
class VTKM_CONT_EXPORT RuntimeDeviceOption
|
|
{
|
|
public:
|
|
/// Constructs a RuntimeDeviceOption, sets the Source to NOT_SET
|
|
/// params:
|
|
/// index - index location of this command line argument in an option::Option array
|
|
/// envName - The environment variable name of this option
|
|
VTKM_CONT RuntimeDeviceOption(const vtkm::Id& index, const std::string& envName);
|
|
|
|
VTKM_CONT virtual ~RuntimeDeviceOption() noexcept;
|
|
|
|
/// Initializes this option's value from the environment and then the provided options
|
|
/// array in that order. The options array is expected to be filled in using the
|
|
/// vtkm::cont::internal::option::OptionIndex with the usage vector defined in
|
|
/// vtkm::cont::Initialize.
|
|
VTKM_CONT void Initialize(const option::Option* options);
|
|
|
|
/// Sets the Value to the environment variable of the constructed EnvName
|
|
VTKM_CONT void SetOptionFromEnvironment();
|
|
|
|
/// Grabs and sets the option value using the constructed Index
|
|
VTKM_CONT void SetOptionFromOptionsArray(const option::Option* options);
|
|
|
|
/// Directly set the value for this option
|
|
VTKM_CONT void SetOption(const vtkm::Id& value);
|
|
|
|
VTKM_CONT vtkm::Id GetValue() const;
|
|
VTKM_CONT RuntimeDeviceOptionSource GetSource() const;
|
|
VTKM_CONT bool IsSet() const;
|
|
|
|
private:
|
|
const vtkm::Id Index;
|
|
const std::string EnvName;
|
|
RuntimeDeviceOptionSource Source;
|
|
vtkm::Id Value;
|
|
};
|
|
|
|
} // namespace vtkm::cont::internal
|
|
} // namespace vtkm::cont
|
|
} // namespace vtkm
|
|
|
|
#endif // vtk_m_cont_internal_RuntimeDeviceOption_h
|