专栏目录
simucpp：C++搭建微分方程求解器框架(重写simulink)
simucpp系列教程(1)安装教程
simucpp系列教程(2)例程解析(第一部分)
simucpp系列教程(3)例程解析(第二部分)
simucpp系列教程(4)使用教程与程序说明
simucpp系列教程(5)各模块的简要介绍
simucpp系列教程(6)函数文档
??所有函数包括仿真器的函数和模块的函数。仿真器的函数中包括用于批量设置输出模块的函数和其它设置函数；模块的函数中包括基类模块函数、含有特殊属性的函数、模块自有的函数等。
??这篇文章叫文档其实不太合适，只做了大致的总结但足够日常使用了，具体的使用细节在之前的文章中已经进行了详细介绍，仿真器的函数的具体使用与设置见
simucpp系列教程(4)使用教程与程序说明，模块的函数的具体使用与设置见
simucpp系列教程(5)所有模块介绍。或者，程序的头文件中对各个函数的注释也很详细。
仿真器函数
通过下面的函数对仿真器进行设置。
| 函数 | 含义 | 备注 |
|---|
| void Initialize() | 建立模块连接 | 公有 | | void Simulation_Reset() | 属于当前仿真器的所有模块复位 | 公有 | | int Simulate() | 进行一次仿真 | 公有 | | int Simulate_OneStep() | 进行一次单步仿真 | 公有 | | int Simulate_FinalStep() | 单步仿真的最后一步 | 公有 | | void Set_EnableStore(bool) | 是否将输出模块的数据保存到一个vector数组中 | 公有,OUTPUT
1
^1
1 | | void Set_EnablePlot(bool） | 是否画波形图 | 公有 | | void Set_SampleTime(bool） | 设置多长时间保存一次数据至vector | 公有,OUTPUT | | void Set_t(double) | | 公有 | | double Get_t() | | 公有 | | void Set_Duration(double) | | 公有 | | double Get_Duration() | | 公有 | | void Set_SimStep(double) | | 公有 | | double Get_SimStep() | | 公有 | | void Set_WarningLevel(int) | 设置报错等级 | 公有 | | void Add_Module(const PUnitModule) | | 私有 | | void Build_Connection(std::vector&) | | 私有 |
1
^1
1该函数与输出(OUTPUT)模块的对应函数同名，用于批量设置输出模块。
基类模块函数
所有单元模块都有的函数。
| 函数 | 含义 | 备注 |
|---|
| double Get_OutValue() | 得到模块的输出值 | 公有 | | void Set_Enable(bool enable) | 使能模块 | 私有 | | int Self_Check() | 初始化时检查模块是否存在问题 | 私有 | | void Module_Update(double time) | 模块更新 | 私有 | | Module_Reset() | 复位模块 | 私有 | | Int Get_childCnt() | 模块的输入端口数量 | 私有 | | PUnitModule Get_child(unsigned int n) | 得到第N个输入端口对应的模块句柄 | 私有 | | connect(const PUnitModule m) | 将一个模块连接到这个模块的输入端口 | 私有 |
派生类模块函数
| 函数 | 含义 | 备注 |
|---|
| Set_SampleTime(double) | 设置采样周期 | 公有,离散
1
^1
1 | | void Set_Function(double(*function)(double)) | 设置输入函数 | 公有,函数
2
^2
2 | | void Set_Function(UserFunc*) | 设置输入函数 | 公有,函数 | | Set_InputGain(double, int) | 设置输入端口的增益 | 公有,增益
3
^3
3 | | Set_Continuous(bool) | 设置是否是连续模块 | 公有,INPUT | | void Set_EnableStore(bool) | 是否将数据保存到一个vector数组中 | 公有,OUTPUT | | vector& Get_StoredData() | 得到内部存储的数据 | 公有,OUTPUT | | Set_MaxDataStorage(int n) | 设置最大可以存储的数据量 | 公有,OUTPUT |
1
^1
1包含离散内容的模块均有该函数。
2
^2
2包含自定义函数的模块均有该函数。
3
^3
3包含输入增益的模块均有该函数。
|