TruxtonLocation

From truxwiki.com
Revision as of 15:10, 27 January 2024 by Sam (talk | contribs) (→‎Sample)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This class lets you add to the [Location] table in Truxton.

Attributes and Methods

altitude: float

The altitude in meters.

addnote(text: str) -> boolean

This adds an investigator's note. The text parameter is the contents of the note. It will return True if the tag was associated with the location, False on failure. The note is stored in the [InvestigatorNote] table in the database.

fileid: str

The GUID of the file this location came from. This corresponds to the [FileID] column of the [Location] table.

id: str

This is the GUID of the record. It becomes non-zero after save() has been called. This corresponds to the [ID] column of the [Location] table.

label: str

The short label for this location. This corresponds to the [Label] column of the [Location] table.

latitude: float

The latitude portion of the geographic coordinate using the WGS84 ellipsoid. This corresponds to the [Latitude] column of the [Location] table.

longitude: float

The longitude portion of the geographic coordinate using the WGS84 ellipsoid. Many thanks go to John Harrison for his work. This corresponds to the [Longitude] column of the [Location] table.

mediaid: str

This is the GUID of the media this location came from. This corresponds to the [MediaID] column of the [Location] table.

save() -> boolean

This will commit the information to the [Location] table. It will return True if the record was saved to the database, False if there was an error.

tag(tag: str, reason: str, origin: int) -> boolean

This creates a tag associated with this location in Truxton. The tag parameter is a short, one or two word, bit of text that will be displayed in the UI. The reason a sentence explaining why this location was tagged. The origin is either TAG_ORIGIN_AUTOMATIC (1) or TAG_ORIGIN_HUMAN (2). It will return True if the tag was associated with the location, False on failure.

type: int

The type of the location. This corresponds to the [LocationTypeID] column of the [Location] table. It must be a value listed in the ID column of the [LocationType] table. You can also use a predefined constant.

when: datetime

The time associated with this location. This value can be set with either a datetime value or an integer representing FILETIME ticks.

Sample

import sys
sys.path.append('C:/Program Files/Truxton/SDK')
import truxton
import shutil

from datetime import datetime
from calendar import timegm
from pathlib import Path

def add_file(parent_truxton_file, filename):
  source_file = open(filename, "rb")
  child = parent_truxton_file.newchild()
  child.name = Path(filename).name
  shutil.copyfileobj(source_file, child)
  source_file.close()
  child.save()
  return child

def add_media(t):
  media = t.newmedia()

  media.name = "Public Documents"
  media.description = "Publicly available documents"
  media.case = "DC-SNAFU-2016.2020"
  media.evidencebag = "EV-0937459386623-a"
  media.originator = "Jeffrey Jensen"
  media.latitude = 38.897661
  media.longitude = -77.036458
  media.type = truxton.MEDIA_TYPE_LOGICAL_FILES
  media.save()

  return media

def add_cs(parent_file ):
  child_file = add_file(parent_file, "cs.jpg")

  gps = child_file.newlocation()
  gps.type = truxton.LOCATION_TYPE_MEETING
  gps.latitude = 51.487329
  gps.longitude = -0.124057
  gps.label = "HQ"
  gps.when = datetime.fromisoformat("2016-04-01T12:00:00-05:00")
  gps.save()

def main():
  t = truxton.create()

  media = add_media(t)

  root_file = media.addroot()
  root_file.save()

  add_cs(root_file)

if __name__ == "__main__":
  sys.exit(main())