Struct cameleon::genapi::ParamsCtxt

pub struct ParamsCtxt<Ctrl, Ctxt> {
    pub ctrl: Ctrl,
    pub ctxt: Ctxt,
}

Manages context of parameters of the device.

Examples

// Loads `GenApi` context.
camera.load_context().unwrap();

let mut params_ctxt = camera.params_ctxt().unwrap();
// Get `Gain` node of `GenApi`.
// `GenApi SFNC` defines that `Gain` node should have `IFloat` interface,
// so this conversion would be success if the camera follows that.
// Some vendors may define `Gain` node as `IInteger`, in that case, use
// `as_integer(&params_ctxt)` instead of `as_float(&params_ctxt).
let gain_node = params_ctxt.node("Gain").unwrap().as_float(&params_ctxt).unwrap();

// Get the current value of `Gain`.
if gain_node.is_readable(&mut params_ctxt).unwrap() {
    let value = gain_node.value(&mut params_ctxt).unwrap();
    println!("{}", value);
}

// Set `0.1` to `Gain`.
if gain_node.is_writable(&mut params_ctxt).unwrap() {
    gain_node.set_value(&mut params_ctxt, 0.1).unwrap();
}

Fields

ctrl: Ctrl

Control handle of the device.

ctxt: Ctxt

GenApi context of the device.

Implementations

impl<Ctrl, Ctxt> ParamsCtxt<Ctrl, Ctxt>where Ctxt: GenApiCtxt,

pub fn node(&self, name: &str) -> Option<Node>

Returns None if there is node node with the given name in the context.

pub fn node_store(&self) -> &Ctxt::NS

Returns NodeStore in the context.

impl<Ctrl, Ctxt> ParamsCtxt<Ctrl, Ctxt>where Ctrl: DeviceControl, Ctxt: GenApiCtxt,

pub fn enter<F, R>(&mut self, f: F) -> Rwhere F: FnOnce(&mut Ctrl, &mut Ctxt) -> R,

Enters the context.

pub fn enter2<F, R>(&mut self, f: F) -> Rwhere F: FnOnce(&mut Ctrl, &Ctxt::NS, &mut ValueCtxt<Ctxt::VS, Ctxt::CS>) -> R,

Enters the context and then enters GenApiCtxt.

impl<Ctrl, Ctxt> ParamsCtxt<Ctrl, Ctxt>

pub fn convert_from<Ctrl2, Ctxt2>(from: ParamsCtxt<Ctrl2, Ctxt2>) -> Selfwhere Ctrl: From<Ctrl2>, Ctxt: From<Ctxt2>,

Converts internal types. This method work same as std::convert::From, just hack to avoid E0119.

pub fn convert_into<Ctrl2, Ctxt2>(self) -> ParamsCtxt<Ctrl2, Ctxt2>where Ctrl: Into<Ctrl2>, Ctxt: Into<Ctxt2>,

Converts internal types. This method work same as std::convert::Into, just hack to avoid E0119.

Trait Implementations

impl<Ctrl: Clone, Ctxt: Clone> Clone for ParamsCtxt<Ctrl, Ctxt>

fn clone(&self) -> ParamsCtxt<Ctrl, Ctxt>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Ctrl: Debug, Ctxt: Debug> Debug for ParamsCtxt<Ctrl, Ctxt>

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

Formats the value using the given formatter.