Struct omf::Project

pub struct Project {
    pub name: String,
    pub description: String,
    pub coordinate_reference_system: String,
    pub units: String,
    pub origin: Vector3,
    pub author: String,
    pub application: String,
    pub date: DateTime<Utc>,
    pub metadata: Map<String, Value>,
    pub elements: Vec<Element>,
}

Root object of an OMF file.

This is the root element of an OMF file, holding global metadata and a list of Elements that describe the objects or shapes within the file.

Fields

name: String

Project name.

description: String

Optional project description.

coordinate_reference_system: String

Optional EPSG or PROJ local transformation string, default empty.

Exactly what is supported depends on the application reading the file.

units: String

Optional unit for distances and locations within the file.

Typically “meters”, “metres”, “feet”, or empty because the coordinate reference system defines it. If both are empty then applications may assume meters.

origin: Vector3

Optional project origin, default [0, 0, 0].

Most geometries also have their own origin field. To get the real location add this origin and the geometry origin to all locations within each element.

author: String

Optional name or email address of the person that created the file, default empty.

application: String

Optional name and version of the application that created the file, default empty.

date: DateTime<Utc>

Optional file or data creation date, default empty.

metadata: Map<String, Value>

Arbitrary metadata.

This is the place to put anything that doesn’t fit in the other fields. Application-specific data should use a prefix that identifies the application, like "lf-something" for Leapfrog.

elements: Vec<Element>

List of elements.

Implementations

impl Project

pub fn new(name: impl Into<String>) -> Self

Create a new project with just the name set.

Trait Implementations

impl Clone for Project

fn clone(&self) -> Project

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Project

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

Formats the value using the given formatter.

impl Default for Project

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Project

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Project

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Project

fn eq(&self, other: &Project) -> 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 Project

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for Project

fn validate(&mut self) -> Result<Problems, Problems>

Call to validate the object, returning errors and warnings.

impl StructuralPartialEq for Project