Struct ReferenceTypeBuilder 

pub struct ReferenceTypeBuilder { /* private fields */ }

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

impl ReferenceTypeBuilder

pub fn new<T, S>( node_id: &NodeId, browse_name: T, display_name: S, ) -> ReferenceTypeBuilder

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

Get the node ID of the node being built.

pub fn is_valid(&self) -> bool

Tests that the builder is in a valid state to build or insert the node.

pub fn description<V>(self, description: V) -> ReferenceTypeBuilder

where V: Into<LocalizedText>,

Sets the description of the node

pub fn reference<T>( self, node_id: T, reference_type_id: ReferenceTypeId, reference_direction: ReferenceDirection, ) -> ReferenceTypeBuilder

where T: Into<NodeId>,

Adds a reference to the node

pub fn organizes<T>(self, organizes_id: T) -> ReferenceTypeBuilder

where T: Into<NodeId>,

Indicates this node organizes another node by its id.

pub fn organized_by<T>(self, organized_by_id: T) -> ReferenceTypeBuilder

where T: Into<NodeId>,

Indicates this node is organised by another node by its id

pub fn build(self) -> ReferenceType

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.

pub fn insert(self, address_space: &mut impl NodeInsertTarget) -> bool

Inserts the node into the address space, including references. This function will panic if the node is in an invalid state.

impl ReferenceTypeBuilder

pub fn subtype_of<T>(self, type_id: T) -> ReferenceTypeBuilder

where T: Into<NodeId>,

Add an inverse HasSubtype reference to the given type.

pub fn has_subtype<T>(self, subtype_id: T) -> ReferenceTypeBuilder

where T: Into<NodeId>,

Add a HasSubtype reference to the given type.

impl ReferenceTypeBuilder

pub fn is_abstract(self, is_abstract: bool) -> ReferenceTypeBuilder

Set the IsAbstract attribute of this reference type, indicating whether references in the instance hierarchy are allowed to use this reference type.

pub fn write_mask(self, write_mask: WriteMask) -> ReferenceTypeBuilder

Set the write mask of this type.

pub fn symmetric(self, symmetric: bool) -> ReferenceTypeBuilder

Set whether references of this type are symmetric, meaning they have the same name in both directions.

pub fn inverse_name( self, inverse_name: impl Into<LocalizedText>, ) -> ReferenceTypeBuilder

Set the inverse name of this reference type.