Base structure representing VMXResourceType-specific configuration data that must be set to a valid default before activating a resource of that type. More...
#include <VMXResourceConfig.h>
Public Member Functions | |
| VMXResourceConfig (VMXResourceType res_type) | |
| VMXResourceType | GetResourceType () const |
| VMXResourceType which this configuration applies to. | |
| virtual VMXResourceConfig * | GetCopy () const =0 |
| Instantiates a copy of the configuration data. More... | |
| virtual bool | Copy (const VMXResourceConfig *p_config)=0 |
| Copies the contents of the source VMXResourceConfig object into this object. More... | |
Public Attributes | |
| VMXResourceType | res_type |
Detailed Description
Base structure representing VMXResourceType-specific configuration data that must be set to a valid default before activating a resource of that type.
Note that once the VMXResource is activated, the VMXResource must first be successfully deactivated before that VMXResource's configuration data can be modified.
Member Function Documentation
◆ Copy()
|
pure virtual |
Copies the contents of the source VMXResourceConfig object into this object.
NOTE: The source object's VMXResourceType must match this object's VMXResourceType.
- Parameters
-
[in] p_config The source VMXResourceConfig object from which to copy configuration data into this object.
Implemented in I2CConfig, SPIConfig, UARTConfig, AnalogTriggerConfig, AccumulatorConfig, EncoderConfig, PWMCaptureConfig, PWMGeneratorConfig, DIOConfig, and InterruptConfig.
◆ GetCopy()
|
pure virtual |
Instantiates a copy of the configuration data.
NOTE: The caller is responsible to delete the object returned from this method.
Implemented in I2CConfig, SPIConfig, UARTConfig, AnalogTriggerConfig, AccumulatorConfig, EncoderConfig, PWMCaptureConfig, PWMGeneratorConfig, DIOConfig, and InterruptConfig.
The documentation for this struct was generated from the following file:
- /home/pi/vmx/vmx-pi/hal/hal_cpp/include/VMXResourceConfig.h
