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

A formal description of a variable length process parameter. More...

#include <MetaParameter.h>

+ Inheritance diagram for pcl::MetaVariableLengthParameter:

Public Member Functions

 MetaVariableLengthParameter (MetaProcess *P)
 
 MetaVariableLengthParameter (MetaTable *T)
 
 ~MetaVariableLengthParameter () noexcept(false) override
 
virtual IsoString Id () const override=0
 
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 IsTable () 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

Variable length process parameters can be strings (MetaString), tables (MetaTable) or blocks (MetaBlock).

Definition at line 1649 of file MetaParameter.h.

Constructor & Destructor Documentation

◆ MetaVariableLengthParameter() [1/2]

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

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

Definition at line 1657 of file MetaParameter.h.

◆ MetaVariableLengthParameter() [2/2]

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

Constructs a metaparameter representing a variable-length data item 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 1668 of file MetaParameter.h.

◆ ~MetaVariableLengthParameter()

pcl::MetaVariableLengthParameter::~MetaVariableLengthParameter ( )
inlineoverridenoexcept

Destroys a MetaVariableLengthParameter object.

Definition at line 1676 of file MetaParameter.h.

Member Function Documentation

◆ Id()

virtual IsoString pcl::MetaVariableLengthParameter::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::MetaBlock, pcl::MetaTable, and pcl::MetaString.

◆ IsVariableLength()

bool pcl::MetaVariableLengthParameter::IsVariableLength ( ) const
inlineoverridevirtual

Returns true iff this metaparameter represents a variable-length process parameter. Variable-length process parameters are represented as subclasses of MetaVariableLengthParameter.

Reimplemented from pcl::MetaParameter.

Definition at line 1682 of file MetaParameter.h.

◆ MaxLength()

virtual size_type pcl::MetaVariableLengthParameter::MaxLength ( ) const
inlinevirtual

Returns the maximum valid length for the variable length process parameter represented by this metaparameter.

If the returned value is zero, then the represented variable length process parameter can have unlimited length.

Note
The default implementation of this function returns zero, so variable length process parameters have unlimited length by default.

Definition at line 1713 of file MetaParameter.h.

◆ MinLength()

virtual size_type pcl::MetaVariableLengthParameter::MinLength ( ) const
inlinevirtual

Returns the minimum valid length for the variable length process parameter represented by this metaparameter.

Note
The default implementation of this function returns zero, so variable length process parameters can be empty by default.

Definition at line 1698 of file MetaParameter.h.

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