A FieldSelection stores information about fields to map for input dataset to output when a filter is executed. More...

#include <FieldSelection.h>

Public Types
enum	Mode { Mode::None, Mode::All, Mode::Select, Mode::Exclude }

Public Member Functions
	FieldSelection (Mode mode=Mode::Select)

	FieldSelection (const std::string &field, Mode mode=Mode::Select)
	Use this constructor to create a field selection given a single field name. More...

	FieldSelection (const char *field, Mode mode=Mode::Select)
	Use this constructor to create a field selection given a single field name. More...

	FieldSelection (const std::string &field, vtkm::cont::Field::Association association, Mode mode=Mode::Select)
	Use this constructor to create a field selection given a single name and association. More...

	FieldSelection (std::initializer_list< std::string > fields, Mode mode=Mode::Select)
	Use this constructor to create a field selection given the field names. More...

	FieldSelection (std::initializer_list< std::pair< std::string, vtkm::cont::Field::Association >> fields, Mode mode=Mode::Select)
	Use this constructor create a field selection given the field names and associations e.g. More...

	FieldSelection (std::initializer_list< vtkm::Pair< std::string, vtkm::cont::Field::Association >> fields, Mode mode=Mode::Select)
	Use this constructor create a field selection given the field names and associations e.g. More...

	FieldSelection (const FieldSelection &src)

	FieldSelection (FieldSelection &&rhs)

FieldSelection &	operator= (const FieldSelection &src)

FieldSelection &	operator= (FieldSelection &&rhs)

	~FieldSelection ()

bool	IsFieldSelected (const vtkm::cont::Field &inputField) const
	Returns true if the input field should be mapped to the output dataset. More...

bool	IsFieldSelected (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any) const

bool	HasField (const vtkm::cont::Field &inputField) const
	Returns true if the input field has been added to this selection. More...

bool	HasField (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any) const

void	ClearFields ()
	Clear all fields added using `AddField`. More...

Mode	GetMode () const
	Gets the mode of the field selection. More...

void	SetMode (Mode val)
	Sets the mode of the field selection. More...


void	AddField (const vtkm::cont::Field &inputField)

void	AddField (const vtkm::cont::Field &inputField, Mode mode)

void	AddField (const std::string &fieldName, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)

void	AddField (const std::string &fieldName, Mode mode)

void	AddField (const std::string &fieldName, vtkm::cont::Field::Association association, Mode mode)


Mode	GetFieldMode (const vtkm::cont::Field &inputField) const

Mode	GetFieldMode (const std::string &fieldName, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any) const

Private Attributes
std::unique_ptr< InternalStruct >	Internals

Detailed Description

A FieldSelection stores information about fields to map for input dataset to output when a filter is executed.

A FieldSelection object is passed to vtkm::filter::Filter::Execute to execute the filter and map selected fields. It is possible to easily construct FieldSelection that selects all or none of the input fields.

Member Enumeration Documentation

◆ Mode

enum vtkm::filter::FieldSelection::Mode

strong

Enumerator
None
All
Select
Exclude

Constructor & Destructor Documentation

◆ FieldSelection() [1/9]

vtkm::filter::FieldSelection::FieldSelection ( Mode mode = Mode::Select )

◆ FieldSelection() [2/9]

vtkm::filter::FieldSelection::FieldSelection	(	const std::string &	field,
		Mode	mode = `Mode::Select`
	)

Use this constructor to create a field selection given a single field name.

FieldSelection("field_name");

◆ FieldSelection() [3/9]

vtkm::filter::FieldSelection::FieldSelection	(	const char *	field,
		Mode	mode = `Mode::Select`
	)

Use this constructor to create a field selection given a single field name.

FieldSelection("field_name");

◆ FieldSelection() [4/9]

vtkm::filter::FieldSelection::FieldSelection	(	const std::string &	field,
		vtkm::cont::Field::Association	association,
		Mode	mode = `Mode::Select`
	)

Use this constructor to create a field selection given a single name and association.

FieldSelection("field_name", vtkm::cont::Field::Association::Points)

{cpp}

◆ FieldSelection() [5/9]

vtkm::filter::FieldSelection::FieldSelection	(	std::initializer_list< std::string >	fields,
		Mode	mode = `Mode::Select`
	)

Use this constructor to create a field selection given the field names.

FieldSelection({"field_one", "field_two"});

◆ FieldSelection() [6/9]

vtkm::filter::FieldSelection::FieldSelection	(	std::initializer_list< std::pair< std::string, vtkm::cont::Field::Association >>	fields,
		Mode	mode = `Mode::Select`
	)

Use this constructor create a field selection given the field names and associations e.g.

using pair_type = std::pair<std::string, vtkm::cont::Field::Association>;
FieldSelection({
     pair_type{"field_one", vtkm::cont::Field::Association::Points},
     pair_type{"field_two", vtkm::cont::Field::Association::Cells} });

◆ FieldSelection() [7/9]

vtkm::filter::FieldSelection::FieldSelection	(	std::initializer_list< vtkm::Pair< std::string, vtkm::cont::Field::Association >>	fields,
		Mode	mode = `Mode::Select`
	)

Use this constructor create a field selection given the field names and associations e.g.

using pair_type = vtkm::Pair<std::string, vtkm::cont::Field::Association>;
FieldSelection({
     pair_type{"field_one", vtkm::cont::Field::Association::Points},
     pair_type{"field_two", vtkm::cont::Field::Association::Cells} });

◆ FieldSelection() [8/9]

vtkm::filter::FieldSelection::FieldSelection ( const FieldSelection & src )

◆ FieldSelection() [9/9]

vtkm::filter::FieldSelection::FieldSelection ( FieldSelection && rhs )

◆ ~FieldSelection()

vtkm::filter::FieldSelection::~FieldSelection ( )