method Class Reference

Abstract base for run-time selectable surface feature extraction methods. More...

#include <surfaceFeaturesExtraction.H>

Inheritance diagram for method:

Collaboration diagram for method:

Public Member Functions
	ClassNameNoDebug ("method")
	Runtime type information.
	method (const dictionary &dict)
	Construct from dictionary.
	declareRunTimeSelectionTable (autoPtr, method, dictionary,(const dictionary &dict),(dict))
virtual	~method ()=default
	Destructor.
scalar	includedAngle () const noexcept
	The included angle, if set.
Switch	geometricTestOnly () const noexcept
	Use geometric test only.
virtual autoPtr< surfaceFeatures >	features (const triSurface &surf) const =0
	Extracted features.

Static Public Member Functions
static autoPtr< method >	New (const dictionary &dict)
	Select constructed from dictionary.

Protected Member Functions
	method ()
	Default construct.

Protected Attributes
scalar	includedAngle_
Switch	geometricTestOnly_

Detailed Description

Abstract base for run-time selectable surface feature extraction methods.

Source files

• surfaceFeaturesExtraction.H
• surfaceFeaturesExtraction.C

Definition at line 58 of file surfaceFeaturesExtraction.H.

Constructor & Destructor Documentation

method() [1/2]

method ( )

protected

Default construct.

Referenced by declareRunTimeSelectionTable().

Here is the caller graph for this function:

method() [2/2]

method ( const dictionary & dict )

explicit

Construct from dictionary.

References dict.

~method()

virtual ~method ( )

virtualdefault

Destructor.

Member Function Documentation

ClassNameNoDebug()

ClassNameNoDebug

(

"method"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		method	,
		dictionary	,
		(const dictionary &dict)	,
		(dict)	)

References dict, and method().

Here is the call graph for this function:

New()

autoPtr< method > New ( const dictionary & dict )

static

Select constructed from dictionary.

References dict.

includedAngle()

scalar includedAngle ( ) const

inlinenoexcept

The included angle, if set.

Definition at line 119 of file surfaceFeaturesExtraction.H.

References includedAngle_, and Foam::noexcept.

geometricTestOnly()

Switch geometricTestOnly ( ) const

inlinenoexcept

Use geometric test only.

Definition at line 124 of file surfaceFeaturesExtraction.H.

References geometricTestOnly_, and Foam::noexcept.

features()

virtual autoPtr< surfaceFeatures > features ( const triSurface & surf ) const

pure virtual

Extracted features.

Implemented in extractFromFile, extractFromNone, and extractFromSurface.

Member Data Documentation

includedAngle_

scalar includedAngle_

protected

Definition at line 62 of file surfaceFeaturesExtraction.H.

Referenced by includedAngle().

geometricTestOnly_

Switch geometricTestOnly_

protected

Definition at line 63 of file surfaceFeaturesExtraction.H.

Referenced by geometricTestOnly().

---

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

• applications/utilities/surface/surfaceFeatureExtract/extractionMethod/surfaceFeaturesExtraction.H