Object¶
- class caris.bathy.db.Object¶
The base class of Surface and Survey.
- attachments¶
The list of attachments for the object.
Type: List of FileDescriptors.
- delete_attachment((str)file_name) → None¶
Delete an attachment from the object.
Parameters: file_name (str) – The file name of the attachment to be deleted.
- download_attachment((str)attachment_name, (str)output_directory) → None¶
Download the specified attachment from the object.
Parameters: - attachment_name (str) – The name of the attachment to download.
- output_directory (str) – The location to download the attachment to.
- geometry¶
The geometry of the object in WKT format.
Type: str
- get_metadata() → object¶
New in version 4.0.4.
Get the metadata associated with this object.
Return type: A dict containing the attribute name/value pairs.
- id¶
The identifier of the object, which is unique within the database.
Type: int
- set_metadata((object)metadata) → None¶
New in version 4.0.4.
Set the metadata associated with this object.
Parameters: metadata (dict) – The attribute name/value pairs.
- upload_attachment((str)file_name) → None¶
Upload a new attachment to the object.
Parameters: file_name (str) – The full path of the attachment to upload.