script_writer.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_SCRIPT_WRITER_H
#define AUBO_SCOPE_SCRIPT_WRITER_H
 
#include <vector>
#include <string>
#include <aubo_caps/domain/variable/variable.h>
#include <aubo_caps/domain/value/expression/expression.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(ScriptWriter);
 
/**
 * \chinese
 * 脚本写入器
 * 此接口提供生成脚本代码的支持。
 * \endchinese
 * \english
 * ScriptWriter
 * This interface provides support for generating Script code.
 * \endenglish
 */
class ARCS_ABI_EXPORT ScriptWriter
{
public:
    ScriptWriter(ScriptWriter &f);
    ScriptWriter(ScriptWriter &&f);
    virtual ~ScriptWriter();
 
    void setLabel(int lineno, const std::string &comment);
 
    /**
     * \chinese
     * 使用自动缩进添加一行脚本代码。
     * @param script_line 要追加的脚本代码行。
     * \endchinese
     * \english
     * Adds a single line of script code using auto-indentation.
     *
     * @param script_line single line of script code to append.
     * \endenglish
     */
    void appendLine(const std::string &script_line);
    void appendVectorDouble(const std::vector<double> &value);
 
    /**
     * \chinese
     * 按原样追加脚本代码，不使用自动缩进。
     * @param script 要追加的脚本代码。
     * \endchinese
     * \english
     * Adds script code appending the script code as is without using
     * auto-indentation.
     *
     * @param script script code to append.
     * \endenglish
     */
    void appendRaw(const std::string &script);
 
    /**
     * \chinese
     * 生成包含完整脚本代码的字符串。
     * @return 生成的脚本字符串。
     * \endchinese
     * \english
     * Generate a string with the full script code.
     *
     * @return the resulting script as a string.
     * \endenglish
     */
    std::string generateScript();
 
    /**
     * \chinese
     * 当为具有子节点的节点生成脚本代码时使用此方法。让子节点生成代码。
     * \endchinese
     * \english
     * Use this method when generating script code for a node that has children
     * nodes. Let children nodes generate code.
     * \endenglish
     */
    void writeChildren();
 
    void assign(VariablePtr variable, const std::string &expression,
                bool sync = false);
 
    /**
     * \chinese
     * <p>变量赋值。在无local或global限定符的情况下赋值。</p>
     * @param variableName 变量名称。
     * @param expression 赋给变量的表达式。
     * \endchinese
     * \english
     * <p>Variable assignment.
     * Assigns the variable without a local or global qualifier.</p>
     * @param variableName name of the variable, not null.
     * @param expression expression that is assigned to the variable, not null.
     * \endenglish
     */
    void assign(const std::string &variableName,
                const ExpressionPtr &expression, bool sync = false);
 
    /**
     * \chinese
     * <p>变量赋值。</p>
     * @param variable 变量。
     * @param expression 表达式。
     * \endchinese
     * \english
     * <p>Variable assignment.</p>
     * @param variable the variable to assign an expression to, not null.
     * @param expression expression that is assigned to the variable, not null.
     * \endenglish
     */
    void assign(VariablePtr variable, const ExpressionPtr &expression,
                bool sync = false);
 
    /**
     * \chinese
     * 变量值加1。
     * @param variable_name 要递增的变量名称。
     * \endchinese
     * \english
     * Add 1 to the variable value.
     * @param variable_name the variable to increment.
     * \endenglish
     */
    void incrementVariable(const std::string &variable_name);
 
    /**
     * \chinese 添加注释。 \endchinese
     * \english Add a note. @param expression the note expression. \endenglish
     */
    void note(const std::string &expression);
 
    /**
     * \chinese 休眠指定秒数。 \endchinese
     * \english Sleep for a number of seconds. @param seconds amount of time to sleep in seconds. \endenglish
     */
    void sleep(double seconds);
 
    /** \chinese 用完当前帧剩余时间。 \endchinese \english Sync. \endenglish */
    void sync();
 
    /** \chinese 定义函数。 \endchinese \english Define a function. @param func_name function name. \endenglish */
    void defineFunction(const std::string &func_name);
    void anonyFunction(const std::string &func_name);
 
    void setRobotIndex(int robot_index);
 
    /** \chinese 返回。 \endchinese \english Return from method. \endenglish */
    void returnMethod();
 
    /** \chinese 插入end。 \endchinese \english Insert an end. \endenglish */
    void end();
 
    /** \chinese 插入空行。 \endchinese \english Insert an empty line. \endenglish */
    void lineFeed();
 
    /**
     * \chinese 设置负载质量和重心。 \endchinese
     * \english Sets the mass and Center of Gravity of the payload. \endenglish
     */
    void setPayload(double mass, double x, double y, double z);
 
    /** \chinese 设置TCP。 \endchinese \english Set the Tool Center Point. \endenglish */
    void setTcp(const std::vector<double> &pose);
 
    /** \chinese 开始if条件。 \endchinese \english Start an if-conditional. @param expression the expression. \endenglish */
    void ifCondition(const ExpressionPtr &expression);
 
    /** \chinese 开始取反的if条件。 \endchinese \english Start a negated if-conditional. @param expression the expression. \endenglish */
    void ifNotCondition(const ExpressionPtr &expression);
 
    /** \chinese 添加else-if分支。 \endchinese \english Adds an else-if branch. @param expression the expression. \endenglish */
    void elseIfCondition(const ExpressionPtr &expression);
 
    /** \chinese 添加else分支。 \endchinese \english Adds an else branch. \endenglish */
    void elseCondition();
 
    /** \chinese 开始for循环。 \endchinese \english Starts a for-loop. @param count loop count, @param step loop step. \endenglish */
    void forCondition(int count, int step);
 
    /** \chinese 开始while true循环。 \endchinese \english Starts a while true loop. \endenglish */
    void whileTrue();
 
    /** \chinese 开始while循环。 \endchinese \english Starts a while-loop. @param expression the loop invariant. \endenglish */
    void whileCondition(const ExpressionPtr &expression);
 
    /** \chinese 开始取反的while循环。 \endchinese \english Starts a negated while-loop. @param expression the loop invariant. \endenglish */
    void whileNot(const ExpressionPtr &expression);
 
    /**
     * \chinese 定义线程。 \endchinese
     * \english Start a thread definition. @param thread_name the thread name, @param loop_or_not whether loops. \endenglish
     */
    void defineThread(const std::string &thread_name, bool loop_or_not);
 
    /** \chinese 启动线程。 \endchinese \english Start a thread. @param thread_name the thread name. \endenglish */
    void runThread(const std::string &thread_name);
 
    /** \chinese 终止线程。 \endchinese \english Kill a thread. @param thread_name the thread name. \endenglish */
    void killThread(const std::string &thread_name);
 
    /**
     * \chinese
     * 获取可在脚本中使用的已注册变量名。
     * @param variable_name 变量名称。
     * @return 可在脚本中使用的变量名。
     * \endchinese
     * \english
     * Returns a registered variable name that can be used in a script.
     * @param variable_name a variable name.
     * @return variable name that can be used in a script.
     * \endenglish
     */
    std::string getResolvedVariable(const std::string &variable_name);
 
    void increaseIndent();
    void decreaseIndent();
 
private:
    friend class DataSwitch;
    ScriptWriter();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_SCRIPT_WRITER_H