Struct biodivine_sketchbook::sketchbook::properties::dynamic_props::DynProperty

pub struct DynProperty {
    name: String,
    annotation: String,
    variant: DynPropertyType,
}

A typesafe representation wrapping various kinds of dynamic properties. Each property has a name and field variant encompassing inner data.

The formula that will be internally created (usually, apart from generic variant) depends on particular type of the property - there are multiple variants of properties, each carrying its own different metadata that are later used to build the formula.

Fields

name: String

annotation: String

variant: DynPropertyType

Implementations

impl DynProperty

Creating dynamic properties.

fn new_raw( name: &str, variant: DynPropertyType, annotation: &str, ) -> DynProperty

(internal) Shorthand to create a property given its already created internal DynPropertyType data, name, and annotation.

pub fn try_mk_generic( name: &str, raw_formula: &str, annotation: &str, ) -> Result<DynProperty, String>

Create “generic” DynProperty instance directly from a formula, which must be in a correct format (which is verified).

pub fn mk_fixed_point( name: &str, dataset: Option<DatasetId>, observation: Option<ObservationId>, annotation: &str, ) -> DynProperty

Create DynProperty instance describing existence of a fixed point corresponding to a given observation.

pub fn mk_trap_space( name: &str, dataset: Option<DatasetId>, observation: Option<ObservationId>, minimal: bool, nonpercolable: bool, annotation: &str, ) -> DynProperty

Create DynProperty instance describing existence of a trap space corresponding to a given observation. Optionally, the trap space might be required to be minimal or non-percolable.

pub fn mk_trajectory( name: &str, dataset: Option<DatasetId>, annotation: &str, ) -> DynProperty

Create DynProperty instance describing existence of a trajectory corresponding to observations from a given observation (in the given order).

pub fn try_mk_attractor_count( name: &str, minimal: usize, maximal: usize, annotation: &str, ) -> Result<DynProperty, String>

Create DynProperty instance describing the number of existing attractors.

pub fn mk_has_attractor( name: &str, dataset: Option<DatasetId>, observation: Option<ObservationId>, annotation: &str, ) -> DynProperty

Create DynProperty instance describing the existence of an attractor corresponding to a corresponding dataset, or some specific observation in it.

pub fn default(variant: SimpleDynPropertyType) -> DynProperty

Create default DynProperty instance of specified variant.

pub fn default_generic() -> DynProperty

Create default “generic” DynProperty instance, representing “true” formula.

pub fn default_fixed_point() -> DynProperty

Create default DynProperty instance for the existence of a fixed point, with empty dataset and observation fields.

pub fn default_trap_space() -> DynProperty

Create default DynProperty instance for the existence of a trap space, with empty dataset and observation fields, and all flags set to false.

pub fn default_trajectory() -> DynProperty

Create default DynProperty instance for the existence of a trajectory, with an empty datasetfield.

pub fn default_attractor_count() -> DynProperty

Create default DynProperty instance for the number of existing attractors, with default count being 1.

pub fn default_has_attractor() -> DynProperty

Create default DynProperty instance for the existence of an attractor with empty dataset and observation fields.

impl DynProperty

Editing dynamic properties.

pub fn set_name(&mut self, new_name: &str) -> Result<(), String>

Update property’s name.

pub fn set_annotation(&mut self, annotation: &str)

Set property’s annotation string.

pub fn set_dataset(&mut self, new_dataset: DatasetId) -> Result<(), String>

Update property’s sub-field dataset where applicable. If not applicable, return Err.

pub fn set_observation(&mut self, new_obs: ObservationId) -> Result<(), String>

Update property’s sub-field observation where applicable. If not applicable, return Err.

pub fn set_formula(&mut self, new_formula: &str) -> Result<(), String>

Update generic property’s formula. If not applicable (different variant), return Err.

pub fn remove_observation(&mut self) -> Result<(), String>

Update property’s sub-field observation to None where applicable. If not applicable, return Err.

pub fn set_attr_count( &mut self, minimal: usize, maximal: usize, ) -> Result<(), String>

Update property’s sub-fields, if the property is of AttractorCount variant. If not applicable, return Err.

pub fn set_trap_space_details( &mut self, is_minimal: bool, nonpercolable: bool, ) -> Result<(), String>

Update property’s sub-fields, if the property is of ExistsTrapSpace variant. If not applicable, return Err.

impl DynProperty

Observing dynamic properties.

pub fn get_name(&self) -> &str

Get property’s name.

pub fn get_annotation(&self) -> &str

Get annotation string.

pub fn get_prop_data(&self) -> &DynPropertyType

Get property’s variant with all the underlying data.

pub fn assert_dataset_filled(&self) -> Result<(), String>

Check that the property has all required fields filled out. That is just the dataset in most cases at the moment. If some of the required field is set to None, return error.

Trait Implementations

impl Clone for DynProperty

fn clone(&self) -> DynProperty

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DynProperty

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DynProperty

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for DynProperty

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DynProperty

fn eq(&self, other: &DynProperty) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DynProperty

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DynProperty

impl StructuralPartialEq for DynProperty