Represents a LandMark.

Hierarchy

  • LandMark

Implements

Constructors

  • Constructs a new LandMark.

    Parameters

    • Optional properties: ILandMark

      Properties to set

    Returns LandMark

Properties

id: string

LandMark id.

name: string

LandMark name.

x: number

LandMark x.

y: number

LandMark y.

Methods

  • Converts this LandMark to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Creates a new LandMark instance using the specified properties.

    Parameters

    • Optional properties: ILandMark

      Properties to set

    Returns LandMark

    LandMark instance

  • Decodes a LandMark message from the specified reader or buffer.

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

    Parameters

    • reader: any

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns LandMark

    LandMark

  • Decodes a LandMark message from the specified reader or buffer, length delimited.

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

    Parameters

    • reader: any

      Reader or buffer to decode from

    Returns LandMark

    LandMark

  • Encodes the specified LandMark message. Does not implicitly verify messages.

    Parameters

    • message: ILandMark

      LandMark message or plain object to encode

    • Optional writer: any

      Writer to encode to

    Returns Writer

    Writer

  • Encodes the specified LandMark message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: ILandMark

      LandMark message or plain object to encode

    • Optional writer: any

      Writer to encode to

    Returns Writer

    Writer

  • Creates a LandMark message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: {
          [k: string]: any;
      }

      Plain object

      • [k: string]: any

    Returns LandMark

    LandMark

  • Creates a plain object from a LandMark message. Also converts values to other types if specified.

    Parameters

    • message: LandMark

      LandMark

    • Optional options: any

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies a LandMark message.

    Parameters

    • message: {
          [k: string]: any;
      }

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc