Show / Hide Table of Contents

Class AttachedData

Attached data class contains the pat of attached source file, the area/points the data is linked to in the map and also list of meta data that is relative to the attached data.

Inheritance
System.Object
AttachedData
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: CoreLibrary
Assembly: CoreLibrary.dll
Syntax
public class AttachedData

Constructors

AttachedData(List<Vector3>, RelativeFilepath, Metas, String, String, String)

Constructor for JSON serialization and deserialization. Note that the parameter names must match the attribute names (non case sensitive)

Declaration
[JsonConstructor]
public AttachedData(List<Vector3> attachmentpoints, RelativeFilepath filepath, Metas metas, string dataname, string datatype, string firstpoint)
Parameters
Type Name Description
System.Collections.Generic.List<System.Numerics.Vector3> attachmentpoints

Points the data is attached to

RelativeFilepath filepath

Relative filepath to the file

Metas metas

List of meta datas

System.String dataname

Name of the attached data

System.String datatype

Type of the data

System.String firstpoint

AttachedData(String, String, List<List<Single>>)

Declaration
public AttachedData(string filePath, string dataName, List<List<float>> coord)
Parameters
Type Name Description
System.String filePath
System.String dataName
System.Collections.Generic.List<System.Collections.Generic.List<System.Single>> coord

Properties

AttachmentPoints

Declaration
public List<Vector3> AttachmentPoints { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Numerics.Vector3>

DataName

Declaration
public string DataName { get; set; }
Property Value
Type Description
System.String

DataType

Declaration
[JsonIgnore]
public string DataType { get; }
Property Value
Type Description
System.String

Filepath

Declaration
public RelativeFilepath Filepath { get; set; }
Property Value
Type Description
RelativeFilepath

FirstPoint

Declaration
[JsonIgnore]
public string FirstPoint { get; }
Property Value
Type Description
System.String

Metas

Declaration
public Metas Metas { get; set; }
Property Value
Type Description
Metas

Methods

AddMetaData(Meta)

Adds meta data to the attached data.

Declaration
public void AddMetaData(Meta meta)
Parameters
Type Name Description
Meta meta

Metadata to be added.

CheckFilePathExists()

Checks if the AttachedData filepath exists.

Declaration
public bool CheckFilePathExists()
Returns
Type Description
System.Boolean

Does the filepath exist

SetDataRelation(String)

Sets filepath to be relative to given filepath.

Declaration
public void SetDataRelation(string relativeTo)
Parameters
Type Name Description
System.String relativeTo

Filepath the relation is set to.

SetMetaData(String, String)

Sets metadata of specified name to the first metadata that maches. If no metadata name matches, creates new metadata.

Declaration
public bool SetMetaData(string name, string value)
Parameters
Type Name Description
System.String name

Name of existing or new metadata.

System.String value

Value with existing name was replaced.

Returns
Type Description
System.Boolean

ToString()

Returns the data name.

Declaration
public override string ToString()
Returns
Type Description
System.String

Name of the metadata

Overrides
System.Object.ToString()
In This Article
Back to top Generated by DocFX