variable.h

Go to the documentation of this file.

#ifndef AUBO_SCOPE_VARIABLE_H
#define AUBO_SCOPE_VARIABLE_H
 
#include <string>
#include <aubo_caps/class_forward.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(Variable);
 
/**
 * @ingroup ApplicationApi
 * \chinese
 * 变量接口
 * 表示 AuboScope 中的变量。变量可用于在程序中存储和传递数据。
 * \endchinese
 * \english
 * Variable
 * Represents a variable in AuboScope. Variables can be used to store and pass
 * data in programs.
 * \endenglish
 */
 
class ARCS_ABI_EXPORT Variable
{
public:
    Variable(Variable &f);
    Variable(Variable &&f);
    virtual ~Variable();
 
    /**
     * The variable type used to determine which type of variable this instance
     * is.
     */
    enum Type : int
    {
 
        /**
         * <p>
         * GLOBAL means that the variable is available everywhere in a program.
         * </p>
         *
         * This variable instance can be cast to {@link GlobalVariable}.
         */
        GLOBAL,
 
        /**
         * <p>
         * VALUE_PERSISTED means that the variable is stored with the
         * installation. These variables are defined in the installation and
         * will retain their values even when a robot is turned off and on.
         * </p>
         *
         * This variable instance can be cast to {@link ValuePersistedVariable}.
         */
        VALUE_PERSISTED,
 
        /**
         * <p>
         * FEATURE means that a Feature is marked as a variable. The variable is
         * defined in the installation and will exist even when a robot is
         * turned off and on.
         * </p>
         *
         * This variable instance can be cast to {@link FeatureVariable}.
         */
        FEATURE
    };
 
    /**
     * @ingroup Variable
     * \chinese
     * 获取变量类型
     * @return 变量类型枚举。
     * \endchinese
     * \english
     * Returns the type of variable.
     * @return the type of variable.
     * \endenglish
     */
    Type getType();
 
    /**
     * @ingroup Variable
     * \chinese
     * 获取变量显示名称。注意：变量可随时被重命名。
     * @return 变量显示名称。
     * \endchinese
     * \english
     * Note: The variable can be renamed at any time.
     * @return the display name of the variable.
     * \endenglish
     */
    std::string getDisplayName();
 
    /**
     * @ingroup Variable
     * \chinese
     * 判断是否引用相同的内部变量
     * @return 如果对象引用相同的内部变量返回true。
     * \endchinese
     * \english
     * Checks if the object references the same internal Variable.
     * @return true if object references the same internal Variable.
     * \endenglish
     */
    bool equals(VariablePtr object);
 
    /**
     * @ingroup Variable
     * \chinese
     * 获取哈希码
     * @return 此对象的哈希码。
     * \endchinese
     * \english
     * Returns the hash code for this object.
     * @return hashCode for this object.
     * \endenglish
     */
    size_t hashCode();
 
    /**
     * @ingroup Variable
     * \chinese
     * 获取变量的字符串表示
     * @return 变量的字符串表示。
     * \endchinese
     * \english
     * Returns a string representation of the variable.
     * @return a string representation of the variable.
     * \endenglish
     */
    std::string toString();
 
protected:
    Variable();
 
private:
    friend class DataSwitch;
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
#endif // AUBO_SCOPE_VARIABLE_H