Interface class for the concept "Prototype". More...

#include <WPrototyped.h>

Inheritance diagram for WPrototyped:

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

virtual	~WPrototyped ()
	Destructor. More...

virtual const std::string	getName () const =0
	Gets the name of this prototype. More...

virtual const std::string	getDescription () const =0
	Gets the description for this prototype. More...

template<typename T >
bool	isA ()
	Checks whether the actual prototype has the specified runtime type. More...

Detailed Description

Interface class for the concept "Prototype".

The requirements are a zero-parameter constructor.

Definition at line 37 of file WPrototyped.h.

Constructor & Destructor Documentation

◆ WPrototyped()

WPrototyped::WPrototyped ( )

Default constructor.

Creates a instance of the class. This not necessarily mean that the instance is fully usable. This is required for type checking and inheritance checking.

Definition at line 29 of file WPrototyped.cpp.

◆ ~WPrototyped()

WPrototyped::~WPrototyped ( )

virtual

Destructor.

Definition at line 34 of file WPrototyped.cpp.

Member Function Documentation

◆ getDescription()

virtual const std::string WPrototyped::getDescription ( ) const

pure virtual

Gets the description for this prototype.

Returns: the description

Implemented in WMWriteTransferFunction, WMWriteTracts, WMWriteRawData, WMWriteCSV, WMWriteMesh, WMWriteField, WMWriteDendrogram, WMWriteAmiraMesh, WMWebglSupport, WMVoxelizer, WMVectorScale, WMVectorPlot, WMVectorOperator, WMVectorNormalize, WMVectorAlign, WMTriangleMeshRenderer, WMTransferFunctionColorBar, WMTransferFunction1D, WMTemplateUI, WMTemplateShaders, WMTemplateRenderPipelines, WMTemplateDataLoader, WMTemplateColormapping, WMTemplate, WMTeemGlyphs, WMSurfaceParameterAnimator, WMSurfaceIllustrator, WMSuperquadricGlyphs, WMSplineSurface, WMSpatialDerivative, WMScalarSegmentation, WMScalarOperator, WMSampleOnFibers, WMResampleRegular, WMReadVIM, WMReadVCL, WMReadSimpleTextLineData, WMReadRawData, WMReadMesh, WMReadLAS, WMReadDipoles, WMReadAmiraMesh, WMProjectionsAsContext, WMProbTractDisplay, WMPointRenderer, WMPointConnector, WMPickingDVREvaluation, WMPickingDVR, WMPaintTexture, WMOpenIGTLinkSender, WMNavigationSlices, WMMeshToPoints, WMMergePoints, WMMergeComponentsToVector, WMIsosurfaceRaytracer, WMIsosurface, WMImageSpaceTensorLIC, WMImageSpaceLIC, WMImageExtractor, WMMultiHistogramView, WMHistogramView, WMHistogramEqualization, WMPartition2Mesh, WMHierchClustDisplay, WMHARDIToSphericalHarmonics, WMGridRenderer, WMGaussFiltering, WMFunctionalMRIViewer, WMFilterProtonData, WMFiberTranslator, WMFiberTransform, WMFibersToPoints, WMFiberSelection, WMFiberResampling, WMFiberParameterColoring, WMFiberFilterROI, WMFiberFilterIndex, WMFiberDisplay, WMEigenSystem, WMEffectiveConnectivityCluster, WMEEGView, WMDistanceMap, WMDirectVolumeRendering, WMDeterministicFTMori, WMDataTypeConversion, WMDatasetProfile, WMDatasetManipulator, WMDataCreatorVector, WMDataCreatorScalar, WMDataCreatorPoints, WMDataCreatorFibers, WMWriteNIfTI, WMReadSphericalHarmonics, WMData, WMCoordinateSystem, WMColormapper, WMClusterDisplayVoxels, WMClusterDisplay, WMCalculateTensors, WMCalculateHistogram, WMCalculateGFA, WMButterfly, WMArbitraryROIs, WMArbitraryPlane, WMApplyMask, WMAnisotropicFiltering, WModuleContainer, WModuleImpl, WTestTransferableDerived, WTestTransferableBase, WTriangleMesh, WGEPostprocessor, WRecording, WEEG2, WEEG, WDataSetTimeSeries, WDataSetSphericalHarmonics, WDataSetSingle, WDataSetSegmentation, WDataSetScalar, WDataSetRawHARDI, WDataSetPoints, WDataSetHistogram1D, WDataSetHierarchicalClustering, WDataSetFiberVector, WDataSetFibers, WDataSetFiberClustering, WDataSetDTI, WDataSet, WJoinContourTree, WFiberCluster, SomePrototypeClass3, SomePrototypeClass2, SomePrototypeClass1, WSinglePosition, WDendrogram, and WColoredVertices.

◆ getName()

virtual const std::string WPrototyped::getName ( ) const

pure virtual

Gets the name of this prototype.

Not allowed line-breaks, ":", "/", "\".

Returns: the name.

Implemented in WMWriteTransferFunction, WMWriteTracts, WMWriteRawData, WMWriteCSV, WMWriteMesh, WMWriteField, WMWriteDendrogram, WMWriteAmiraMesh, WMWebglSupport, WMVoxelizer, WMVectorScale, WMVectorPlot, WMVectorOperator, WMVectorNormalize, WMVectorAlign, WMTriangleMeshRenderer, WMTransferFunctionColorBar, WMTransferFunction1D, WMTemplateUI, WMTemplateShaders, WMTemplateRenderPipelines, WMTemplateDataLoader, WMTemplateColormapping, WMTemplate, WMTeemGlyphs, WMSurfaceParameterAnimator, WMSurfaceIllustrator, WMSuperquadricGlyphs, WMSplineSurface, WMSpatialDerivative, WMScalarSegmentation, WMScalarOperator, WMSampleOnFibers, WMResampleRegular, WMReadVIM, WMReadVCL, WMReadSimpleTextLineData, WMReadRawData, WMReadMesh, WMReadLAS, WMReadDipoles, WMReadAmiraMesh, WMProjectionsAsContext, WMProbTractDisplay, WMPointRenderer, WMPointConnector, WMPickingDVREvaluation, WMPickingDVR, WMPaintTexture, WMOpenIGTLinkSender, WMNavigationSlices, WMMeshToPoints, WMMergePoints, WMMergeComponentsToVector, WMIsosurfaceRaytracer, WMIsosurface, WMImageSpaceTensorLIC, WMImageSpaceLIC, WMImageExtractor, WMMultiHistogramView, WMHistogramView, WMHistogramEqualization, WMPartition2Mesh, WMHierchClustDisplay, WMHARDIToSphericalHarmonics, WMGridRenderer, WMGaussFiltering, WMFunctionalMRIViewer, WMFilterProtonData, WMFiberTranslator, WMFiberTransform, WMFibersToPoints, WMFiberSelection, WMFiberResampling, WMFiberParameterColoring, WMFiberFilterROI, WMFiberFilterIndex, WMFiberDisplay, WMEigenSystem, WMEffectiveConnectivityCluster, WMEEGView, WMDistanceMap, WMDirectVolumeRendering, WMDeterministicFTMori, WMDataTypeConversion, WMDatasetProfile, WMDatasetManipulator, WMDataCreatorVector, WMDataCreatorScalar, WMDataCreatorPoints, WMDataCreatorFibers, WMWriteNIfTI, WMReadSphericalHarmonics, WMData, WMCoordinateSystem, WMColormapper, WMClusterDisplayVoxels, WMClusterDisplay, WMCalculateTensors, WMCalculateHistogram, WMCalculateGFA, WMButterfly, WMArbitraryROIs, WMArbitraryPlane, WMApplyMask, WMAnisotropicFiltering, WModuleContainer, WModuleImpl, WTestTransferableDerived, WTestTransferableBase, WTriangleMesh, WGEPostprocessor, WRecording, WEEG2, WEEG, WDataSetTimeSeries, WDataSetSphericalHarmonics, WDataSetSingle, WDataSetSegmentation, WDataSetScalar, WDataSetRawHARDI, WDataSetPoints, WDataSetHistogram1D, WDataSetHierarchicalClustering, WDataSetFiberVector, WDataSetFibers, WDataSetFiberClustering, WDataSetDTI, WDataSet, WJoinContourTree, WFiberCluster, SomePrototypeClass3, SomePrototypeClass2, SomePrototypeClass1, WSinglePosition, WDendrogram, and WColoredVertices.

Referenced by WModule::debugLog(), WModule::errorLog(), WModule::getConnector(), WModule::getInputConnector(), WModule::getOutputConnector(), WModule::infoLog(), WModule::initialize(), WModule::onThreadException(), WModule::threadMain(), and WModule::warnLog().

Here is the caller graph for this function:

◆ isA()

template<typename T >

bool WPrototyped::isA

Checks whether the actual prototype has the specified runtime type.

Returns: true if you can safely cast this instance to the specified type.

Definition at line 77 of file WPrototyped.h.

Referenced by WPrototypedTest::testType().