0.4.3
ALSON::BaseParameterNode类 参考

#include <BaseParameterNode.h>

Public 成员函数

 BaseParameterNode (ClientContextPtr clientContextPtr, std::string key)
 
virtual ~BaseParameterNode ()=default
 
 BaseParameterNode (const BaseParameterNode &)=default
 
BaseParameterNodeoperator= (const BaseParameterNode &)=default
 
 BaseParameterNode (BaseParameterNode &&) noexcept=default
 
BaseParameterNodeoperator= (BaseParameterNode &&) noexcept=default
 
std::string getKey ()
 
std::string getName ()
 
std::string getDescription ()
 
ParameterVisibility getVisibility ()
 
ParameterType getType ()
 
void resetValue ()
 

Protected 属性

ClientContextPtr m_clientContextPtr
 
std::string m_key
 

详细描述

参数节点的基类

自从
0.3.0

在文件 BaseParameterNode.h31 行定义.

构造及析构函数说明

◆ BaseParameterNode() [1/3]

ALSON::BaseParameterNode::BaseParameterNode ( ClientContextPtr clientContextPtr,
std::string key )

◆ ~BaseParameterNode()

virtual ALSON::BaseParameterNode::~BaseParameterNode ( )
virtualdefault

◆ BaseParameterNode() [2/3]

ALSON::BaseParameterNode::BaseParameterNode ( const BaseParameterNode & )
default

◆ BaseParameterNode() [3/3]

ALSON::BaseParameterNode::BaseParameterNode ( BaseParameterNode && )
defaultnoexcept

成员函数说明

◆ operator=() [1/2]

BaseParameterNode & ALSON::BaseParameterNode::operator= ( const BaseParameterNode & )
default

◆ operator=() [2/2]

BaseParameterNode & ALSON::BaseParameterNode::operator= ( BaseParameterNode && )
defaultnoexcept

◆ getKey()

std::string ALSON::BaseParameterNode::getKey ( )

获取参数的 key

返回
参数的 key
自从
0.3.0

◆ getName()

std::string ALSON::BaseParameterNode::getName ( )

获取参数的名称

参数的名称会跟随多语言的配置发生变化

返回
参数的名称
自从
0.3.0

◆ getDescription()

std::string ALSON::BaseParameterNode::getDescription ( )

获取参数的描述

参数的描述会跟随多语言的配置发生变化

返回
参数的描述
自从
0.3.0

◆ getVisibility()

ParameterVisibility ALSON::BaseParameterNode::getVisibility ( )

获取参数的可见性

返回
参数的可见性
自从
0.3.0

◆ getType()

ParameterType ALSON::BaseParameterNode::getType ( )

获取参数的类型

返回
参数的类型
自从
0.3.0

◆ resetValue()

void ALSON::BaseParameterNode::resetValue ( )

重置参数的值

当前参数及其下级参数的值都会被重置,重置后,参数的值为默认值

异常
ClientException
自从
0.3.0

类成员变量说明

◆ m_clientContextPtr

ClientContextPtr ALSON::BaseParameterNode::m_clientContextPtr
protected

在文件 BaseParameterNode.h151 行定义.

◆ m_key

std::string ALSON::BaseParameterNode::m_key
protected

在文件 BaseParameterNode.h152 行定义.

My Custom Doxygen Footer
Data Processing Programmer's Guide 0.4.3
Copyright © 2014-2024 Henan Alson Intelligent Technology Co, Ltd 河南埃尔森智能科技有限公司 版权所有 豫ICP备15002212号