pw::clock_tree::ElementController Class Reference

#include <clock_tree.h>

Public Member Functions
constexpr	ElementController (ClockTree *clock_tree=nullptr, Element *element=nullptr)
Status	Acquire ()
Status	Release ()

Public Attributes
ClockTree *	clock_tree_ = nullptr
	Pointer to optional ClockTree object.
Element *	element_ = nullptr
	Pointer to optional Element object.

Detailed Description

Helper class that allows drivers to accept optional clock tree information and streamline clock tree operations.

Constructor & Destructor Documentation

ElementController()

constexpr pw::clock_tree::ElementController::ElementController ( ClockTree *  clock_tree = nullptr, Element *  element = nullptr  )

inlineconstexpr

Create an element controller that accepts optional clock tree and element information.

Member Function Documentation

Acquire()

Status pw::clock_tree::ElementController::Acquire ( )

inline

Acquire a reference to the optional clock tree element.

If not both optional clock_tree and element pointers are non-null, the function just returns pw::OkStatus().

Release()

Status pw::clock_tree::ElementController::Release ( )

inline

Release a reference to the optional clock tree element.

If not both optional clock_tree and element pointers are non-null, the function just returns pw::OkStatus().

---

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

• pw_clock_tree/public/pw_clock_tree/clock_tree.h