Struct opcua_server::address_space::variable::VariableBuilder
source · [−]pub struct VariableBuilder { /* private fields */ }
Expand description
A builder for constructing a node of same name. This can be used as an easy way to create a node and the references it has to another node in a simple fashion.
Implementations
sourceimpl VariableBuilder
impl VariableBuilder
sourcepub fn new<T, S>(node_id: &NodeId, browse_name: T, display_name: S) -> Self where
T: Into<QualifiedName>,
S: Into<LocalizedText>,
pub fn new<T, S>(node_id: &NodeId, browse_name: T, display_name: S) -> Self where
T: Into<QualifiedName>,
S: Into<LocalizedText>,
Creates a builder for a node. All nodes are required to su
pub fn get_node_id(&self) -> NodeId
sourcepub fn is_valid(&self) -> bool
pub fn is_valid(&self) -> bool
Tests that the builder is in a valid state to build or insert the node.
sourcepub fn description<V>(self, description: V) -> Self where
V: Into<LocalizedText>,
pub fn description<V>(self, description: V) -> Self where
V: Into<LocalizedText>,
Sets the description of the node
sourcepub fn reference<T>(
self,
node_id: T,
reference_type_id: ReferenceTypeId,
reference_direction: ReferenceDirection
) -> Self where
T: Into<NodeId>,
pub fn reference<T>(
self,
node_id: T,
reference_type_id: ReferenceTypeId,
reference_direction: ReferenceDirection
) -> Self where
T: Into<NodeId>,
Adds a reference to the node
sourcepub fn organizes<T>(self, organizes_id: T) -> Self where
T: Into<NodeId>,
pub fn organizes<T>(self, organizes_id: T) -> Self where
T: Into<NodeId>,
Indicates this node organizes another node by its id.
sourcepub fn organized_by<T>(self, organized_by_id: T) -> Self where
T: Into<NodeId>,
pub fn organized_by<T>(self, organized_by_id: T) -> Self where
T: Into<NodeId>,
Indicates this node is organised by another node by its id
sourcepub fn build(self) -> Variable
pub fn build(self) -> Variable
Yields a built node. This function will panic if the node is invalid. Note that calling this function discards any references for the node, so there is no purpose in adding references if you intend to call this method.
sourcepub fn insert(self, address_space: &mut AddressSpace) -> bool
pub fn insert(self, address_space: &mut AddressSpace) -> bool
Inserts the node into the address space, including references. This function will panic if the node is in an invalid state.
sourceimpl VariableBuilder
impl VariableBuilder
pub fn component_of<T>(self, component_of_id: T) -> Self where
T: Into<NodeId>,
pub fn has_component<T>(self, has_component_id: T) -> Self where
T: Into<NodeId>,
sourceimpl VariableBuilder
impl VariableBuilder
pub fn has_property<T>(self, has_component_id: T) -> Self where
T: Into<NodeId>,
pub fn property_of<T>(self, component_of_id: T) -> Self where
T: Into<NodeId>,
sourceimpl VariableBuilder
impl VariableBuilder
sourcepub fn value<V>(self, value: V) -> Self where
V: Into<Variant>,
pub fn value<V>(self, value: V) -> Self where
V: Into<Variant>,
Sets the value of the variable.
sourcepub fn data_type<T>(self, data_type: T) -> Self where
T: Into<NodeId>,
pub fn data_type<T>(self, data_type: T) -> Self where
T: Into<NodeId>,
Sets the data type of the variable.
sourcepub fn historizing(self, historizing: bool) -> Self
pub fn historizing(self, historizing: bool) -> Self
Sets the historizing flag for the variable.
sourcepub fn access_level(self, access_level: AccessLevel) -> Self
pub fn access_level(self, access_level: AccessLevel) -> Self
Sets the access level for the variable.
sourcepub fn user_access_level(self, user_access_level: UserAccessLevel) -> Self
pub fn user_access_level(self, user_access_level: UserAccessLevel) -> Self
Sets the user access level for the variable.
sourcepub fn value_rank(self, value_rank: i32) -> Self
pub fn value_rank(self, value_rank: i32) -> Self
Sets the value rank for the variable.
sourcepub fn array_dimensions(self, array_dimensions: &[u32]) -> Self
pub fn array_dimensions(self, array_dimensions: &[u32]) -> Self
Sets the array dimensions for the variable.
sourcepub fn history_readable(self) -> Self
pub fn history_readable(self) -> Self
Makes the variable history-readable
sourcepub fn history_updatable(self) -> Self
pub fn history_updatable(self) -> Self
Makes the variable history-updateable
sourcepub fn minimum_sampling_interval(self, minimum_sampling_interval: f64) -> Self
pub fn minimum_sampling_interval(self, minimum_sampling_interval: f64) -> Self
Sets the minimum sampling interval for the variable.
sourcepub fn value_getter(
self,
getter: Arc<Mutex<dyn AttributeGetter + Send>>
) -> Self
pub fn value_getter(
self,
getter: Arc<Mutex<dyn AttributeGetter + Send>>
) -> Self
Sets a value getter function for the variable. Whenever the value of a variable needs to be fetched (e.g. from a monitored item subscription), this trait will be called to get the value.
sourcepub fn value_setter(
self,
setter: Arc<Mutex<dyn AttributeSetter + Send>>
) -> Self
pub fn value_setter(
self,
setter: Arc<Mutex<dyn AttributeSetter + Send>>
) -> Self
Sets a value setter function for the variable. Whenever the value of a variable is set via a service, this trait will be called to set the value. It is up to the implementation to decide what to do if that happens.
sourcepub fn has_type_definition<T>(self, type_id: T) -> Self where
T: Into<NodeId>,
pub fn has_type_definition<T>(self, type_id: T) -> Self where
T: Into<NodeId>,
Add a reference to the variable indicating it has a type of another node.
sourcepub fn has_modelling_rule<T>(self, type_id: T) -> Self where
T: Into<NodeId>,
pub fn has_modelling_rule<T>(self, type_id: T) -> Self where
T: Into<NodeId>,
Add a reference to the variable indicating it has a modelling rule of another node.
Auto Trait Implementations
impl RefUnwindSafe for VariableBuilder
impl Send for VariableBuilder
impl Sync for VariableBuilder
impl Unpin for VariableBuilder
impl UnwindSafe for VariableBuilder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more