space_ex

v0.8.0

space_ex v0.8.0 SpaceEx.SpaceCenter.Antenna

An antenna.

Obtained by calling SpaceEx.SpaceCenter.Part.antenna/1.

Link to this section Summary

Functions

allow_partial(this)

Whether partial data transmission is permitted

can_transmit(this)

Whether data can be transmitted by this antenna

cancel(this)

Cancel current transmission of data

combinable(this)

Whether the antenna can be combined with other antennae on the vessel to boost the power

combinable_exponent(this)

Exponent used to calculate the combined power of multiple antennae on a vessel

deployable(this)

Whether the antenna is deployable

deployed(this)

Whether the antenna is deployed

packet_interval(this)

Interval between sending packets in seconds

packet_resource_cost(this)

Units of electric charge consumed per packet sent

packet_size(this)

Amount of data sent per packet in Mits

part(this)

The part object for this antenna

power(this)

The power of the antenna

set_allow_partial(this, value)

Whether partial data transmission is permitted

set_deployed(this, value)

Whether the antenna is deployed

state(this)

The current state of the antenna

transmit(this)

Transmit data

Link to this section Functions

Link to this function allow_partial(this)

Whether partial data transmission is permitted.

Returns: true or false

Link to this function can_transmit(this)

Whether data can be transmitted by this antenna.

Returns: true or false

Link to this function cancel(this)

Cancel current transmission of data.

Returns: :ok

Link to this function combinable(this)

Whether the antenna can be combined with other antennae on the vessel to boost the power.

Returns: true or false

Link to this function combinable_exponent(this)

Exponent used to calculate the combined power of multiple antennae on a vessel.

Returns: a high precision decimal

Link to this function deployable(this)

Whether the antenna is deployable.

Returns: true or false

Link to this function deployed(this)

Whether the antenna is deployed.

Fixed antennas are always deployed. Returns an error if you try to deploy a fixed antenna.

Returns: true or false

Link to this function packet_interval(this)

Interval between sending packets in seconds.

Returns: a low-precision decimal

Link to this function packet_resource_cost(this)

Units of electric charge consumed per packet sent.

Returns: a high precision decimal

Link to this function packet_size(this)

Amount of data sent per packet in Mits.

Returns: a low-precision decimal

Link to this function part(this)

The part object for this antenna.

Returns: a reference to a SpaceEx.SpaceCenter.Part object

Link to this function power(this)

The power of the antenna.

Returns: a high precision decimal

Link to this function set_allow_partial(this, value)

Whether partial data transmission is permitted.

Returns: :ok

Link to this function set_deployed(this, value)

Whether the antenna is deployed.

Fixed antennas are always deployed. Returns an error if you try to deploy a fixed antenna.

Returns: :ok

Link to this function state(this)

The current state of the antenna.

Returns: a Elixir.SpaceEx.SpaceCenter.AntennaState value in atom form

Link to this function transmit(this)

Transmit data.

Returns: :ok