Initialize.h

Go to the documentation of this file.

//============================================================================
//  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_Initialize_h
#define vtk_m_cont_Initialize_h
 
#include <vtkm/cont/DeviceAdapterTag.h>
#include <vtkm/cont/vtkm_cont_export.h>
#include <vtkm/internal/ExportMacros.h>
 
#include <string>
#include <type_traits>
#include <vector>
 
namespace vtkm
{
namespace cont
{
 
struct InitializeResult
{
  DeviceAdapterId Device = DeviceAdapterTagUndefined{};
 
  std::string Usage;
};
 
enum class InitializeOptions
{
  None = 0x00,
 
  RequireDevice = 0x01,
 
  DefaultAnyDevice = 0x02,
 
  AddHelp = 0x04,
 
  ErrorOnBadOption = 0x08,
 
  ErrorOnBadArgument = 0x10,
 
  Strict = ErrorOnBadOption | ErrorOnBadArgument | AddHelp
};
 
// Allow options to be used as a bitfield
inline InitializeOptions operator|(const InitializeOptions& lhs, const InitializeOptions& rhs)
{
  using T = std::underlying_type<InitializeOptions>::type;
  return static_cast<InitializeOptions>(static_cast<T>(lhs) | static_cast<T>(rhs));
}
inline InitializeOptions operator&(const InitializeOptions& lhs, const InitializeOptions& rhs)
{
  using T = std::underlying_type<InitializeOptions>::type;
  return static_cast<InitializeOptions>(static_cast<T>(lhs) & static_cast<T>(rhs));
}
 
VTKM_CONT_EXPORT
VTKM_CONT
InitializeResult Initialize(int& argc,
                            char* argv[],
                            InitializeOptions opts = InitializeOptions::None);
VTKM_CONT_EXPORT
VTKM_CONT
InitializeResult Initialize();
}
} // end namespace vtkm::cont
 
 
#endif // vtk_m_cont_Initialize_h