Struct MaterialPort

pub struct MaterialPort {
    name: CapeStringImpl,
    description: CapeStringImpl,
    connected_object: Option<CapeThermoMaterial>,
    is_inlet: bool,
    shared_unit_data: Rc<RefCell<SharedUnitData>>,
    cobia_object_data: MaterialPortCobiaObjectData,
}

The MaterialPort class implements a CAPE-OPEN 1.2 material port.

It connects to a valid CAPE-OPEN 1.2 compliant material object provided by the PME.

Fields

name: CapeStringImpl

The name of the port

description: CapeStringImpl

The description of the port

connected_object: Option<CapeThermoMaterial>

The connected material object, if any

is_inlet: bool

Indicates whether this port is an inlet (true) or an outlet (false)

shared_unit_data: Rc<RefCell<SharedUnitData>>

Shared data for the unit, containing unit-specific information

cobia_object_data: MaterialPortCobiaObjectData

Cobia object data for this object, which contains generated code to provide the native COBIA interfaces

Implementations

impl MaterialPort

fn create_instance( _material_port_boxed_ptr: *mut *mut ICapeInterface, name: CapeStringImpl, description: CapeStringImpl, is_inlet: bool, shared_unit_data: Rc<RefCell<SharedUnitData>>, ) -> CapeResult

pub(crate) fn create<T: CapeSmartPointer>( name: CapeStringImpl, description: CapeStringImpl, is_inlet: bool, shared_unit_data: Rc<RefCell<SharedUnitData>>, ) -> T

Create a new instance of the object and return a smart pointer to it

This function panics if the created object does not implement the interface corresponding to the smart pointer to be returned. For a non-panic version, use the try_create() function.

pub(crate) fn try_create<T: CapeSmartPointer>( name: CapeStringImpl, description: CapeStringImpl, is_inlet: bool, shared_unit_data: Rc<RefCell<SharedUnitData>>, ) -> Result<T, COBIAError>

Create a new instance of the object and return a smart pointer to it

This function returns an error if the created object does not implement the interface corresponding to the smart pointer to be returned.

pub(crate) unsafe fn borrow<T: CapeSmartPointer>(smart_pointer: &T) -> &Self

Get a reference to the object

Note that as the reference is created from a smart pointer, the reference is valid only as long as the smart pointer is valid. The reference is not checked for multiple borrows

Safety

The user must ensure that the smart pointer contains a valid object, and that the object is of the type that is being borrowed. It is not possible for the compiler to check this, as the borrow is done through the native object pointer in the interface.

pub(crate) unsafe fn borrow_mut<T: CapeSmartPointer>( smart_pointer: &mut T, ) -> &mut Self

Get a mutable reference to the object

Note that as the reference is created from a smart pointer, the reference is valid only as long as the smart pointer is valid. The reference is not checked for multiple borrows

Safety

This function is unsafe because it allows mutable access to the object. Also the user must ensure that the smart pointer contains a valid object, and that the object is of the type that is being borrowed. It is not possible for the compiler to check this, as the borrow is done through the native object pointer in the interface.

impl MaterialPort

pub(crate) fn get_connected_material(&self) -> Option<CapeThermoMaterial>

Get the connected material object, if any.

Returns:

• The connected material object, or None if the port is not connected to any material object.

pub(crate) fn get_name(&self) -> &CapeStringImpl

Get the name of the port.

Returns:

• A reference to the name of the port as a CapeStringImpl.

Trait Implementations

impl Display for MaterialPort

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

Format the MaterialPort as a string for display purposes.

The std::fmt::Display interface is used when generating the source name of the object that raises an error.

Arguments:

• f - A mutable reference to a std::fmt::Formatter where the formatted string will be written.

Returns:

• A std::fmt::Result indicating the success or failure of the formatting operation.

impl ICapeIdentification for MaterialPort

fn get_component_name( &mut self, name: &mut CapeStringOut<'_>, ) -> Result<(), COBIAError>

Get the name of the component.

Arguments:

• name - A mutable reference to a CapeStringOut where the name will be set.

Returns:

• A Result indicating success or failure. If successful, the name is set in name.

fn get_component_description( &mut self, description: &mut CapeStringOut<'_>, ) -> Result<(), COBIAError>

Get the description of the component.

Arguments:

• description - A mutable reference to a CapeStringOut where the description will be set.

Returns:

• A Result indicating success or failure. If successful, the description is set in description.

fn set_component_name( &mut self, _name: &CapeStringIn<'_>, ) -> Result<(), COBIAError>

Set the name of the component.

This method is not allowed for this port implementation and will return an error.

fn set_component_description( &mut self, _desc: &CapeStringIn<'_>, ) -> Result<(), COBIAError>

Set the description of the component.

This method is not allowed for this port implementation and will return an error.

impl ICapeIdentificationImpl for MaterialPort

type T = MaterialPort

fn as_interface_pointer(&mut self) -> *mut ICapeInterface

fn init_interface() -> _ICapeInterface

prepare CAPEOPEN_1_2_ICapeIdentification interface and return as generic ICapeInterface pointer

fn init<Timpl>(u: &mut Timpl)

where Timpl: ICapeIdentificationImpl + ICapeInterfaceImpl,

extern "C" fn raw_get_component_name( me: *mut c_void, name: *mut _ICapeString, ) -> u32

extern "C" fn raw_set_component_name( me: *mut c_void, name: *mut _ICapeString, ) -> u32

extern "C" fn raw_get_component_description( me: *mut c_void, desc: *mut _ICapeString, ) -> u32

extern "C" fn raw_set_component_description( me: *mut c_void, desc: *mut _ICapeString, ) -> u32

const VTABLE: CAPEOPEN_1_2_ICapeIdentification_VTable = _

impl ICapeInterfaceImpl for MaterialPort

type T = MaterialPort

fn get_object_data(&mut self) -> &mut CapeObjectData

Returns a mutable reference to the internal CapeObjectData structure.

fn get_self(&mut self) -> *mut MaterialPort

Returns a pointer to the implementing object.

const CAPEINTERFACE_VTABLE: ICapeInterface_VTable = _

the V-table for the ICapeInterface implementation.

fn init(&mut self) -> *mut _ICapeInterface

Initializes the object, setting up the interface pointer and adding it to the interface map.

fn create_object_data<Timpl>() -> CapeObjectData

where Timpl: ICapeInterfaceImpl,

Utility function for internal object setup

extern "C" fn raw_add_reference(me: *mut c_void)

extern "C" fn raw_release(me: *mut c_void)

extern "C" fn raw_query_interface( me: *mut c_void, uuid: *const _CapeUUID, interface: *mut *mut _ICapeInterface, ) -> u32

extern "C" fn raw_get_last_error( me: *mut c_void, error: *mut *mut _ICapeError, ) -> u32

fn add_interface( &mut self, uuid: *const _CapeUUID, interface: *mut _ICapeInterface, )

Utility function to add an interface to the interface map.

fn set_last_error(&mut self, error: COBIAError, scope: &str) -> u32

Utility function to set the last error and scope.

fn clear_last_error(&mut self)

Utility function to clear the last error and scope.

fn as_icapeinterface(&mut self) -> *mut _ICapeInterface

Returns a unique pointer to the ICapeInterface implementation of the object.

impl ICapeUnitPort for MaterialPort

fn get_port_type(&mut self) -> Result<CapePortType, COBIAError>

Get the port type.

Returns:

• A Result containing the port type, which is always CapeMaterial for this implementation.

fn get_direction(&mut self) -> Result<CapePortDirection, COBIAError>

Get the direction of the port.

Returns:

• A Result containing the port direction, which is either CapeInlet or CapeOutlet.

fn get_connected_object(&mut self) -> Result<CapeObject, COBIAError>

Get the connected object of the port.

Returns:

• A Result containing the connected CapeObject, or an error if the port is not connected.

fn connect(&mut self, object_to_connect: CapeObject) -> Result<(), COBIAError>

Connect the port to a CapeObject.

This port will only accept connections to a valid CapeThermoMaterial object.

Arguments:

• object_to_connect - The CapeObject to connect to the port.

Returns:

• A Result indicating success or failure. If successful, the port is connected to the material object.

fn disconnect(&mut self) -> Result<(), COBIAError>

Disconnect the port from its connected object.

Returns:

• A Result indicating success or failure; always succeeds.

impl ICapeUnitPortImpl for MaterialPort

type T = MaterialPort

fn as_interface_pointer(&mut self) -> *mut ICapeInterface

fn init_interface() -> _ICapeInterface

prepare CAPEOPEN_1_2_ICapeUnitPort interface and return as generic ICapeInterface pointer

fn init<Timpl>(u: &mut Timpl)

where Timpl: ICapeUnitPortImpl + ICapeInterfaceImpl,

extern "C" fn raw_get_port_type( me: *mut c_void, port_type: *mut i32, ) -> u32

extern "C" fn raw_get_direction( me: *mut c_void, port_direction: *mut i32, ) -> u32

extern "C" fn raw_get_connected_object( me: *mut c_void, connected_object: *mut *mut _ICapeInterface, ) -> u32

extern "C" fn raw_connect( me: *mut c_void, object_to_connect: *mut _ICapeInterface, ) -> u32

extern "C" fn raw_disconnect(me: *mut c_void) -> u32

const VTABLE: CAPEOPEN_1_2_ICapeUnitPort_VTable = _