Struct CapeArrayRealScalar

pub struct CapeArrayRealScalar {
    value: CapeReal,
}

Scalar based CapeArrayRealOut implementation

ICapeArrayReal is passed as data container between CAPE-OPEN functions. It is up to the caller to provide the interface, and its implementation. This class provides a default impementation using a scalar CapeReal.

This class can be used as input and output argument. However, it should only be used as an output argument in case a scalar value is expected, such as for getting the density from a material object, as any attempt to resize the content to anything else but 1 will result in an error.

Examples

use cobia::*;

fn set_content(a: &mut CapeArrayRealOut) {
	a.resize(1);
	a[0]=2.5;
}
 
let mut arr = cobia::CapeArrayRealScalar::new();
set_content(&mut CapeArrayRealOutFromProvider::from(&mut arr).as_cape_array_real_out());
assert_eq!(arr.value(), 2.5);

Fields

value: CapeReal

Implementations

impl CapeArrayRealScalar

const VTABLE: ICapeArrayReal_VTable

Interface v-table

pub fn new() -> Self

Create a new CapeArrayRealScalar

Creates a new empty CapeArrayRealScalar

Examples

use cobia;
let arr = cobia::CapeArrayRealScalar::new();
assert!(cobia::CapeReal::is_nan(arr.value()));

pub fn from(value: CapeReal) -> Self

Create a new CapeArrayRealScalar with initial value

Creates a new empty CapeArrayRealScalar and sets the value

Arguments

• value - The initial value

Examples

use cobia;
let arr = cobia::CapeArrayRealScalar::from(3.14);
assert_eq!(arr.value(),3.14);

pub fn value(&self) -> CapeReal

Return value

Returns the value.

Example

use cobia;
let arr = cobia::CapeArrayRealScalar::from(10.0);
assert_eq!(arr.value(),10.0);

pub fn set(&mut self, value: CapeReal)

Set the value

Sets the value

Arguments

• value - The value to be set

Example

use cobia;
let mut arr = cobia::CapeArrayRealScalar::from(10.0);
arr.set(11.0);
assert_eq!(arr.value(),11.0);

extern "C" fn get( me: *mut c_void, data: *mut *mut CapeReal, size: *mut CapeSize, )

Interface member function

extern "C" fn setsize( me: *mut c_void, size: CapeSize, data: *mut *mut CapeReal, ) -> CapeResult

Interface member function

Trait Implementations

impl AsMut<f64> for CapeArrayRealScalar

fn as_mut(&mut self) -> &mut CapeReal

Return mutable reference to the scalar value

Returns a mutable reference to the scalar value.

Example

use cobia;
let mut arr = cobia::CapeArrayRealScalar::from(10.0);
*arr.as_mut()=11.0;
assert_eq!(arr.value(),11.0);

impl CapeArrayRealProviderIn for CapeArrayRealScalar

fn as_cape_array_real_in(&self) -> ICapeArrayReal

Convert to ICapeArrayReal

Returns a reference to the ICapeArrayReal interface.

Examples

use cobia::*;

fn test_content(a: &CapeArrayRealIn) {
    assert_eq!(a[0], 0.0);
}
 
let arr = cobia::CapeArrayRealScalar::from(0.0);
test_content(&CapeArrayRealInFromProvider::from(&arr).as_cape_array_real_in());

impl CapeArrayRealProviderOut for CapeArrayRealScalar

fn as_cape_array_real_out(&mut self) -> ICapeArrayReal

Convert to ICapeArrayReal

Returns a mutable reference to the ICapeArrayReal interface.

Examples

use cobia::*;

fn set_content(a: &mut CapeArrayRealOut) {
	a.resize(1);
	a[0]=2.5;
}
 
let mut arr = cobia::CapeArrayRealScalar::new();
set_content(&mut CapeArrayRealOutFromProvider::from(&mut arr).as_cape_array_real_out());
assert_eq!(arr.value(), 2.5);

impl Clone for CapeArrayRealScalar

fn clone(&self) -> CapeArrayRealScalar

Returns a duplicate of the value.

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

Performs copy-assignment from source.