value_factory_provider.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_VALUE_FACTORY_H
#define AUBO_SCOPE_VALUE_FACTORY_H
 
#include <aubo_caps/class_forward.h>
#include <aubo_caps/domain/value/expression/expression.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(ValueFactory);
 
/**
 * @ingroup ApplicationApi
 * \chinese
 * 值工厂接口
 * <h1>概述</h1>
 * 此接口提供使用工厂创建不可变值对象的方法。{@link SimpleValueFactory} 帮助创建
 * 简单值对象。{@link ExpressionBuilder} 帮助构建有效表达式。{@link BlendFactory}
 * 帮助创建过渡对象。{@link JointPositionFactory} 帮助创建关节位置对象。
 * {@link PoseFactory} 帮助创建姿态对象。
 * \endchinese
 * \english
 * ValueFactory
 * <h1>Summary</h1>
 * This interface provides a mean to create immutable value objects using
 * factories. The {@link SimpleValueFactory} helps creating simple value
 * objects. The {@link ExpressionBuilder} helps building valid expressions. The
 * {@link BlendFactory} helps creating blend objects. The {@link
 * JointPositionFactory} helps creating joint positions objects. The {@link
 * PoseFactory} helps creating Pose objects.
 * \endenglish
 */
class ARCS_ABI_EXPORT ValueFactory
{
public:
    ValueFactory(ValueFactory &f);
    ValueFactory(ValueFactory &&f);
    virtual ~ValueFactory();
 
    /**
     * \chinese
     * 实例化一个新的{@link ExpressionBuilder}来创建单个有效表达式。
     * @return 表达式构建器。
     * \endchinese
     * \english
     * This method instantiates a new {@link ExpressionBuilder} to create a
     * single valid expression.
     *
     * @return the builder to build a single expression.
     * \endenglish
     */
    ExpressionPtr createExpression();
    ExpressionPtr createExpression(const std::string &str);
 
private:
    friend class DataSwitch;
    ValueFactory();
    void *d_{ nullptr };
};
} // namespace aubo_scope
} // namespace arcs
 
#endif