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

Inheritance diagram for PWMCaptureConfig:

Public Types
enum	CaptureEdge { RISING, FALLING }
	Specifies which PWM input signal edge starts the PWM duty cycle timer.

Public Member Functions
	PWMCaptureConfig ()
	PWMCaptureConfig default constructor; sets all values to defaults.

	PWMCaptureConfig (CaptureEdge edge_type)
	PWMCaptureConfig constructor; initializes values with the provided input parameters *. More...

CaptureEdge	GetCaptureEdge ()
	Returns the configured PWM CaptureEdge.

void	SetCaptureEdge (CaptureEdge edge)
	Sets the configured PWM CaptureEdge.

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
CaptureEdge	edge_type

Public Attributes inherited from VMXResourceConfig
VMXResourceType	res_type

Detailed Description

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

Constructor & Destructor Documentation

PWMCaptureConfig::PWMCaptureConfig ( CaptureEdge edge_type )

inline

PWMCaptureConfig constructor; initializes values with the provided input parameters *.

Parameters

edge_type The PWM Capture CaptureEdge

virtual bool PWMCaptureConfig::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.

virtual VMXResourceConfig* PWMCaptureConfig::GetCopy ( ) const

inlinevirtual

Instantiates a copy of the configuration data.

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

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