pub struct CapeArrayBooleanOutFromProvider {
interface: ICapeArrayBoolean,
interface_ptr: *mut ICapeArrayBoolean,
}Expand description
CapeArrayBooleanOutFromProvider
When calling a CAPE-OPEN method that takes a CapeArrayBoolean as output,
the caller provides an object that implements CapeArrayBooleanProviderOut,
for example CapeArrayBooleanVec.
The CapeArrayBooleanOutFromProvider returns an C::ICapeArrayBoolean interface, which
has a small life span, enough to make sure that the pointer to this
interface is valid. This is done inside wrapper classes such as
capeopen_1_2::CapeArrayBooleanParameter.
When implementing a function that gets called, and takes a CapeArrayBoolean
as output, it received a &mut CapeArrayBooleanOut typed argument, which is
constructed from the reference to an C::ICapeArrayBoolean interface pointer.
Typically a function call receives the C::ICapeArrayBoolean interface
from the caller, and from this, the CapeArrayBooleanOut is constructed by
the cape_object_implementation macro.
In the rare case that one wants to call an internal CAPE-OPEN function
directly, one needs to provide the class that implements the
CapeArrayBooleanProviderOut trait, allocate the pointer, point to it, and
construct the CapeArrayBooleanOut object from a reference to that pointer.
The CapeArrayBooleanOutFromProvider class does all this.
§Example
use cobia::*;
let mut array = CapeArrayBooleanVec::new();
fn SetArrayOut(array:&mut CapeArrayBooleanOut) {
array.put_array(&[true as cobia::CapeBoolean,false as cobia::CapeBoolean,true as cobia::CapeBoolean]);
}
SetArrayOut(&mut CapeArrayBooleanOutFromProvider::from(&mut array).as_cape_array_boolean_out()); //this is how array is passed as &mut CapeArrayBooleanOut argument
assert_eq!(array.as_vec(),&vec![true as cobia::CapeBoolean,false as cobia::CapeBoolean,true as cobia::CapeBoolean]);Fields§
§interface: ICapeArrayBoolean§interface_ptr: *mut ICapeArrayBoolean