PCL
pcl::MetaBoolean Class Referenceabstract

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

#include <MetaParameter.h>

+ Inheritance diagram for pcl::MetaBoolean:

Public Member Functions

 MetaBoolean (MetaProcess *P)
 
 MetaBoolean (MetaTable *T)
 
virtual ~MetaBoolean () noexcept(false)
 
virtual bool DefaultValue () const
 
virtual IsoString Id () const override=0
 
bool IsBoolean () const override
 
- Public Member Functions inherited from pcl::MetaParameter
 MetaParameter (MetaProcess *P)
 
 MetaParameter (MetaTable *T)
 
virtual ~MetaParameter () noexcept(false)
 
virtual IsoString Aliases () const
 
virtual String Comment () const
 
virtual String Description () const
 
virtual bool IsBlock () 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 IsVariableLength () const
 
virtual bool NeedsUnlocking () const
 
virtual bool NeedsValidation () const
 
- Public Member Functions inherited from pcl::MetaObject
 MetaObject (MetaObject *parent)
 
 MetaObject (const MetaObject &)=delete
 
 MetaObject (MetaObject &&x)=delete
 
virtual ~MetaObject () noexcept(false)
 
size_type Length () const
 
MetaObjectoperator= (const MetaObject &)=delete
 
MetaObjectoperator= (MetaObject &&x)=delete
 
const MetaObjectoperator[] (size_type i) const
 
const MetaObjectParent () const
 
MetaObjectParent ()
 

Additional Inherited Members

- Public Types inherited from pcl::MetaObject
typedef IndirectArray< MetaObjectchildren_list
 

Detailed Description

MetaBoolean represents a Boolean process parameter. A Boolean process parameter can only have one of the two logical values true and false.

Note
Important - Boolean process parameters must be implemented as 32-bit signed integers (int32). When the PixInsight core application reads or writes a Boolean process parameter, what it reads or writes is actually a 32-bit integer that will represent the Boolean true value as a nonzero integer value, and false as a zero integer value. The best way to implement Boolean process parameters is by using the pcl_bool class.
See also
pcl_bool

Definition at line 1328 of file MetaParameter.h.

Constructor & Destructor Documentation

◆ MetaBoolean() [1/2]

pcl::MetaBoolean::MetaBoolean ( MetaProcess P)
inline

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

Definition at line 1336 of file MetaParameter.h.

◆ MetaBoolean() [2/2]

pcl::MetaBoolean::MetaBoolean ( MetaTable T)
inline

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

◆ ~MetaBoolean()

virtual pcl::MetaBoolean::~MetaBoolean ( )
inlinevirtualnoexcept

Destroys a MetaBoolean object.

Definition at line 1355 of file MetaParameter.h.

Member Function Documentation

◆ DefaultValue()

virtual bool pcl::MetaBoolean::DefaultValue ( ) const
inlinevirtual

Returns the default value for actual Boolean parameters represented by this metaparameter.

Note
The default implementation of this function returns false.

Definition at line 1372 of file MetaParameter.h.

References pcl::ImageOp::Id().

◆ Id()

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

◆ IsBoolean()

bool pcl::MetaBoolean::IsBoolean ( ) const
inlineoverridevirtual

Returns true iff this metaparameter represents a Boolean process parameter. Boolean process parameters are represented as subclasses of MetaBoolean.

Reimplemented from pcl::MetaParameter.

Definition at line 1361 of file MetaParameter.h.


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