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

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

#include <MetaParameter.h>

+ Inheritance diagram for pcl::MetaString:

Public Member Functions

 MetaString (MetaProcess *P)
 
 MetaString (MetaTable *T)
 
 ~MetaString () noexcept(false) override
 
virtual String AllowedCharacters () const
 
virtual String DefaultValue () const
 
virtual IsoString Id () const override=0
 
bool IsString () const override
 
- 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 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

String process parameters are sequences of zero-terminated 16-bit Unicode characters (UTF-16).

Definition at line 1733 of file MetaParameter.h.

Constructor & Destructor Documentation

◆ MetaString() [1/2]

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

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

Definition at line 1741 of file MetaParameter.h.

◆ MetaString() [2/2]

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

Constructs a metaparameter representing a string 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 1752 of file MetaParameter.h.

◆ ~MetaString()

pcl::MetaString::~MetaString ( )
inlineoverridenoexcept

Destroys a MetaString object.

Definition at line 1760 of file MetaParameter.h.

Member Function Documentation

◆ AllowedCharacters()

virtual String pcl::MetaString::AllowedCharacters ( ) const
inlinevirtual

Returns a string with the set of valid characters for the string process parameter represented by this metaparameter.

If this function returns zero, any character is valid for the represented string process parameter.

Note
The default implementation of this function returns zero, so string process parameters can contain any character by default.

Definition at line 1800 of file MetaParameter.h.

◆ DefaultValue()

virtual String pcl::MetaString::DefaultValue ( ) const
inlinevirtual

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

If this function returns zero, the default value for the string process parameter will be an empty string.

Note
The default implementation of this function returns zero, so string process parameters have empty string default values.

Definition at line 1785 of file MetaParameter.h.

◆ Id()

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

◆ IsString()

bool pcl::MetaString::IsString ( ) const
inlineoverridevirtual

Returns true iff this metaparameter represents a string process parameter. String process parameters are represented as subclasses of MetaString.

Reimplemented from pcl::MetaParameter.

Definition at line 1766 of file MetaParameter.h.

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