PCL
Public Member Functions | List of all members
pcl::MetaInteger Class Referenceabstract

A formal description of an integer process parameter. More...

#include <MetaParameter.h>

+ Inheritance diagram for pcl::MetaInteger:

Public Member Functions

 MetaInteger (MetaProcess *P)
 
 MetaInteger (MetaTable *T)
 
 ~MetaInteger () noexcept(false) override
 
virtual IsoString Id () const override=0
 
bool IsInteger () const override
 
virtual bool IsSigned () const =0
 
- Public Member Functions inherited from pcl::MetaNumeric
 MetaNumeric (MetaProcess *P)
 
 MetaNumeric (MetaTable *T)
 
 ~MetaNumeric () noexcept(false) override
 
virtual double DefaultValue () 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

Integer process parameters can be signed (MetaSignedInteger) and unsigned (MetaUnsignedInteger) 8, 16, 32 and 64-bit integers. This leads to the following integer process parameter classes:

Definition at line 532 of file MetaParameter.h.

Constructor & Destructor Documentation

◆ MetaInteger() [1/2]

pcl::MetaInteger::MetaInteger ( MetaProcess *  P)
inline

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

Definition at line 540 of file MetaParameter.h.

◆ MetaInteger() [2/2]

pcl::MetaInteger::MetaInteger ( MetaTable *  T)
inline

Constructs a metaparameter representing an integer 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 551 of file MetaParameter.h.

◆ ~MetaInteger()

pcl::MetaInteger::~MetaInteger ( )
inlineoverridenoexcept

Destroys a MetaInteger object.

Definition at line 559 of file MetaParameter.h.

Member Function Documentation

◆ Id()

virtual IsoString pcl::MetaInteger::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::MetaNumeric.

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

◆ IsInteger()

bool pcl::MetaInteger::IsInteger ( ) const
inlineoverridevirtual

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

Reimplemented from pcl::MetaNumeric.

Definition at line 565 of file MetaParameter.h.

◆ IsSigned()

virtual bool pcl::MetaInteger::IsSigned ( ) const
pure virtual

Returns true if this metaparameter represents a signed integer process parameter; false if it represents an unsigned integer process parameter.

Implemented in pcl::MetaSignedInteger, and pcl::MetaUnsignedInteger.

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