eSDK Pro Task Parameter Classes

This topic describes the task parameter class and the derived task parameter type classes in the eSDK Pro 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.

‍

TaskParam Class

Namespace: eSdkPro  Header: eSdkPro/taskparam.h

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

‍

GetName()

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

Returns: The name of the parameter.

‍

GetType()

TaskParamType eSdkPro::TaskParam::GetType ( ) const

Returns: The type of the parameter.

‍

GetToolTip()

std::string eSdkPro::TaskParam::GetTooltip ( ) const

Returns: The tooltip of the parameter.

‍

BoolTaskParam Class

Namespace: eSdkPro  Header: eSdkPro/taskparam.h

Task parameter that holds a boolean value.

‍

SetValue()

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

Sets the value of the parameter.

Parameter: val The value to be set.

‍

GetValue()

bool eSdkPro::BoolTaskParam::GetValue ( ) const

Returns: The current value of the parameter.

‍

EnumTaskParam Class

Namespace: eSdkPro  Header: eSdkPro/taskparam.h

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

‍

GetOptions()

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

Returns: The list of selectable options.

‍

SetIdx()

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

Sets the index from the list of options.

Parameter: idx The index to be set.

‍

GetIdx()

int32_t eSdkPro::EnumTaskParam::GetIdx ( ) const

Gets the currently selected index.

Returns: The current selected index.

‍

FloatTaskParam Class

Namespace: eSdkPro  Header: eSdkPro/taskparam.h

Task parameter that holds a floating-point value.

‍
SetValue()

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

Sets the value of the parameter.

Parameter: val The value to be set.

‍

GetValue()

float eSdkPro::FloatTaskParam::GetValue ( ) const

Returns: The current value of the parameter.

‍

Int32TaskParam Class

Namespace: eSdkPro  Header: eSdkPro/taskparam.h

Task parameter that holds a 32-bit integer value.

‍
SetValue()

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

Sets the value of the parameter.

Parameter: val The value to be set.

‍

GetValue()

int32_t eSdkPro::Int32TaskParam::GetValue ( ) const

Returns: The current value of the parameter.

‍

StringTaskParam Class

Namespace: eSdkPro  Header: eSdkPro/taskparam.h

Task parameter that holds a string value.

‍
SetValue()

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

Sets the value of the parameter.

Parameter: val The value to be set.

‍

GetValue()

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

Returns: The current value of the parameter.

‍

See Also

• Task Classes
• Pipeline Class
• System Class

‍