PCL
pcl::MetaTable Class Referenceabstract

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

#include <MetaParameter.h>

+ Inheritance diagram for pcl::MetaTable:

Public Member Functions

 MetaTable (MetaProcess *P)
 
 ~MetaTable () noexcept(false) override
 
virtual IsoString Id () const override=0
 
bool IsTable () const override
 
const MetaParameteroperator[] (size_type i) const
 
- Public Member Functions inherited from pcl::MetaVariableLengthParameter
 MetaVariableLengthParameter (MetaProcess *P)
 
 MetaVariableLengthParameter (MetaTable *T)
 
 ~MetaVariableLengthParameter () noexcept(false) override
 
bool IsVariableLength () const override
 
virtual size_type MaxLength () const
 
virtual size_type MinLength () 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 IsNumeric () const
 
virtual bool IsReadOnly () const
 
virtual bool IsRequired () const
 
virtual bool IsString () 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
 
MetaObjectoperator= (const MetaObject &)=delete
 
MetaObjectoperator= (MetaObject &&x)=delete
 
const MetaObjectoperator[] (size_type i) const
 
MetaObjectParent ()
 
const MetaObjectParent () const
 

Additional Inherited Members

- Public Types inherited from pcl::MetaObject
using children_list = IndirectArray< MetaObject >
 

Detailed Description

A table process parameter is a container that groups a set of process parameters defining the columns of a two-dimensional matrix of parameter values.

Note
Important: Table process parameters cannot be nested, that is, a table process parameter cannot be specified as a column of an existing table process parameter.

Definition at line 1825 of file MetaParameter.h.

Constructor & Destructor Documentation

◆ MetaTable()

pcl::MetaTable::MetaTable ( MetaProcess P)
inline

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

Definition at line 1833 of file MetaParameter.h.

◆ ~MetaTable()

pcl::MetaTable::~MetaTable ( )
inlineoverridenoexcept

Destroys a MetaTable object.

Definition at line 1841 of file MetaParameter.h.

Member Function Documentation

◆ Id()

virtual IsoString pcl::MetaTable::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::MetaVariableLengthParameter.

◆ IsTable()

bool pcl::MetaTable::IsTable ( ) const
inlineoverridevirtual

Returns true iff this metaparameter represents a table process parameter. Table process parameters are represented as subclasses of MetaTable.

Reimplemented from pcl::MetaParameter.

Definition at line 1847 of file MetaParameter.h.

◆ operator[]()

const MetaParameter* pcl::MetaTable::operator[] ( size_type  i) const

Returns the address of a metaparameter representing the process parameter at column index i.

You should not need to call this function directly under normal conditions.


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