ASERStudio::AStorySyntax::AStoryXValueMeta Class

{
        "__ControllerName__":{
                "__ParameterName__":{
                        "type": "__ParameterType__",
                        "defaultValue": "__ParameterDefaultValue__"
                }
        }
}

"__ParameterName__":{
        "type": "Float",
        "defaultValue": "__ParameterDefaultValue__"
        "range": [0.0, 1.0]
}

"__ParameterName__":{
        "type": "Vector",
        "defaultValue": "0.0,0.0,0.0",
        "dimensions":  [3],
        "limit": [
                {
                        "min": 0.0
                },
                { },
                {
                        "range": [-1.0, 1.0]
                }
        ]
}

{
        "__ControllerName__":{
                "__ParameterName__":{
                        "type": "Enum",
                        "defaultValue": "Value1",
                        "enums": "MyEnum1",
                        "dimensions": [1]
                }
        },
        "__GeneralMetaData__":{
                "MyEnum1": ["Value1", "Value2", "Value3"]
        }
}

"__ParameterName__":{
        "type": "String",
        "defaultValue": "__ParameterDefaultValue__",
        "regex": "^[a-zA-Z0-9_]+$"
}

成员函数文档

[since ASERStudio 2.0] AStoryXValueMeta::AStoryXValueMeta()

构造函数

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] AStoryXValueMeta::AStoryXValueMeta(const ASERStudio::AStorySyntax::AStoryXValueMeta &other)

other 另一个AStoryXValueMeta对象。

复制构造函数

这个function 从 ASERStudio 2.0 开始支持。

[noexcept, since ASERStudio 2.0] AStoryXValueMeta::AStoryXValueMeta(ASERStudio::AStorySyntax::AStoryXValueMeta &&other)

other 另一个AStoryXValueMeta对象。

移动构造函数

这个function 从 ASERStudio 2.0 开始支持。

[noexcept, since ASERStudio 2.0] AStoryXValueMeta::~AStoryXValueMeta()

析构函数

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] QString AStoryXValueMeta::getDefaultValue() const

return 默认值。

返回一个QString对象。如果未设置默认值，则返回空字符串。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.1] QList<qint64> AStoryXValueMeta::getEnumCheckDimensions() const

return 枚举检查的维度。请注意，它和向量检查维度共用一个内部对象

保存数据，因此如果你中途切换该类的元数据，那么先前设置的维度可能会被覆盖或丢失。请确保在设置元数据时正确配置维度以避免潜在的问题。

这个function 从 ASERStudio 2.1 开始支持。

[since ASERStudio 2.0] QStringList AStoryXValueMeta::getEnumCheckList() const

return 枚举检查的列表。

返回一个QStringList对象，包含所有有效的枚举值。

如果未设置枚举检查列表，则返回一个空的QStringList对象。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] QPair<double, double> AStoryXValueMeta::getFloatCheckRange() const

return 浮点数检查的范围。

返回一个QPair<double, double>对象，其中first表示最小值，second表示最大值。 如果未设置范围，则返回默认的QPair对象，其first和second均为0.0。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] QPair<qint64, qint64> AStoryXValueMeta::getIntegerCheckRange() const

return 整数检查的范围。

返回一个QPair<qint64, qint64>对象，其中first表示最小值，second表示最大值。 如果未设置范围，则返回默认的QPair对象，其first和second均为0。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] QString AStoryXValueMeta::getParameterName() const

return 参数名称。

返回一个QString对象。如果未设置参数名称，则返回空字符串。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] QString AStoryXValueMeta::getStringCheckRegex() const

return 字符串检查的正则表达式。

返回一个QString对象。如果未设置正则表达式，则返回空字符串。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] ASERStudio::AStorySyntax::AStoryXValueMeta::Type AStoryXValueMeta::getType() const

return 参数类型。

返回值为AStoryXValue::Type枚举中的一个值。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] QString AStoryXValueMeta::getTypeString() const

return 参数类型的字符串表示。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.1] QList<qint64> AStoryXValueMeta::getVectorCheckDimensions() const

return 向量检查的维度。

返回一个qint64的列表，代表允许的维度值列表。

如果未设置维度，则返回0。

这个function 从 ASERStudio 2.1 开始支持。

[since ASERStudio 2.0] QList<QPair<double, double>> AStoryXValueMeta::getVectorCheckRange() const

return 向量检查的范围。

返回一个QList<QPair<double, double>>对象，其中每个QPair表示一个维度的最小值和最大值。

如果未设置范围，则返回一个空的QList对象。

这个function 从 ASERStudio 2.0 开始支持。

[static, since ASERStudio 2.0] ASERStudio::AStorySyntax::AStoryXValueMeta::Type AStoryXValueMeta::guessType(const QString &value)

value 参数值，必须是一个QString对象。该函数将根据参数值的格式进行分析和判断，以猜测其可能的类型。

return 根据参数值的格式猜测参数类型。

注意，这个函数只会在如下类型中按顺序猜测：Integer、Float、Vector、Bool和String。 该函数最差（即前四种假设均失败时）也会返回String类型，而不会返回Undefined。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] ASERStudio::AStorySyntax::AStoryXDiagnosticData::DiagnosticType AStoryXValueMeta::isTypeMatching(const QString &value) const

检查给定的参数值是否符合预设的类型和规则。

value 参数值，必须是一个QString对象。该值将根据当前设置的类型和检查规则进行验证。

return 诊断结果，返回一个AStoryXDiagnosticData::DiagnosticType枚举值，表示参数值的验证结果。

如果参数值符合预设的类型和规则，则返回AStoryXDiagnosticData::DiagnosticType::Undefined。

如果参数值不符合预设的类型或规则，则返回相应的错误类型，如ParameterFormatError或ParameterOutOfRange等。

对于数字类型的超出范围以及枚举类型的无效值、或者向量某分量超出范围、枚举组某单值超出范围，返回ParameterOutOfRange；

对于格式错误的值，例如未满足维度要求的向量或枚举组，返回ParameterFormatError；

注意，这函数只检查Type在__META__之前的类型。__META__之后的类型是作为token使用的，不进行类型检查。 如果你检查它们，则永远得到Undefined的结果。

此外，它对空参数永远返回Undefined。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] void AStoryXValueMeta::setDefaultValue(const QString &defaultValue)

设置默认值。 defaultValue 默认值，必须是一个QString对象。默认值的格式应与参数类型相匹配。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.1] void AStoryXValueMeta::setEnumCheckDimensions(const QList<qint64> &dimensions)

dimensions 枚举检查的维度，必须是一个QList<qint64>对象，表示允许的维度值列表。

设置枚举检查的维度。请注意，它和向量检查维度共用一个内部对象

保存数据，因此如果你中途切换该类的元数据，那么先前设置的维度可能会被覆盖或丢失。请确保在设置元数据时正确配置维度以避免潜在的问题。

这个function 从 ASERStudio 2.1 开始支持。

[since ASERStudio 2.0] void AStoryXValueMeta::setEnumCheckList(const QStringList &enumList)

设置枚举检查的列表。 enumList 枚举检查列表，必须是一个QStringList对象，包含所有有效的枚举值。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] void AStoryXValueMeta::setFloatCheckRange(double min, double max)

设置浮点数检查的范围。 min 最小值，必须是一个double类型的数值。 max 最大值，必须是一个double类型的数值。max必须大于或等于min。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] void AStoryXValueMeta::setIntegerCheckRange(qint64 min, qint64 max)

设置整数检查的范围。 min 最小值，必须是一个qint64类型的整数。 max 最大值，必须是一个qint64类型的整数。max必须大于或等于min。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] void AStoryXValueMeta::setMetaData(const QString &paramName, const Visindigo::Utility::JsonConfig &metaData)

paramName 参数名称，必须是一个有效的QString对象。 metaData 元数据配置，必须是一个有效的Visindigo::Utility::JsonConfig对象，且应包含与参数名称对应的元数据信息。

设置元数据。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] void AStoryXValueMeta::setParameterName(const QString &paramName)

设置参数名称。 paramName 参数名称，必须是一个有效的QString对象。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] void AStoryXValueMeta::setStringCheckRegex(const QString &regex)

设置字符串检查的正则表达式。

regex 正则表达式，必须是一个有效的QString对象。该正则表达式将用于验证字符串类型参数的格式。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] void AStoryXValueMeta::setType(ASERStudio::AStorySyntax::AStoryXValueMeta::Type type)

设置参数类型。 type 参数类型，必须是AStoryXValue::Type枚举中的一个值。

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.1] void AStoryXValueMeta::setVectorCheckRange(const QList<QPair<double, double>> &range, const QList<qint64> &dimensions)

设置向量检查的范围和维度。

range 向量检查范围，必须是一个QList<QPair<double, double>>对象，其中每个QPair表示一个维度的最小值和最大值。 range的大小必须等于dimensions中的最大值。

dimensions 向量维度，必须是一个QList<qint64>对象，表示允许的维度值列表。dimensions中的每个值必须大于0。

这个function 从 ASERStudio 2.1 开始支持。

[static, since ASERStudio 2.0] bool AStoryXValueMeta::toBool(const QString &value)

将参数值转换为布尔值。

value 参数值，必须是一个符合布尔类型要求的QString对象，例如"true"、"false"、"1"、"0"、"yes"或"no"等。

return 转换结果，返回一个bool类型的值。如果转换失败（例如参数值不符合布尔格式），则返回false。

这函数不做任何检查。

这个function 从 ASERStudio 2.0 开始支持。

[static, since ASERStudio 2.0] double AStoryXValueMeta::toFloat(const QString &value)

将参数值转换为浮点数。

value 参数值，必须是一个符合浮点数类型要求的QString对象。

return 转换结果，返回一个double类型的数值。如果转换失败（例如参数值不符合浮点数格式），则返回0.0。

这函数不做任何检查。

这个function 从 ASERStudio 2.0 开始支持。

[static, since ASERStudio 2.0] qint64 AStoryXValueMeta::toInteger(const QString &value)

将参数值转换为整数。

value 参数值，必须是一个符合整数类型要求的QString对象。

return 转换结果，返回一个qint64类型的整数。如果转换失败（例如参数值不符合整数格式），则返回0。

这函数不做任何检查。

这个function 从 ASERStudio 2.0 开始支持。

[static, since ASERStudio 2.0] QList<double> AStoryXValueMeta::toVector(const QString &value)

将参数值转换为向量。

value 参数值，必须是一个符合向量类型要求的QString对象，即逗号分隔的数值列表。

return 转换结果，返回一个QList<double>对象，包含向量的各个分量。

如果整体切分失败，可能返回一个包含唯一0值的列表；如果切分成功但某个分量转换失败，则该分量的值为0。

这函数不做任何检查。

这个function 从 ASERStudio 2.0 开始支持。

[static, since ASERStudio 2.0] QString AStoryXValueMeta::typeToString(ASERStudio::AStorySyntax::AStoryXValueMeta::Type type)

type 参数类型，必须是AStoryXValueMeta::Type枚举中的一个值。

return 将参数类型枚举值转换为字符串表示。

这个function 从 ASERStudio 2.0 开始支持。

[noexcept, since ASERStudio 2.0] ASERStudio::AStorySyntax::AStoryXValueMeta &AStoryXValueMeta::operator=(ASERStudio::AStorySyntax::AStoryXValueMeta &&other)

other 另一个AStoryXValueMeta对象。

移动赋值运算符

这个function 从 ASERStudio 2.0 开始支持。

[since ASERStudio 2.0] ASERStudio::AStorySyntax::AStoryXValueMeta &AStoryXValueMeta::operator=(const ASERStudio::AStorySyntax::AStoryXValueMeta &other)

other 另一个AStoryXValueMeta对象。

复制赋值运算符

这个function 从 ASERStudio 2.0 开始支持。