space_ex

v0.8.0

space_ex v0.8.0 SpaceEx.SpaceCenter.Resources

Represents the collection of resources stored in a vessel, stage or part.

Created by calling SpaceEx.SpaceCenter.Vessel.resources/1, SpaceEx.SpaceCenter.Vessel.resources_in_decouple_stage/3 or SpaceEx.SpaceCenter.Part.resources/1.

Link to this section Summary

Functions

all(this)

All the individual resources that can be stored

amount(this, name)

Returns the amount of a resource that is currently stored

density(conn, name)

Returns the density of a resource, in \(kg/l\)

enabled(this)

Whether use of all the resources are enabled

flow_mode(conn, name)

Returns the flow mode of a resource

has_resource(this, name)

Check whether the named resource can be stored

max(this, name)

Returns the amount of a resource that can be stored

names(this)

A list of resource names that can be stored

set_enabled(this, value)

Whether use of all the resources are enabled

with_resource(this, name)

All the individual resources with the given name that can be stored

Link to this section Functions

Link to this function all(this)

All the individual resources that can be stored.

Returns: [resource, ...], where resource is a reference to a SpaceEx.SpaceCenter.Resource object

Link to this function amount(this, name)

Returns the amount of a resource that is currently stored.

  • name — The name of the resource.

Returns: a low-precision decimal

Link to this function density(conn, name)

Returns the density of a resource, in \(kg/l\).

  • name — The name of the resource.

Returns: a low-precision decimal

Link to this function enabled(this)

Whether use of all the resources are enabled.

This is true if all of the resources are enabled. If any of the resources are not enabled, this is false.

Returns: true or false

Link to this function flow_mode(conn, name)

Returns the flow mode of a resource.

  • name — The name of the resource.

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

Link to this function has_resource(this, name)

Check whether the named resource can be stored.

  • name — The name of the resource.

Returns: true or false

Link to this function max(this, name)

Returns the amount of a resource that can be stored.

  • name — The name of the resource.

Returns: a low-precision decimal

Link to this function names(this)

A list of resource names that can be stored.

Returns: [str, ...], where str is a string

Link to this function set_enabled(this, value)

Whether use of all the resources are enabled.

This is true if all of the resources are enabled. If any of the resources are not enabled, this is false.

Returns: :ok

Link to this function with_resource(this, name)

All the individual resources with the given name that can be stored.

Returns: [resource, ...], where resource is a reference to a SpaceEx.SpaceCenter.Resource object