Struct omf::Attribute

pub struct Attribute {
    pub name: String,
    pub description: String,
    pub units: String,
    pub metadata: Map<String, Value>,
    pub location: Location,
    pub data: AttributeData,
}

Describes data attached to an Element.

Each Element can have zero or more attributes, each attached to different parts of the element and each containing different types of data. On a set of points, one attribute might contain gold assay results and another rock-type classifications.

Fields

name: String

Attribute name. Should be unique within the containing element.

description: String

Optional attribute description.

units: String

Optional unit of the attribute data, default empty.

OMF does not currently attempt to standardize the strings you can use here, but our recommendations are:

• Use full names, so “kilometers” rather than “km”. The abbreviations for non-metric units aren’t consistent and complex units can be confusing.

• Use plurals, so “feet” rather than “foot”.

• Avoid ambiguity, so “long tons” rather than just “tons”.

• Accept American and British spellings, so “meter” and “metre” are the same.

metadata: Map<String, Value>

Attribute metadata.

location: Location

Selects which part of the element the attribute is attached to.

See the documentation for each Geometry variant for a list of what locations are valid.

data: AttributeData

The attribute data.

Implementations

impl Attribute

pub fn from_numbers( name: impl Into<String>, location: Location, values: Array<Number>, ) -> Self

Convenience function to create a number attribute.

pub fn from_numbers_continuous_colormap( name: impl Into<String>, location: Location, values: Array<Number>, range: impl Into<NumberRange>, gradient: Array<Gradient>, ) -> Self

Convenience function to create a number attribute with a continuous colormap.

pub fn from_numbers_discrete_colormap( name: impl Into<String>, location: Location, values: Array<Number>, boundaries: Array<Boundary>, gradient: Array<Gradient>, ) -> Self

Convenience function to create a number attribute with a discrete colormap.

pub fn from_vectors( name: impl Into<String>, location: Location, values: Array<Vector>, ) -> Self

Convenience function to create a vector attribute.

pub fn from_strings( name: impl Into<String>, location: Location, values: Array<Text>, ) -> Self

Convenience function to create a string attribute.

pub fn from_categories( name: impl Into<String>, location: Location, values: Array<Index>, names: Array<Name>, gradient: Option<Array<Gradient>>, attributes: impl IntoIterator<Item = Attribute>, ) -> Self

Convenience function to create a category attribute.

pub fn from_booleans( name: impl Into<String>, location: Location, values: Array<Boolean>, ) -> Self

Convenience function to create a number attribute.

pub fn from_colors( name: impl Into<String>, location: Location, values: Array<Color>, ) -> Self

Convenience function to create a color attribute.

pub fn from_texture_map( name: impl Into<String>, image: Array<Image>, location: Location, texcoords: Array<Texcoord>, ) -> Self

Convenience function to create a mapped texture attribute.

pub fn from_texture_project( name: impl Into<String>, image: Array<Image>, orient: Orient2, width: f64, height: f64, ) -> Self

Convenience function to create a projected texture attribute.

pub fn len(&self) -> u64

Returns the length of the attribute, or zero for a projected texture.

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attribute

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Attribute

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Attribute

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 Attribute

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

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 Attribute

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

Call to validate the object, returning errors and warnings.

impl StructuralPartialEq for Attribute