tacview

Documentation

Index

• type Header
  • func (h *Header) Write(writer *bufio.Writer) error
• type Object
  • func (o *Object) Get(key string) *Property
  • func (o *Object) Set(key string, value string)
  • func (o *Object) Write(writer *bufio.Writer) error
• type Property
• type Reader
  • func NewReader(reader io.Reader) (*Reader, error)
  • func (r *Reader) ProcessTimeFrames(concurrency int, timeFrame chan<- *TimeFrame) error
• type TimeFrame
  • func NewTimeFrame() *TimeFrame
  • func (tf *TimeFrame) Delete(id uint64)
  • func (tf *TimeFrame) Get(id uint64) *Object
  • func (tf *TimeFrame) Write(writer *bufio.Writer, includeOffset bool) error
• type Writer
  • func NewWriter(writer io.WriteCloser, header *Header) (*Writer, error)
  • func (w *Writer) Close() error
  • func (w *Writer) WriteTimeFrame(tf *TimeFrame) error

Types

type Header

type Header struct {
	FileType         string
	FileVersion      string
	ReferenceTime    time.Time
	InitialTimeFrame TimeFrame
}

Header describes a ACMI file header

func (*Header) Write

func (h *Header) Write(writer *bufio.Writer) error

type Object

type Object struct {
	Id         uint64
	Properties []*Property
	Deleted    bool
}

Object describes an ACMI object

func (*Object) Get

func (o *Object) Get(key string) *Property

Get returns a property (if one exists) for a given key

func (*Object) Set

func (o *Object) Set(key string, value string)

Set updates the given property

func (*Object) Write

func (o *Object) Write(writer *bufio.Writer) error

type Property

type Property struct {
	Key   string
	Value string
}

Property represents an object property

type Reader

type Reader struct {
	Header Header
	// contains filtered or unexported fields
}

Reader provides an interface for reading an ACMI file

func NewReader

func NewReader(reader io.Reader) (*Reader, error)

NewReader creates a new ACMI reader

func (*Reader) ProcessTimeFrames

func (r *Reader) ProcessTimeFrames(concurrency int, timeFrame chan<- *TimeFrame) error

ProcessTimeFrames concurrently processes time frames from within the ACMI file,

producing them to an output channel. If your use case requires strong ordering
and you do not wish to implement this guarantee on the consumer side, you must
set the concurrency to 1.

type TimeFrame

type TimeFrame struct {
	Offset  float64
	Objects []*Object
}

TimeFrame represents a single time frame from an ACMI file

func NewTimeFrame

func NewTimeFrame() *TimeFrame

NewTimeFrame creates an empty TimeFrame

func (*TimeFrame) Delete

func (tf *TimeFrame) Delete(id uint64)

Delete removes an object (if one exists) for a given object id

func (*TimeFrame) Get

func (tf *TimeFrame) Get(id uint64) *Object

Get returns an object (if one exists) for a given object id

func (*TimeFrame) Write

func (tf *TimeFrame) Write(writer *bufio.Writer, includeOffset bool) error

type Writer

type Writer struct {
	// contains filtered or unexported fields
}

Writer provides an interface for writing an ACMI file

func NewWriter

func NewWriter(writer io.WriteCloser, header *Header) (*Writer, error)

NewWriter creates a new ACMI writer

func (*Writer) Close

func (w *Writer) Close() error

Close closes the writer, flushing any remaining contents

func (*Writer) WriteTimeFrame

func (w *Writer) WriteTimeFrame(tf *TimeFrame) error

WriteTimeFrame writes a time frame