Struct CodeletInstance

pub struct CodeletInstance<C: Codelet> {
    pub id: Option<NodeId>,
    pub crumbs: Option<SharedNodeCrumbs>,
    pub name: String,
    pub state: C,
    pub config: C::Config,
    pub config_aux: <C::Config as Config>::Aux,
    pub rx: C::Rx,
    pub tx: C::Tx,
    /* private fields */
}

Named instance of a codelet with configuration and channel bundels

Fields

id: Option<NodeId>

crumbs: Option<SharedNodeCrumbs>

name: String

state: C

config: C::Config

config_aux: <C::Config as Config>::Aux

rx: C::Rx

tx: C::Tx

Implementations

impl<C: Codelet> CodeletInstance<C>

pub fn type_name(&self) -> &str

pub fn modify_state_with<F>(self, f: F) -> Self

where F: Fn(&mut C),

pub fn start(&mut self) -> Result<C::Status>

pub fn stop(&mut self) -> Result<C::Status>

pub fn step(&mut self) -> Result<C::Status>

pub fn pause(&mut self) -> Result<C::Status>

pub fn resume(&mut self) -> Result<C::Status>

Trait Implementations

impl<C: Codelet> Drop for CodeletInstance<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: Codelet> Lifecycle for CodeletInstance<C>

fn cycle(&mut self, transition: Transition) -> Result<DefaultStatus>

Applies a lifecycel change

impl<C: Codelet + 'static> Schedulable for CodeletInstance<C>

fn schedule(self, sched: &mut ScheduleBuilder)

impl<C: Codelet + 'static> Sequenceable for CodeletInstance<C>

fn append(self, seq: &mut Sequence)

fn into_sequence(self) -> Sequence

where Self: Sized,

impl<C: Codelet> ViseTrait for CodeletInstance<C>

fn id(&self) -> NodeId

Unique nodelet ID assigned by the runtime

fn name(&self) -> &str

Nodelet name assignd by the user

fn type_name(&self) -> &str

The type name of the codelet as given by Rust compiler

fn rx_names(&self) -> Vec<&str>

fn tx_names(&self) -> Vec<&str>

fn signal_names(&self) -> Vec<&str>

fn status(&self) -> Option<(String, DefaultStatus)>

👎Deprecated

Gets the status as a string and the corresponding simplified status

fn setup(&mut self, setup: NodeletSetup)

Called once at the beginning to setup the clock

fn get_parameters_with_properties( &self, ) -> ParameterWithPropertiesSet<(), &'static str>

Get all configuration parameters and their properties

fn configure( &mut self, key: &str, value: &ParameterValue, ) -> Result<(), ViseConfigureError>

Change a configuration parameter