Package org.yamcs.archive
Interface TagDb
-
- All Known Implementing Classes:
RdbTagDb
public interface TagDb
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidclose()close the database and release resources the object is unusable after this call.org.yamcs.protobuf.Yamcs.ArchiveTagdeleteTag(long tagTime, int tagId)Deletes the specified tagorg.yamcs.protobuf.Yamcs.ArchiveTaggetTag(long tagTime, int tagId)Returns a specific tag, or null if the requested tag does not existvoidgetTags(TimeInterval intv, TagReceiver callback)Synchonously gets tags, passing every separate one to the providedTagReceiver.org.yamcs.protobuf.Yamcs.ArchiveTaginsertTag(org.yamcs.protobuf.Yamcs.ArchiveTag tag)Inserts a new Tag.org.yamcs.protobuf.Yamcs.ArchiveTagupdateTag(long tagTime, int tagId, org.yamcs.protobuf.Yamcs.ArchiveTag tag)Updates an existing tag.
-
-
-
Method Detail
-
getTags
void getTags(TimeInterval intv, TagReceiver callback) throws IOException
Synchonously gets tags, passing every separate one to the providedTagReceiver.- Throws:
IOException
-
getTag
org.yamcs.protobuf.Yamcs.ArchiveTag getTag(long tagTime, int tagId) throws IOExceptionReturns a specific tag, or null if the requested tag does not exist- Throws:
IOException
-
insertTag
org.yamcs.protobuf.Yamcs.ArchiveTag insertTag(org.yamcs.protobuf.Yamcs.ArchiveTag tag) throws IOExceptionInserts a new Tag. No id should be specified. If it is, it will silently be overwritten, and the new tag will be returned.- Throws:
IOException
-
updateTag
org.yamcs.protobuf.Yamcs.ArchiveTag updateTag(long tagTime, int tagId, org.yamcs.protobuf.Yamcs.ArchiveTag tag) throws IOException, YamcsExceptionUpdates an existing tag. The tag is fetched by the specified id throws YamcsException if the tag could not be found.Note that both tagId and oldTagStart need to be specified so that a direct lookup in the internal data structure can be made.
- Returns:
- the updated tag
- Throws:
IOExceptionYamcsException
-
deleteTag
org.yamcs.protobuf.Yamcs.ArchiveTag deleteTag(long tagTime, int tagId) throws IOException, YamcsExceptionDeletes the specified tag- Throws:
YamcsException- if the id was invalid, or if the tag could not be foundIOException
-
close
void close()
close the database and release resources the object is unusable after this call.
-
-