eSDK Pro Plugin Task Parameter Classes

This topic describes the task parameter class and the derived task parameter type classes in the eSDK Pro Plugin API:

• TaskParam class — Base class for all task parameters.
• BoolTaskParam class — Boolean on/off task parameter.
• EnumTaskParam class — Parameter that selects from a fixed set of named options.
• ‍FloatTaskParam class — Floating-point numeric task parameter.
• Int32TaskParam class — Signed 32-bit integer task parameter.
• ‍StringTaskParam class — Text-based task parameter.

‍

Plugin TaskParam Class

Namespace:eSdkPro::Plugin

Header:eSdkPro/plugin/taskparam.h

Base class for all plugin task parameters. Derived classes are provided for each type of parameter. Task parameters can be used to control the behavior of a plugin task at runtime.

Task parameters are created by a task worker in the task worker constructor. The current value of the parameter can be accessed by the task worker at runtime. The value of the parameter can be set by the eSDK Pro application at runtime.

‍

GetName()

std::string eSdkPro::Plugin::TaskParam::GetName ( ) const

Returns: The name of the parameter.

‍

GetType()

TaskParamType eSdkPro::Plugin::TaskParam::GetType ( ) const

Returns: The type of the parameter.

‍

SetToolTip()

void eSdkPro::Plugin::TaskParam::SetToolTip ( const std::string & tooltip ) 	

Sets the tooltip of the parameter.‍

Parameter: The text to be set as tip for the parameter.

‍

Plugin BoolTaskParam Class

Namespace: eSdkPro::Plugin

Header: eSdkPro/plugin/taskparam.h

Task parameter that holds a boolean value.

‍

SetValue()

void eSdkPro::Plugin::BoolTaskParam::SetValue ( bool val ) 	

Sets the value of the parameter.

Parameter: val The value to be set.

‍

GetValue()

bool eSdkPro::Plugin::BoolTaskParam::GetValue ( ) const

Returns: The current value of the parameter.

‍

Plugin EnumTaskParam Class

Namespace: eSdkPro::Plugin

Header: eSdkPro/plugin/taskparam.h

Task parameter that allows selection from a predefined list of options.

‍

GetOptions()

std::vector< std::string > eSdkPro::Plugin::EnumTaskParam::GetOptions ( ) const

Returns: The list of selectable options.

‍

SetIdx()

void eSdkPro::Plugin::EnumTaskParam::SetIdx ( int idx )

Sets the index from the list of options.

Parameter: idx The index to be set.

‍

GetIdx()

int32_t eSdkPro::Plugin::EnumTaskParam::GetIdx ( ) const

Gets the currently selected index.

Returns: The current selected index.

‍

Plugin FloatTaskParam Class

Namespace: eSdkPro::Plugin

Header: eSdkPro/plugin/taskparam.h

Task parameter that holds a floating-point value.

‍
SetValue()

void eSdkPro::Plugin::FloatTaskParam::SetValue ( float val )

Sets the value of the parameter.

Parameter: val The value to be set.

‍

GetValue()

float eSdkPro::Plugin::FloatTaskParam::GetValue ( ) const

Returns: The current value of the parameter.

‍

Plugin Int32TaskParam Class

Namespace: eSdkPro::Plugin

Header: eSdkPro/plugin/taskparam.h

Task parameter that holds a 32-bit integer value.

‍
SetValue()

void eSdkPro::Plugin::Int32TaskParam::SetValue ( int32_t val )

Sets the value of the parameter.

Parameter: val The value to be set.

‍

GetValue()

int32_t eSdkPro::Plugin::Int32TaskParam::GetValue ( ) const

Returns: The current value of the parameter.

‍

Plugin StringTaskParam Class

Namespace: eSdkPro::Plugin

Header: eSdkPro/plugin/taskparam.h

Task parameter that holds a string value.

‍
SetValue()

void eSdkPro::Plugin::StringTaskParam::SetValue ( const std::string & val )

Sets the value of the parameter.

Parameter: val The value to be set.

‍

GetValue()

std::string eSdkPro::Plugin::StringTaskParam::GetValue ( ) const

Returns: The current value of the parameter.

‍

See Also

• Plugin TaskWorker Class
• Task Classes
• Plugin API Overview

‍