Skip to main content

CuJointPlannerParams

Struct CuJointPlannerParams 

Source
pub struct CuJointPlannerParams<P, const N: usize, const M: usize = N> {
    pub chain: Option<CuChainSpec<N>>,
    pub collision_model: Option<CuCollisionModelSpec<M>>,
    pub params: P,
    pub base_budget: Option<u32>,
    pub refine_budget: Option<u32>,
}
Expand description

Node config of CuJointPlannerTask (and every CuJoint<Planner>Task alias): robot models, the planner’s own parameters, and work budgets.

P is the planner’s CuJointPlanner::Params.

// CuJointRrtStarTask<6> (repose-joint-rrt-star)
config: {
    "chain": "igus_rebel",            // or {"joints": [...]}
    "collision_model": "igus_rebel",  // or {"shapes": [...], "safety_margin": 0.005}
    "params": {"step_size": 0.3, "max_nodes": 200}, // planner params; omit = defaults
    "base_budget": 64,                // optional; default CuJointPlanner::DEFAULT_BUDGETS
    "refine_budget": 32,              // optional
}

Fields§

§chain: Option<CuChainSpec<N>>

Required robot chain: a preset name ("igus_rebel") or an inline chain.

§collision_model: Option<CuCollisionModelSpec<M>>

Required collision model: a preset name ("igus_rebel") or an inline model.

§params: P

The planner’s parameters (validated by CuJointPlanner::new).

§base_budget: Option<u32>

Work units of base(); None uses the planner’s default.

§refine_budget: Option<u32>

Work units of each refine(); None uses the planner’s default.

Implementations§

Source§

impl<P, const N: usize, const M: usize> CuJointPlannerParams<P, N, M>

Source

pub fn validate(&self) -> CuResult<()>

Checks that the chain and collision model are present and valid and that explicit budgets are positive. Planner parameters are validated by CuJointPlanner::new.

Trait Implementations§

Source§

impl<P: Clone, const N: usize, const M: usize> Clone for CuJointPlannerParams<P, N, M>

Source§

fn clone(&self) -> CuJointPlannerParams<P, N, M>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<P: Debug, const N: usize, const M: usize> Debug for CuJointPlannerParams<P, N, M>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<P: Default, const N: usize, const M: usize> Default for CuJointPlannerParams<P, N, M>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de, P, const N: usize, const M: usize> Deserialize<'de> for CuJointPlannerParams<P, N, M>
where P: Deserialize<'de> + Default,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<P, const N: usize, const M: usize> Serialize for CuJointPlannerParams<P, N, M>
where P: Serialize,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<P, const N: usize, const M: usize> Freeze for CuJointPlannerParams<P, N, M>
where P: Freeze,

§

impl<P, const N: usize, const M: usize> RefUnwindSafe for CuJointPlannerParams<P, N, M>
where P: RefUnwindSafe,

§

impl<P, const N: usize, const M: usize> Send for CuJointPlannerParams<P, N, M>
where P: Send,

§

impl<P, const N: usize, const M: usize> Sync for CuJointPlannerParams<P, N, M>
where P: Sync,

§

impl<P, const N: usize, const M: usize> Unpin for CuJointPlannerParams<P, N, M>
where P: Unpin,

§

impl<P, const N: usize, const M: usize> UnsafeUnpin for CuJointPlannerParams<P, N, M>
where P: UnsafeUnpin,

§

impl<P, const N: usize, const M: usize> UnwindSafe for CuJointPlannerParams<P, N, M>
where P: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> GetTypeRegistration for T

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PayloadDefaultHandlePolicyApply for T
where T: ?Sized,

§

fn apply_handle_content_policy(&self, _mode: HandleContent)

§

impl<T> PayloadDefaultLoggingPolicy for T
where T: ?Sized,

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> Reflect for T
where T: 'static,

§

impl<T> ReflectTypePath for T

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V