Skip to main content

AgsiGeometryFromFile

Struct AgsiGeometryFromFile 

Source
pub struct AgsiGeometryFromFile {
    pub date: Option<NaiveDate>,
    pub description: Option<String>,
    pub file_format: Option<String>,
    pub file_format_version: Option<String>,
    pub file_part: Option<String>,
    pub file_uri: String,
    pub geometry_id: Option<String>,
    pub geometry_type: Option<String>,
    pub remarks: Option<String>,
    pub revision: Option<String>,
    pub revision_info: Option<String>,
}
Expand description

An agsiGeometryFromFile object is a pointer to geometry data contained within an external file, such as a CAD or model file. This object also includes metadata describing the file being referenced. Refer to 6.2. Geometry rules and conventions for further requirements and recommendations relating to this object.

JSON schema
{
 "description": "An agsiGeometryFromFile object is a pointer to geometry data contained within an external file, such as a CAD or model file. This object also includes metadata describing the file being referenced. Refer to 6.2. Geometry rules and conventions for further requirements and recommendations relating to this object.",
 "type": "object",
 "required": [
   "fileURI"
 ],
 "properties": {
   "date": {
     "description": "Date of issue of this revision.",
     "type": "string",
     "format": "date",
     "example": "2018-10-07"
   },
   "description": {
     "description": "Short description of geometry defined here.",
     "type": "string",
     "example": "Top of GC"
   },
   "fileFormat": {
     "description": "Format/encoding of the data, i.e. file format. Refer to vocabulary for list of common formats that may be used, or provide concise identification if other format used. Refer to 6.2.1. File formats for geometry for requirements and recommendations relating to file formats.",
     "type": "string",
     "example": "LandXML"
   },
   "fileFormatVersion": {
     "description": "Additional version information for file format used, if required.",
     "type": "string",
     "example": "2.0"
   },
   "filePart": {
     "description": "Pointer to a specific part of a file, where required for disambiguation. For CAD or model files this could be used for the layer/level on which the required data is located. For a geoJSON file with a feature collection this could be used to specify the id of the feature of interest.  Use with caution as the ability to interrogate only a specified layer/level/feature etc. may not be supported in all software.",
     "type": "string",
     "example": "GCTop"
   },
   "fileURI": {
     "description": "URI-reference for the geometry file. This will be a relative link if file is included as part of the AGSi package. Alternatively, a link to a project document system location. Refer to 6.2.1. File formats for geometry for requirements and recommendations relating to linked files. Spaces are not permitted in URI-reference strings. Refer to 1.6.6. URI for how to handle spaces in file paths or names.",
     "type": "string",
     "format": "uri-reference",
     "example": "geometry/geology/GCtop.xml"
   },
   "geometryID": {
     "description": "Identifier for this geometry object. May be local to this file but all identifiers used within the Geometry group of objects shall be unique. Alternatively a UUID may be used (recommended for large datasets). Use of this attribute is optional and it is not referenced anywhere else in the schema, but it may be beneficial to include it to help with data control and integrity, and some applications may require or benefit from it.",
     "type": "string",
     "example": "GeologyGCCTop"
   },
   "geometryType": {
     "description": "Nature of geometry represented.",
     "type": "string",
     "example": "Surface"
   },
   "remarks": {
     "description": "Additional remarks, if required.",
     "type": "string",
     "example": "Some remarks if required"
   },
   "revision": {
     "description": "Revision of the referenced file.",
     "type": "string",
     "example": "P2"
   },
   "revisionInfo": {
     "description": "Revision notes for this revision of the referenced file.",
     "type": "string",
     "example": "Updated for GIR rev P2. Additional BH from 2018 GI included."
   }
 },
 "additionalProperties": false
}

Fields§

§date: Option<NaiveDate>

Date of issue of this revision.

§description: Option<String>

Short description of geometry defined here.

§file_format: Option<String>

Format/encoding of the data, i.e. file format. Refer to vocabulary for list of common formats that may be used, or provide concise identification if other format used. Refer to 6.2.1. File formats for geometry for requirements and recommendations relating to file formats.

§file_format_version: Option<String>

Additional version information for file format used, if required.

§file_part: Option<String>

Pointer to a specific part of a file, where required for disambiguation. For CAD or model files this could be used for the layer/level on which the required data is located. For a geoJSON file with a feature collection this could be used to specify the id of the feature of interest. Use with caution as the ability to interrogate only a specified layer/level/feature etc. may not be supported in all software.

§file_uri: String

URI-reference for the geometry file. This will be a relative link if file is included as part of the AGSi package. Alternatively, a link to a project document system location. Refer to 6.2.1. File formats for geometry for requirements and recommendations relating to linked files. Spaces are not permitted in URI-reference strings. Refer to 1.6.6. URI for how to handle spaces in file paths or names.

§geometry_id: Option<String>

Identifier for this geometry object. May be local to this file but all identifiers used within the Geometry group of objects shall be unique. Alternatively a UUID may be used (recommended for large datasets). Use of this attribute is optional and it is not referenced anywhere else in the schema, but it may be beneficial to include it to help with data control and integrity, and some applications may require or benefit from it.

§geometry_type: Option<String>

Nature of geometry represented.

§remarks: Option<String>

Additional remarks, if required.

§revision: Option<String>

Revision of the referenced file.

§revision_info: Option<String>

Revision notes for this revision of the referenced file.

Implementations§

Trait Implementations§

Source§

impl Clone for AgsiGeometryFromFile

Source§

fn clone(&self) -> AgsiGeometryFromFile

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 AgsiGeometryFromFile

Source§

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

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

impl<'de> Deserialize<'de> for AgsiGeometryFromFile

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<&AgsiGeometryFromFile> for AgsiGeometryFromFile

Source§

fn from(value: &AgsiGeometryFromFile) -> Self

Converts to this type from the input type.
Source§

impl From<AgsiGeometryFromFile> for AgsiGeometryFromFile

Source§

fn from(value: AgsiGeometryFromFile) -> Self

Converts to this type from the input type.
Source§

impl From<AgsiGeometryFromFile> for AgsiGeometryVolFromSurfacesVariant0AgsiGeometryTop

Source§

fn from(value: AgsiGeometryFromFile) -> Self

Converts to this type from the input type.
Source§

impl From<AgsiGeometryFromFile> for AgsiGeometryVolFromSurfacesVariant1AgsiGeometryBottom

Source§

fn from(value: AgsiGeometryFromFile) -> Self

Converts to this type from the input type.
Source§

impl Serialize for AgsiGeometryFromFile

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<AgsiGeometryFromFile> for AgsiGeometryFromFile

Source§

type Error = ConversionError

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

fn try_from(value: AgsiGeometryFromFile) -> 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>,