class ElementSchema

Defined at line 903 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

Passed to Topology.AddElement.

Public Members

static const fidl_type_t * FidlType

Public Methods

bool IsEmpty ()

Returns whether no field is set.

const ::std::string & element_name ()

Human-readable name for logging and debug purposes.

Defined at line 910 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

bool has_element_name ()

Defined at line 914 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

::std::string * mutable_element_name ()

Human-readable name for logging and debug purposes.

Defined at line 919 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

void clear_element_name ()

Defined at line 927 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

const uint8_t & initial_current_level ()

The initial current power level of the element.

To be used with `initial_lease_token`, see note below.

Defined at line 937 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

bool has_initial_current_level ()

Defined at line 941 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

uint8_t * mutable_initial_current_level ()

The initial current power level of the element.

To be used with `initial_lease_token`, see note below.

Defined at line 947 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

void clear_initial_current_level ()

Defined at line 955 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

bool has_valid_levels ()

Defined at line 974 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

::std::vector<uint8_t> * mutable_valid_levels ()

All power levels that are valid for this element. Any level not

specified here will be treated as invalid.

Levels must be listed in ascending order from low to high. Note, levels are enums and their

integer values do not have an inherent meaning. For example, *theoretically* a binary

(off, on) could be represented with (0, 1), (1, 0), (17, 19) or any combination of two

two numbers. (But please use BinaryPowerLevel above!)

Defined at line 985 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

void clear_valid_levels ()

Defined at line 993 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

const ::std::vector< ::fuchsia::power::broker::LevelDependency> & dependencies ()

List of dependencies for this element's power levels.

Note: dependencies UPON this element's levels cannot be added here.

Defined at line 1003 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

bool has_dependencies ()

Defined at line 1007 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

::std::vector< ::fuchsia::power::broker::LevelDependency> * mutable_dependencies ()

List of dependencies for this element's power levels.

Note: dependencies UPON this element's levels cannot be added here.

Defined at line 1013 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

void clear_dependencies ()

Defined at line 1021 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

const ::fidl::InterfaceRequest< ::fuchsia::power::broker::Lessor> & lessor_channel ()

REMOVED: 7: level_control_channels, use `element_runner` instead (see below).

DEPRECATED. Use `Topology.Lease` instead.

Optional. If passed, Leases for this element can be requested via this

channel.

Defined at line 1034 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

bool has_lessor_channel ()

Defined at line 1038 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

::fidl::InterfaceRequest< ::fuchsia::power::broker::Lessor> * mutable_lessor_channel ()

REMOVED: 7: level_control_channels, use `element_runner` instead (see below).

DEPRECATED. Use `Topology.Lease` instead.

Optional. If passed, Leases for this element can be requested via this

channel.

Defined at line 1047 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

void clear_lessor_channel ()

Defined at line 1055 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

const ::fidl::InterfaceRequest< ::fuchsia::power::broker::ElementControl> & element_control ()

Caller-provided ElementControl channel to be passed to Power Broker.

When this channel is dropped, the element will be removed from the

topology. All channels associated with this element will be

closed and all tokens registered to this element will be

unregistered.

Defined at line 1068 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

bool has_element_control ()

Defined at line 1072 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

::fidl::InterfaceRequest< ::fuchsia::power::broker::ElementControl> * mutable_element_control ()

Caller-provided ElementControl channel to be passed to Power Broker.

When this channel is dropped, the element will be removed from the

topology. All channels associated with this element will be

closed and all tokens registered to this element will be

unregistered.

Defined at line 1081 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

void clear_element_control ()

Defined at line 1089 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

const ::fidl::InterfaceHandle< ::fuchsia::power::broker::ElementRunner> & element_runner ()

The client-end that Power Broker should use to set the power level of this element.

The server_end of this should be retained and the ElementRunner

protocol implemented by the element's runner.

Defined at line 1100 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

bool has_element_runner ()

Defined at line 1104 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

::fidl::InterfaceHandle< ::fuchsia::power::broker::ElementRunner> * mutable_element_runner ()

The client-end that Power Broker should use to set the power level of this element.

The server_end of this should be retained and the ElementRunner

protocol implemented by the element's runner.

Defined at line 1111 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

void clear_element_runner ()

Defined at line 1119 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

const ::zx::eventpair & initial_lease_token ()

If `initial_lease_token` is set, a lease will be immediately taken at

`initial_current_level` and all SetLevel calls prior to reaching

`initial_current_level` will be suppressed. The first SetLevel call

will be for `initial_current_level`.

The client should pass here the half of an eventpair to be held by

Power Broker. The other half of the pair should be retained by the

client.

Note: this lease will likely not be SATISFIED when returned, as that

would require the ElementRunner server to already have received and

responded to a SetLevel request from Power Broker.

Clients can listen for `LEASE_SIGNAL_SATISFIED` to know when the

lease has been `SATISFIED`.

Defined at line 1139 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

bool has_initial_lease_token ()

Defined at line 1143 of file fidling/gen/sdk/fidl/fuchsia.power.broker/fuchsia.power.broker/hlcpp/fuchsia/power/broker/cpp/fidl.h

::zx::eventpair * mutable_initial_lease_token ()