UARTConfig Struct Reference

Contains the configuration data for a VMXResource whose VMXResourceType is UART. More...

#include <VMXResourceConfig.h>

Inheritance diagram for UARTConfig:

Public Member Functions
	UARTConfig ()
	UARTConfig default constructor; sets all values to defaults.
	UARTConfig (uint32_t baudrate_bps)
	UARTConfig constructor; initializes values with the provided input parameters. More...
uint32_t	GetBaudrate ()
	Returns the configured UART baudrate.
void	SetBaudrate (uint32_t baudrate_bps)
	Sets the configured UART baudrate.
virtual size_t	GetSize () const
virtual VMXResourceConfig *	GetCopy () const
	Instantiates a copy of the configuration data. More...
virtual bool	Copy (const VMXResourceConfig *p_config)
	Copies the contents of the source VMXResourceConfig object into this object. More...
Public Member Functions inherited from VMXResourceConfig
	VMXResourceConfig (VMXResourceType res_type)
VMXResourceType	GetResourceType () const
	VMXResourceType which this configuration applies to.

Public Attributes
uint32_t	baudrate_bps
Public Attributes inherited from VMXResourceConfig
VMXResourceType	res_type

Detailed Description

Contains the configuration data for a VMXResource whose VMXResourceType is UART.

Constructor & Destructor Documentation

UARTConfig()

UARTConfig::UARTConfig ( uint32_t  baudrate_bps )

inline

UARTConfig constructor; initializes values with the provided input parameters.

Parameters

baudrate_bps

The UART baudrate in bits/second

Member Function Documentation

Copy()

virtual bool UARTConfig::Copy ( const VMXResourceConfig *  p_config )

inlinevirtual

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.

Implements VMXResourceConfig.

GetCopy()

virtual VMXResourceConfig* UARTConfig::GetCopy ( ) const

inlinevirtual

Instantiates a copy of the configuration data.

NOTE: The caller is responsible to delete the object returned from this method.

Implements VMXResourceConfig.

---

The documentation for this struct was generated from the following file:

• /home/pi/vmx/vmx-pi/hal/hal_cpp/include/VMXResourceConfig.h