# Axis 类必须属性

`Axis` 是 PLCopen 运动控制库的核心仿真类，实现 IEC 61131-3 单轴状态机与运动学。

---

## 1. 当前已实现

### 1.1 轴标识与自引用 — `AXIS_REF ref_`

| 字段 | 类型 | 说明 |
|------|------|------|
| `axisNo` | `UINT` | 轴编号，由用户在构造时指定，默认 1 |
| `axisName` | `std::string` | 轴名称，默认 `"Axis1"` |
| `axis` | `Axis*` | 指向自身实例的指针，供功能块间接访问轴对象 |

> `AXIS_REF` 在 IEC 61131-3 中是 `VAR_IN_OUT` 参数，本实现中构造时自绑定。

### 1.2 轴状态 — `MC_AXIS_STATE state_`

当前状态机状态，初始值为 `Disabled`。可能的取值：

```
Disabled → Standstill → DiscreteMotion / ContinuousMotion / Homing
                     → Stopping
          ErrorStop
          SynchronizedMotion (预留)
```

状态转换由 `cycle()` 方法驱动（尚未实现）。

### 1.3 构造函数

```cpp
explicit Axis(UINT axisNo = 1, std::string name = "Axis1");
```

初始化 `ref_` 并自绑定 `axis` 指针，`state_` 默认 `Disabled`。

---

## 2. 必须扩展的属性（待实现）

按照 PLCopen 规范，完整的轴模型还需以下属性。

### 2.1 运动学属性

| 属性 | 类型 | 说明 |
|------|------|------|
| `position_` | `REAL` | 当前指令位置 |
| `actualPosition_` | `REAL` | 当前实际位置 |
| `velocity_` | `REAL` | 当前速度 |
| `actualVelocity_` | `REAL` | 实际速度 |
| `acceleration_` | `REAL` | 当前加速度 |
| `deceleration_` | `REAL` | 当前减速度 |

### 2.2 活动指令 — `MotionCommand activeCommand_`

当前正在执行的运动指令参数快照，类型为 `MotionCommand`：

| 字段 | 类型 | 说明 |
|------|------|------|
| `type` | `MotionCommandType` | 指令类型（点到点 / 速度 / 停止 / 暂停 / 回零） |
| `targetPosition` | `REAL` | 目标位置 |
| `targetVelocity` | `REAL` | 目标速度 |
| `maxVelocity` | `REAL` | 最大速度 |
| `acceleration` | `REAL` | 加速度 |
| `deceleration` | `REAL` | 减速度 |
| `homePosition` | `REAL` | 回零位置 |
| `resultingState` | `MC_AXIS_STATE` | 指令完成后要进入的状态 |

### 2.3 功率与使能

| 属性 | 类型 | 说明 |
|------|------|------|
| `powerEnabled_` | `BOOL` | 功率级是否使能 |
| `homed_` | `BOOL` | 是否已完成回零 |

### 2.4 错误管理

| 属性 | 类型 | 说明 |
|------|------|------|
| `errorId_` | `MC_ERROR_ID` | 当前错误码，`mcNoError` 表示正常 |
| `errorStop_` | `BOOL` | 是否触发错误停止 |

### 2.5 轴状态机方法 — `cycle()`

```cpp
void cycle(REAL deltaTime);
```

每周期由应用层调用，执行：
1. 根据 `activeCommand_` 计算运动学输出
2. 更新 `position_` / `velocity_`
3. 评估状态转换条件
4. 在离散运动到达目标时自动切换到 `Standstill`

### 2.6 功能块交互接口

| 方法 | 说明 |
|------|------|
| `acceptCommand(const MotionCommand&)` | 接收功能块下发的运动指令 |
| `doPower(BOOL enable)` | 功率使能/去使能 |
| `doStop()` / `doHalt()` | 停止 / 暂停 |
| `doReset()` | 从 ErrorStop 恢复 |
| `doHome(REAL homePos)` | 发起回零 |
| `readStatus()` | 读取当前状态快照 |
| `readError()` | 读取当前错误码 |

---

## 3. 完整属性清单（含待实现）

```
Axis
├── ref_              (AXIS_REF)    ✅ 已实现
├── state_            (MC_AXIS_STATE) ✅ 已实现
├── position_         (REAL)        ⬜ 位置
├── actualPosition_   (REAL)        ⬜ 实际位置
├── velocity_         (REAL)        ⬜ 速度
├── actualVelocity_   (REAL)        ⬜ 实际速度
├── acceleration_     (REAL)        ⬜ 加速度
├── deceleration_     (REAL)        ⬜ 减速度
├── activeCommand_    (MotionCommand) ⬜ 活动指令
├── powerEnabled_     (BOOL)        ⬜ 功率使能
├── homed_            (BOOL)        ⬜ 回零完成
├── errorId_          (MC_ERROR_ID) ⬜ 错误码
└── errorStop_        (BOOL)        ⬜ 错误停止
```