Struct swarm_it::Carrier

pub struct Carrier<T: PartialEq + Eq + Hash + Copy> { /* fields omitted */ }

Represnets the Carrier object. Carrier is an entity that moves from slot to slot and transfers payload in order to reach the desired layout.

Methods

impl<T: PartialEq + Eq + Hash + Copy> Carrier<T>

pub fn new(x: f64, y: f64) -> Carrier<T>

Creates new Carrier at the position specified

Example

let carrier = swarm_it::Carrier::<char>::new(100.0, 100.0);

pub fn get_payload(&self) -> Option<Payload<T>>

Returns current payload of the carrier

Example

let carrier = swarm_it::Carrier::<char>::new(100.0, 100.0);
let payload = carrier.get_payload();
assert_eq!(payload, None);

pub fn get_target(&self) -> Option<usize>

Returns index of the slot that carriers is going to

Example

let carrier = swarm_it::Carrier::<char>::new(100.0, 100.0);
let target = carrier.get_target();
assert_eq!(target, None)

pub fn get_reserved_target(&self) -> Option<usize>

Returns index of the slot that is reserverd as a target for the cargo that the carrier is going to pick-up or is currently transferring.

Example

let carrier = swarm_it::Carrier::<char>::new(100.0, 100.0);
let target = carrier.get_reserved_target();
assert_eq!(target, None)

pub fn get_position(&self) -> &Position

Returns current carrier position

Example

let x = 100.0;
let y = 200.0;
let carrier = swarm_it::Carrier::<char>::new(x, y);
let position = carrier.get_position();
approx::assert_abs_diff_eq!(position.x, x);
approx::assert_abs_diff_eq!(position.y, y);

pub fn get_angle(&self) -> f64

Returns current carrier angle.

Direction	Angle
Right	0 / 2*π
Down	π/2
Left	π
Up	³/₂*π

Example

let carrier = swarm_it::Carrier::<char>::new(100.0, 100.0);
approx::assert_abs_diff_eq!(carrier.get_angle(), 0.0);

pub fn get_state(&self) -> State

Returns current carrier state

Example

let carrier = swarm_it::Carrier::<char>::new(100.0, 100.0);
assert_eq!(carrier.get_state(), swarm_it::State::IDLE);

pub fn set_acceleration(&mut self, acceleration: f64)

Sets carrier acceleration. This doesn't affect the current movement of a carrier, since this is controlled by the engine. It sets the carrier's ability to accelerate.

Example

let mut carrier = swarm_it::Carrier::<char>::new(100.0, 100.0);
carrier.set_acceleration(2.71);
approx::assert_abs_diff_eq!(carrier.get_acceleration(), 2.71);

pub fn get_acceleration(&self) -> f64

Gets carrier acceleration. This doesn't return the current acceleration, but the number that defines the carrier's ability to accelerate.

Example

let mut carrier = swarm_it::Carrier::<char>::new(100.0, 100.0);
carrier.set_acceleration(2.71);
approx::assert_abs_diff_eq!(carrier.get_acceleration(), 2.71);

pub fn set_max_speed(&mut self, max_speed: f64)

Sets maximum speed of a carrier.

Example

let mut carrier = swarm_it::Carrier::<char>::new(100.0, 100.0);
carrier.set_max_speed(3.01);
approx::assert_abs_diff_eq!(carrier.get_max_speed(), 3.01);

pub fn get_max_speed(&self) -> f64

Returns maximum speed of a carrier.

Example

let mut carrier = swarm_it::Carrier::<char>::new(100.0, 100.0);
carrier.set_max_speed(3.01);
approx::assert_abs_diff_eq!(carrier.get_max_speed(), 3.01);

Trait Implementations

impl<T: Clone + PartialEq + Eq + Hash + Copy> Clone for Carrier<T>

fn clone(&self) -> Carrier<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy + PartialEq + Eq + Hash> Copy for Carrier<T>