pub struct CuJointPrm<const N: usize, const M: usize = N> { /* private fields */ }Expand description
Probabilistic roadmap planner (single query per job).
Built with CuJointPlanner::new from robot models and CuJointPrmParams;
runs in CuJointPrmTask.
Implementations§
Source§impl<const N: usize, const M: usize> CuJointPrm<N, M>
impl<const N: usize, const M: usize> CuJointPrm<N, M>
Sourcepub const fn params(&self) -> &CuJointPrmParams
pub const fn params(&self) -> &CuJointPrmParams
The validated planner parameters.
Sourcepub const fn roadmap_size(&self) -> usize
pub const fn roadmap_size(&self) -> usize
Roadmap size of the current job.
Trait Implementations§
Source§impl<const N: usize, const M: usize> CuJointPlanner<N, M> for CuJointPrm<N, M>
impl<const N: usize, const M: usize> CuJointPlanner<N, M> for CuJointPrm<N, M>
Source§const KIND: CuPlannerKind = CuPlannerKind::Sampling
const KIND: CuPlannerKind = CuPlannerKind::Sampling
Exploration family, for diagnostics and documentation.
Source§type Params = CuJointPrmParams
type Params = CuJointPrmParams
The planner’s parameter struct: the
params block of the planner
task’s node config (serde(default, deny_unknown_fields)).Source§fn new(
chain: CuKinematicChain<N>,
collision_model: CuRobotCollisionModel<N, M>,
params: CuJointPrmParams,
) -> CuResult<Self>
fn new( chain: CuKinematicChain<N>, collision_model: CuRobotCollisionModel<N, M>, params: CuJointPrmParams, ) -> CuResult<Self>
Builds the planner for explicit robot models, validating
params.Source§fn begin(
&mut self,
request: &CuJointPlanRequest<N>,
seed: u64,
) -> CuResult<CuPlanStatus>
fn begin( &mut self, request: &CuJointPlanRequest<N>, seed: u64, ) -> CuResult<CuPlanStatus>
Starts a new job for
request, discarding the previous one.Source§fn step(&mut self, budget: u32) -> CuResult<CuPlanStatus>
fn step(&mut self, budget: u32) -> CuResult<CuPlanStatus>
Runs one bounded quantum of at most
budget work units.Source§fn write_best(&self, out: &mut CuJointPlanPath<N>) -> CuPlanStatus
fn write_best(&self, out: &mut CuJointPlanPath<N>) -> CuPlanStatus
Writes the best path so far into
out (waypoints, length, cost,
effort, scene revision, exclusions) and returns the job status. out
holds no waypoints unless the status has a path.Source§const DEFAULT_BUDGETS: (u32, u32) = _
const DEFAULT_BUDGETS: (u32, u32) = _
Default
(base_budget, refine_budget) work units of
CuJointPlannerTask when the node config leaves them out.Auto Trait Implementations§
impl<const N: usize, const M: usize> Freeze for CuJointPrm<N, M>
impl<const N: usize, const M: usize> RefUnwindSafe for CuJointPrm<N, M>
impl<const N: usize, const M: usize> Send for CuJointPrm<N, M>
impl<const N: usize, const M: usize> Sync for CuJointPrm<N, M>
impl<const N: usize, const M: usize> Unpin for CuJointPrm<N, M>
impl<const N: usize, const M: usize> UnsafeUnpin for CuJointPrm<N, M>
impl<const N: usize, const M: usize> UnwindSafe for CuJointPrm<N, M>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T> GetTypeRegistration for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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