Creates constant values inside a given grid. More...

#include <WDataCreatorConstant.h>

Inheritance diagram for WDataCreatorConstant:

Collaboration diagram for WDataCreatorConstant:

Public Member Functions
	WDataCreatorConstant ()
	Default constructor. More...

virtual	~WDataCreatorConstant ()
	Destructor. More...

virtual WValueSetBase::SPtr	operator() (WProgress::SPtr progress, WGridRegular3D::ConstSPtr grid, unsigned char order=0, unsigned char dimension=1, dataType type=W_DT_FLOAT)
	Create the dataset. More...

Public Member Functions inherited from WObjectNDIP< WDataSetSingleCreatorInterface >
virtual	~WObjectNDIP ()
	Destructor. More...

virtual std::string	getName () const
	The name of the object. More...

virtual std::string	getDescription () const
	The description of this object. More...

virtual const char **	getIcon () const
	The icon of this object. More...

virtual WProperties::SPtr	getProperties ()
	Return the property group of this object. More...

Public Member Functions inherited from WDataSetSingleCreatorInterface
virtual	~WDataSetSingleCreatorInterface ()
	Destructor. More...

Private Attributes
WPropDouble	m_value
	The value in the dataset. More...

Additional Inherited Members
Public Types inherited from WObjectNDIP< WDataSetSingleCreatorInterface >
typedef std::shared_ptr< WObjectNDIP >	SPtr
	Shared ptr to an instance. More...

typedef std::shared_ptr< const WObjectNDIP >	ConstSPtr
	Shared ptr to a const instance. More...

Protected Member Functions inherited from WObjectNDIP< WDataSetSingleCreatorInterface >
	WObjectNDIP (std::string name, std::string description, const char **icon=NULL)
	Construct a NDIP'ed object. More...

Protected Attributes inherited from WObjectNDIP< WDataSetSingleCreatorInterface >
WProperties::SPtr	m_properties
	the properties of the object. More...

Detailed Description

Creates constant values inside a given grid.

This works for all kinds of datasets using WValueSetBase.

Definition at line 36 of file WDataCreatorConstant.h.

Constructor & Destructor Documentation

◆ WDataCreatorConstant()

WDataCreatorConstant::WDataCreatorConstant ( )

Default constructor.

Definition at line 35 of file WDataCreatorConstant.cpp.

References WObjectNDIP< WDataSetSingleCreatorInterface >::m_properties, and m_value.

◆ ~WDataCreatorConstant()

WDataCreatorConstant::~WDataCreatorConstant ( )

virtual

Destructor.

Definition at line 41 of file WDataCreatorConstant.cpp.

Member Function Documentation

◆ operator()()

WValueSetBase::SPtr WDataCreatorConstant::operator()	(	WProgress::SPtr	progress,
		WGridRegular3D::ConstSPtr	grid,
		unsigned char	order = `0`,
		unsigned char	dimension = `1`,
		dataType	type = `W_DT_FLOAT`
	)

virtual

Create the dataset.

This needs to be implemented by all the creators you write. This method is designed to be applicable to all kinds of WDataSetSingle that use WValueSetBase. Your implementation does not need to support all types. If you do not support any order/dimension combination, throw an exception (like by using WAssert).

Parameters

order	the tensor order of the values stored in this WValueSet
dimension	the tensor dimension of the values stored in this WValueSet
progress	the progress instance you should increment each time you fill the value for one voxel.
grid	the grid on which the value set has to be build
type	the value type in the value set

Returns: the value set for the given grid

Implements WDataSetSingleCreatorInterface.

Definition at line 45 of file WDataCreatorConstant.cpp.

References m_value.

Member Data Documentation

◆ m_value

WPropDouble WDataCreatorConstant::m_value

private

The value in the dataset.

Definition at line 71 of file WDataCreatorConstant.h.

Referenced by operator()(), and WDataCreatorConstant().

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

Public Member Functions

Private Attributes

Additional Inherited Members