smtk::common::GeneratorBase< Input, Output, Base > Class Template Reference

Base for all generators. More...

#include <Generator.h>

Inheritance diagram for smtk::common::GeneratorBase< Input, Output, Base >:

Collaboration diagram for smtk::common::GeneratorBase< Input, Output, Base >:

Public Member Functions
template<typename... T>
	GeneratorBase (T &&... all)
virtual bool	valid (const Input &) const =0
	A discriminating method to determine whether or not the input should be considered for use as input by a generator type. More...
virtual Output	operator() (const Input &)=0
	Function call operator for generating Output-s. More...

Detailed Description

template<class Input, class Output, class Base = detail::NullGeneratorBase>
class smtk::common::GeneratorBase< Input, Output, Base >

Base for all generators.

Describes the two methods used for generator selection and object generation.

Member Function Documentation

operator()()

template<class Input , class Output , class Base = detail::NullGeneratorBase>

virtual Output smtk::common::GeneratorBase< Input, Output, Base >::operator() ( const Input &  )

pure virtual

Function call operator for generating Output-s.

Implementations of this method may throw exceptions, facilitating the use of valid() as a quick check for input validity without necessarily guaranteeing the class's success.

Implemented in smtk::extension::vtk::mesh::PointCloudFromVTKFile, smtk::mesh::PointCloudFromCSV, smtk::common::Generator< std::string, StructuredGrid >, smtk::common::Generator< std::string, PointCloud >, smtk::extension::vtk::io::ImportAsVTKDataType< Self >, smtk::common::Generator< std::pair< std::string, std::string >, vtkSmartPointer< vtkDataObject >, detail::ImportAsVTKDataBase >, smtk::extension::vtk::mesh::PointCloudFromVTKAuxiliaryGeometry, smtk::common::Generator< smtk::model::AuxiliaryGeometry, PointCloud >, smtk::common::Generator< smtk::model::AuxiliaryGeometry, StructuredGrid >, smtk::extension::vtk::mesh::StructuredGridFromVTKAuxiliaryGeometry, and smtk::common::Generator< Input, Output, Base >.

valid()

template<class Input , class Output , class Base = detail::NullGeneratorBase>

virtual bool smtk::common::GeneratorBase< Input, Output, Base >::valid ( const Input &  ) const

pure virtual

A discriminating method to determine whether or not the input should be considered for use as input by a generator type.

If this method returns false, the generator type will not be considered. If this method returns true, the class will be considered for generation but may still fail (see the description of the function call operator).

Implemented in smtk::extension::vtk::mesh::PointCloudFromVTKFile, smtk::mesh::PointCloudFromCSV, smtk::common::Generator< std::string, StructuredGrid >, smtk::common::Generator< std::string, PointCloud >, smtk::extension::vtk::io::ImportAsVTKDataType< Self >, smtk::common::Generator< std::pair< std::string, std::string >, vtkSmartPointer< vtkDataObject >, detail::ImportAsVTKDataBase >, smtk::extension::vtk::mesh::PointCloudFromVTKAuxiliaryGeometry, smtk::common::Generator< smtk::model::AuxiliaryGeometry, PointCloud >, smtk::common::Generator< smtk::model::AuxiliaryGeometry, StructuredGrid >, smtk::extension::vtk::mesh::StructuredGridFromVTKAuxiliaryGeometry, and smtk::common::Generator< Input, Output, Base >.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/common/Generator.h