pcl::MetaNumeric Class Reference

A formal description of a numeric process parameter. More...

#include <MetaParameter.h>

Inheritance diagram for pcl::MetaNumeric:

Public Member Functions
	MetaNumeric (MetaProcess *P)
	MetaNumeric (MetaTable *T)
	~MetaNumeric () noexcept(false) override
virtual double	DefaultValue () const
virtual IsoString	Id () const override=0
virtual bool	IsInteger () const
bool	IsNumeric () const override
virtual bool	IsReal () const
virtual double	MaximumValue () const
virtual double	MinimumValue () const
Public Member Functions inherited from pcl::MetaParameter
	MetaParameter (MetaProcess *P)
	MetaParameter (MetaTable *T)
	~MetaParameter () noexcept(false) override
virtual IsoString	Aliases () const
virtual String	Comment () const
virtual String	Description () const
virtual bool	IsBlock () const
virtual bool	IsBoolean () const
virtual bool	IsEnumeration () const
virtual bool	IsReadOnly () const
virtual bool	IsRequired () const
virtual bool	IsString () const
virtual bool	IsTable () const
virtual bool	IsVariableLength () const
virtual bool	NeedsUnlocking () const
virtual bool	NeedsValidation () const
Public Member Functions inherited from pcl::MetaObject
	MetaObject (const MetaObject &)=delete
	MetaObject (MetaObject &&x)=delete
	MetaObject (MetaObject *parent)
virtual	~MetaObject () noexcept(false)
size_type	Length () const
MetaObject &	operator= (const MetaObject &)=delete
MetaObject &	operator= (MetaObject &&x)=delete
const MetaObject *	operator[] (size_type i) const
MetaObject *	Parent ()
const MetaObject *	Parent () const

Additional Inherited Members
Public Types inherited from pcl::MetaObject
using	children_list = IndirectArray< MetaObject >

Detailed Description

Numeric process parameters can be integers (MetaInteger) and floating-point reals (MetaReal).

Integer process parameters can be signed (MetaSignedInteger) and unsigned (MetaUnsignedInteger) 8, 16, 32 and 64-bit integers. Real process parameters can be 32 and 64-bit IEEE 754 floating point values. This leads to the following numeric metaparameter classes:

• Unsigned integer process parameters: MetaUInt8, MetaUInt16, MetaUInt32, and MetaUInt64.

• Signed integer process parameters: MetaInt8, MetaInt16, MetaInt32, and MetaInt64.

• Real process parameters: MetaFloat and MetaDouble.

Definition at line 413 of file MetaParameter.h.

Constructor & Destructor Documentation

MetaNumeric() [1/2]

pcl::MetaNumeric::MetaNumeric ( MetaProcess *  P )

inline

Constructs a metaparameter representing a numeric parameter of the specified process class *P.

Definition at line 421 of file MetaParameter.h.

MetaNumeric() [2/2]

pcl::MetaNumeric::MetaNumeric ( MetaTable *  T )

inline

Constructs a metaparameter representing a numeric value in a column of a table process parameter represented by the metatable *T. The new metaparameter is appended to the list of existing columns in the metatable *T.

Definition at line 432 of file MetaParameter.h.

~MetaNumeric()

pcl::MetaNumeric::~MetaNumeric ( )

inlineoverridenoexcept

Destroys a MetaNumeric object.

Definition at line 440 of file MetaParameter.h.

Member Function Documentation

DefaultValue()

virtual double pcl::MetaNumeric::DefaultValue ( ) const

inlinevirtual

Returns the default value of the numeric process parameter represented by this metaparameter.

Note

The default implementation of this function returns zero.

Definition at line 481 of file MetaParameter.h.

Id()

virtual IsoString pcl::MetaNumeric::Id ( ) const

overridepure virtual

Returns the identifier of the process parameter that this metaparameter represents.

Each process parameter must have a valid, unique (within its parent process) C identifier.

See also

Aliases()

Implements pcl::MetaParameter.

Implemented in pcl::MetaDouble, pcl::MetaFloat, pcl::MetaReal, pcl::MetaInt64, pcl::MetaInt32, pcl::MetaInt16, pcl::MetaInt8, pcl::MetaUInt64, pcl::MetaUInt32, pcl::MetaUInt16, pcl::MetaUInt8, pcl::MetaSignedInteger, pcl::MetaUnsignedInteger, and pcl::MetaInteger.

IsInteger()

virtual bool pcl::MetaNumeric::IsInteger ( ) const

inlinevirtual

Returns true iff this metaparameter represents an integer process parameter. Integer process parameters are represented as subclasses of MetaReal.

Reimplemented in pcl::MetaInteger.

Definition at line 470 of file MetaParameter.h.

IsNumeric()

bool pcl::MetaNumeric::IsNumeric ( ) const

inlineoverridevirtual

Returns true iff this metaparameter represents a numeric process parameter. Numeric process parameters are represented as subclasses of MetaNumeric.

Reimplemented from pcl::MetaParameter.

Definition at line 446 of file MetaParameter.h.

IsReal()

virtual bool pcl::MetaNumeric::IsReal ( ) const

inlinevirtual

Returns true iff this metaparameter represents a real (floating-point) process parameter. Real process parameters are represented as subclasses of MetaReal.

Reimplemented in pcl::MetaReal.

Definition at line 460 of file MetaParameter.h.

MaximumValue()

virtual double pcl::MetaNumeric::MaximumValue ( ) const

inlinevirtual

Returns the maximum valid value for the numeric process parameter represented by this metaparameter.

Note

The default implementation of this function returns DBL_MAX, which is the maximum possible value of a double number.

Definition at line 505 of file MetaParameter.h.

MinimumValue()

virtual double pcl::MetaNumeric::MinimumValue ( ) const

inlinevirtual

Returns the minimum valid value for the numeric process parameter represented by this metaparameter.

Note

The default implementation of this function returns -DBL_MAX, which is the minimum possible value of a double number.

Definition at line 493 of file MetaParameter.h.

---

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

• MetaParameter.h