Skip to main content

AgsiModelAlignment

Struct AgsiModelAlignment 

Source
pub struct AgsiModelAlignment {
    pub agsi_geometry: Option<AgsiGeometryFromFile>,
    pub alignment_id: Option<String>,
    pub alignment_name: Option<String>,
    pub description: Option<String>,
    pub remarks: Option<String>,
    pub start_chainage: Option<f64>,
}
Expand description

An alignment comprises the geometry and metadata defining a line of interest, most commonly used for the line of a section (cross section, fence or profile - see Guidance for discussion of terminology). Alignments are typically included in a primary 3D model (alternatively a 2D map) but the sections themselves are normally defined as separate models because each 2D section will have its own coordinate system. The alignmentID attribute can be referenced by section models to provide a link to the alignment defined here. Sections must be drawn in the vertical (Z) plane, with alignments defined in the XY plane. The geometry is specified using an embedded agsiGeometryFromFile object referencing an external file.

JSON schema
{
 "description": "An alignment comprises the geometry and metadata defining a line of interest, most commonly used for the line of a section (cross section, fence or profile  - see Guidance for discussion of terminology). Alignments are typically included in a primary 3D model (alternatively a 2D map) but the sections themselves are normally defined as separate models because each 2D section will have its own coordinate system. The alignmentID attribute can be referenced by section models to provide a link to the alignment defined here. Sections must be drawn in the vertical (Z) plane, with alignments defined in the XY plane. The geometry is specified using an embedded agsiGeometryFromFile object referencing an external file.",
 "type": "object",
 "properties": {
   "agsiGeometry": {
     "description": "An embedded Geometry group object defining the geometry of the  alignment as a 2D line in XY space. This will be an embedded agsiGeometryFromFile object pointing to a line defined in an external file.",
     "type": "object",
     "$ref": "#/$defs/agsiGeometryFromFile"
   },
   "alignmentID": {
     "description": "Identifier for the alignment. May be local to this file or a UUID as required/specified. May be referenced by alignmentID attribute of (a different) agsiModel object. Identifiers for alignmentID shall be unique within the AGSi file.",
     "type": "string",
     "example": "sectionAA"
   },
   "alignmentName": {
     "description": "Name or short description of what this alignment represents.",
     "type": "string",
     "example": "Section AA"
   },
   "description": {
     "description": "More verbose description, as required.",
     "type": "string",
     "example": "East-west section through site"
   },
   "remarks": {
     "description": "Additional remarks, if required.",
     "type": "string",
     "example": "Some additional remarks"
   },
   "startChainage": {
     "description": "The section chainage/baseline distance for the first point defined on the alignment. Assumed to be zero if not used.",
     "type": "number",
     "example": 1000
   }
 },
 "additionalProperties": false
}

Fields§

§agsi_geometry: Option<AgsiGeometryFromFile>

An embedded Geometry group object defining the geometry of the alignment as a 2D line in XY space. This will be an embedded agsiGeometryFromFile object pointing to a line defined in an external file.

§alignment_id: Option<String>

Identifier for the alignment. May be local to this file or a UUID as required/specified. May be referenced by alignmentID attribute of (a different) agsiModel object. Identifiers for alignmentID shall be unique within the AGSi file.

§alignment_name: Option<String>

Name or short description of what this alignment represents.

§description: Option<String>

More verbose description, as required.

§remarks: Option<String>

Additional remarks, if required.

§start_chainage: Option<f64>

Implementations§

Trait Implementations§

Source§

impl Clone for AgsiModelAlignment

Source§

fn clone(&self) -> AgsiModelAlignment

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AgsiModelAlignment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AgsiModelAlignment

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AgsiModelAlignment

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&AgsiModelAlignment> for AgsiModelAlignment

Source§

fn from(value: &AgsiModelAlignment) -> Self

Converts to this type from the input type.
Source§

impl From<AgsiModelAlignment> for AgsiModelAlignment

Source§

fn from(value: AgsiModelAlignment) -> Self

Converts to this type from the input type.
Source§

impl Serialize for AgsiModelAlignment

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<AgsiModelAlignment> for AgsiModelAlignment

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

fn try_from(value: AgsiModelAlignment) -> Result<Self, ConversionError>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,