Struct vf_rs::vf::EconomicEvent

pub struct EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT> { /* fields omitted */ }

An observed economic flow, as opposed to a flow planned to happen in the future. This could reflect a change in the quantity of an economic resource. It is also defined by its behavior in relation to the economic resource (see vf:action)

ID: https://w3id.org/valueflows#EconomicEvent

Implementations

impl<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT> EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>

pub fn action(&self) -> &Action

Defines the kind of flow, such as consume, produce, work, transfer, etc.

pub fn agreed_in(&self) -> &Option<Url>

Reference to an agreement between agents which specifies the rules, terms, policies, calculations, etc. which govern this flow.

pub fn at_location(&self) -> &Option<SpatialThing>

The place where an intent, commitment, or economic event occurs. Usually mappable.

pub fn effort_quantity(&self) -> &Option<Measure>

The amount and unit of the work or use or citation effort-based action. This is often a time duration, but also could be cycle counts or other measures of effort or usefulness.

pub fn has_beginning(&self) -> &Option<DateTime<Utc>>

The planned or actual beginning of a flow or process.

pub fn has_end(&self) -> &Option<DateTime<Utc>>

The planned or actual end of a flow or process.

pub fn has_point_in_time(&self) -> &Option<DateTime<Utc>>

The planned or actual time of a flow; can be used instead of hasBeginning and hasEnd, if so, hasBeginning and hasEnd should be able to be returned with this value.

pub fn image(&self) -> &Option<Url>

The uri to an image relevant to the entity, such as a logo, avatar, photo, diagram, etc.

pub fn in_scope_of(&self) -> &Vec<Url>

Grouping around something to create a boundary or context, used for documenting, accounting, planning.

pub fn input_of(&self) -> &Option<PROCESS>

Relates an input flow to it's process.

pub fn note(&self) -> &Option<String>

pub fn output_of(&self) -> &Option<PROCESS>

Relates an output flow to it's process.

pub fn provider(&self) -> &AGENT

The economic agent from whom the intended, committed, or actual economic event is initiated.

pub fn realization_of(&self) -> &Option<AGREEMENT>

This economic event occurs as part of this agreement.

pub fn receiver(&self) -> &AGENT

The economic agent whom the intended, committed, or actual economic event is for.

pub fn resource_classified_as(&self) -> &Vec<Url>

References a concept in a common taxonomy or other classification scheme for purposes of categorization or grouping.

pub fn resource_conforms_to(&self) -> &Option<RESOURCESPECIFICATION>

The primary resource specification or definition of an existing or potential economic resource. A resource will have only one, as this specifies exactly what the resource is.

pub fn resource_inventoried_as(&self) -> &Option<ECONOMICRESOURCE>

Economic resource involved in the flow.

pub fn resource_quantity(&self) -> &Option<Measure>

The amount and unit of the economic resource counted or inventoried.

pub fn to_resource_inventoried_as(&self) -> &Option<ECONOMICRESOURCE>

Additional economic resource on the economic event when needed by the receiver. Used when a transfer or move, or sometimes other actions, requires explicitly identifying an economic resource on the receiving side.

pub fn triggered_by(&self) -> &Option<ECONOMICEVENT>

References an economic event that implied the claim or event, often based on a prior agreement.

impl<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT> EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>

pub fn set_action(&mut self, val: Action) -> &mut Self

Defines the kind of flow, such as consume, produce, work, transfer, etc.

pub fn set_agreed_in(&mut self, val: Option<Url>) -> &mut Self

Reference to an agreement between agents which specifies the rules, terms, policies, calculations, etc. which govern this flow.

pub fn set_at_location(&mut self, val: Option<SpatialThing>) -> &mut Self

The place where an intent, commitment, or economic event occurs. Usually mappable.

pub fn set_effort_quantity(&mut self, val: Option<Measure>) -> &mut Self

The amount and unit of the work or use or citation effort-based action. This is often a time duration, but also could be cycle counts or other measures of effort or usefulness.

pub fn set_has_beginning(&mut self, val: Option<DateTime<Utc>>) -> &mut Self

The planned or actual beginning of a flow or process.

pub fn set_has_end(&mut self, val: Option<DateTime<Utc>>) -> &mut Self

The planned or actual end of a flow or process.

pub fn set_has_point_in_time(&mut self, val: Option<DateTime<Utc>>) -> &mut Self

The planned or actual time of a flow; can be used instead of hasBeginning and hasEnd, if so, hasBeginning and hasEnd should be able to be returned with this value.

pub fn set_image(&mut self, val: Option<Url>) -> &mut Self

The uri to an image relevant to the entity, such as a logo, avatar, photo, diagram, etc.

pub fn set_in_scope_of(&mut self, val: Vec<Url>) -> &mut Self

Grouping around something to create a boundary or context, used for documenting, accounting, planning.

pub fn set_input_of(&mut self, val: Option<PROCESS>) -> &mut Self

Relates an input flow to it's process.

pub fn set_note(&mut self, val: Option<String>) -> &mut Self

pub fn set_output_of(&mut self, val: Option<PROCESS>) -> &mut Self

Relates an output flow to it's process.

pub fn set_provider(&mut self, val: AGENT) -> &mut Self

The economic agent from whom the intended, committed, or actual economic event is initiated.

pub fn set_realization_of(&mut self, val: Option<AGREEMENT>) -> &mut Self

This economic event occurs as part of this agreement.

pub fn set_receiver(&mut self, val: AGENT) -> &mut Self

The economic agent whom the intended, committed, or actual economic event is for.

pub fn set_resource_classified_as(&mut self, val: Vec<Url>) -> &mut Self

References a concept in a common taxonomy or other classification scheme for purposes of categorization or grouping.

pub fn set_resource_conforms_to(
    &mut self,
    val: Option<RESOURCESPECIFICATION>
) -> &mut Self

The primary resource specification or definition of an existing or potential economic resource. A resource will have only one, as this specifies exactly what the resource is.

pub fn set_resource_inventoried_as(
    &mut self,
    val: Option<ECONOMICRESOURCE>
) -> &mut Self

Economic resource involved in the flow.

pub fn set_resource_quantity(&mut self, val: Option<Measure>) -> &mut Self

The amount and unit of the economic resource counted or inventoried.

pub fn set_to_resource_inventoried_as(
    &mut self,
    val: Option<ECONOMICRESOURCE>
) -> &mut Self

Additional economic resource on the economic event when needed by the receiver. Used when a transfer or move, or sometimes other actions, requires explicitly identifying an economic resource on the receiving side.

pub fn set_triggered_by(&mut self, val: Option<ECONOMICEVENT>) -> &mut Self

References an economic event that implied the claim or event, often based on a prior agreement.

impl<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT> EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>

pub fn action_mut(&mut self) -> &mut Action

Defines the kind of flow, such as consume, produce, work, transfer, etc.

pub fn agreed_in_mut(&mut self) -> &mut Option<Url>

Reference to an agreement between agents which specifies the rules, terms, policies, calculations, etc. which govern this flow.

pub fn at_location_mut(&mut self) -> &mut Option<SpatialThing>

The place where an intent, commitment, or economic event occurs. Usually mappable.

pub fn effort_quantity_mut(&mut self) -> &mut Option<Measure>

The amount and unit of the work or use or citation effort-based action. This is often a time duration, but also could be cycle counts or other measures of effort or usefulness.

pub fn has_beginning_mut(&mut self) -> &mut Option<DateTime<Utc>>

The planned or actual beginning of a flow or process.

pub fn has_end_mut(&mut self) -> &mut Option<DateTime<Utc>>

The planned or actual end of a flow or process.

pub fn has_point_in_time_mut(&mut self) -> &mut Option<DateTime<Utc>>

The planned or actual time of a flow; can be used instead of hasBeginning and hasEnd, if so, hasBeginning and hasEnd should be able to be returned with this value.

pub fn image_mut(&mut self) -> &mut Option<Url>

The uri to an image relevant to the entity, such as a logo, avatar, photo, diagram, etc.

pub fn in_scope_of_mut(&mut self) -> &mut Vec<Url>

Grouping around something to create a boundary or context, used for documenting, accounting, planning.

pub fn input_of_mut(&mut self) -> &mut Option<PROCESS>

Relates an input flow to it's process.

pub fn note_mut(&mut self) -> &mut Option<String>

pub fn output_of_mut(&mut self) -> &mut Option<PROCESS>

Relates an output flow to it's process.

pub fn provider_mut(&mut self) -> &mut AGENT

The economic agent from whom the intended, committed, or actual economic event is initiated.

pub fn realization_of_mut(&mut self) -> &mut Option<AGREEMENT>

This economic event occurs as part of this agreement.

pub fn receiver_mut(&mut self) -> &mut AGENT

The economic agent whom the intended, committed, or actual economic event is for.

pub fn resource_classified_as_mut(&mut self) -> &mut Vec<Url>

References a concept in a common taxonomy or other classification scheme for purposes of categorization or grouping.

pub fn resource_conforms_to_mut(&mut self) -> &mut Option<RESOURCESPECIFICATION>

The primary resource specification or definition of an existing or potential economic resource. A resource will have only one, as this specifies exactly what the resource is.

pub fn resource_inventoried_as_mut(&mut self) -> &mut Option<ECONOMICRESOURCE>

Economic resource involved in the flow.

pub fn resource_quantity_mut(&mut self) -> &mut Option<Measure>

The amount and unit of the economic resource counted or inventoried.

pub fn to_resource_inventoried_as_mut(
    &mut self
) -> &mut Option<ECONOMICRESOURCE>

Additional economic resource on the economic event when needed by the receiver. Used when a transfer or move, or sometimes other actions, requires explicitly identifying an economic resource on the receiving side.

pub fn triggered_by_mut(&mut self) -> &mut Option<ECONOMICEVENT>

References an economic event that implied the claim or event, often based on a prior agreement.

impl<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT> EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>

pub fn builder(
) -> EconomicEventBuilder<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>

Create an empty builder object for EconomicEvent

pub fn into_builder(
    self
) -> EconomicEventBuilder<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>

Turns EconomicEvent into EconomicEventBuilder

Trait Implementations

impl<PROCESS: Clone, AGENT: Clone, AGREEMENT: Clone, RESOURCESPECIFICATION: Clone, ECONOMICRESOURCE: Clone, ECONOMICEVENT: Clone> Clone for EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>

fn clone(
    &self
) -> EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<PROCESS: Debug, AGENT: Debug, AGREEMENT: Debug, RESOURCESPECIFICATION: Debug, ECONOMICRESOURCE: Debug, ECONOMICEVENT: Debug> Debug for EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>

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

Formats the value using the given formatter.

impl<'de, PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT> Deserialize<'de> for EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT> where
    PROCESS: Deserialize<'de>,
    AGENT: Deserialize<'de>,
    AGREEMENT: Deserialize<'de>,
    RESOURCESPECIFICATION: Deserialize<'de>,
    ECONOMICRESOURCE: Deserialize<'de>,
    ECONOMICEVENT: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<PROCESS: PartialEq, AGENT: PartialEq, AGREEMENT: PartialEq, RESOURCESPECIFICATION: PartialEq, ECONOMICRESOURCE: PartialEq, ECONOMICEVENT: PartialEq> PartialEq<EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>> for EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>

fn eq(
    &self,
    other: &EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>
) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(
    &self,
    other: &EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>
) -> bool

This method tests for !=.

impl<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT> Serialize for EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT> where
    PROCESS: Serialize,
    AGENT: Serialize,
    AGREEMENT: Serialize,
    RESOURCESPECIFICATION: Serialize,
    ECONOMICRESOURCE: Serialize,
    ECONOMICEVENT: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT> StructuralPartialEq for EconomicEvent<PROCESS, AGENT, AGREEMENT, RESOURCESPECIFICATION, ECONOMICRESOURCE, ECONOMICEVENT>