TrackingArchiveTEntity Class

The base for classes that archive tracking data.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.TrackingTrackingArchiveTEntity
    AGI.Foundation.TrackingMemoryArchiveTEntity
    AGI.Foundation.TrackingSqlServerArchiveTEntity

Namespace: AGI.Foundation.Tracking
Assembly: AGI.Foundation.Tracking (in AGI.Foundation.Tracking.dll) Version: 24.1.418.0 (24.1.418.0)

Syntax

C++

Copy

public abstract class TrackingArchive<TEntity> : IDisposable
where TEntity : class, IEntityIdentifier, IEntityLastUpdate

Public MustInherit Class TrackingArchive(Of TEntity As {Class, IEntityIdentifier, IEntityLastUpdate})
	Implements IDisposable

generic<typename TEntity>
where TEntity : ref class, IEntityIdentifier, IEntityLastUpdate
public ref class TrackingArchive abstract : IDisposable

[<AbstractClassAttribute>]
type TrackingArchive<'TEntity when 'TEntity : not struct and IEntityIdentifier and IEntityLastUpdate> =  
    class
        interface IDisposable
    end

Type Parameters

TEntity: The type of entity to be archived.

The TrackingArchiveTEntity type exposes the following members.

Constructors

	Name	Description
	TrackingArchiveTEntity(TransactionContext)	Initializes a new instance using the provided TransactionContext. The default collection of type archivers is used.
	TrackingArchiveTEntity(TransactionContext, TrackingTypeArchiverCollection)	Initializes a new instance using the provided TransactionContext and a specified collection of type archivers.

Top

Properties

	Name	Description
	Context	Gets the context for which to archives entities.
	IsRunning	Gets a value indicating whether or not the archiver is currently archiving changes to entities in the Context.
	MaximumQueueLength	Gets or sets the maximum length of the queue of committed transactions to be archived. If transactions are committed at a higher rate than they can be archived, the length of the queue will grow. When it reaches this maximum length, committing threads will block until the archiver catches up. Setting this value too high will result in excessive memory usage. Changes to this value while the archiver IsRunning will not take effect until it is restarted.
	PrimitivePropertyComponents	Gets a list of the primitive components of the properties for this entity type. Each property in Properties will correspond to one or more properties in this collection. For example, a property in Properties of type JulianDate might have two properties in this collection: an integer called "Day" and a double called "SecondsOfDay". The exact relationship between Properties and this collection is dictated by the TypeArchivers being used by this archive.
	Properties	Gets a list of archived properties for this entity type. There is one property in this collection for each property in the entity's EntitySchemaTEntity.
	TypeArchivers	Gets the collection of TrackingTypeArchivers that is used to archive the properties of entities. The returned instance should be considered read-only. Attempts to modify the collection of archivers will result in an ObjectFrozenException.

Top

Methods

	Name	Description
	ArchiveEntities	Archives a set of entities.
	Clear	Clears the contents of the archive.
	Dispose	Releases any resources associated with this instance.
	Dispose(Boolean)	Releases any resources associated with this instance.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetArchivedData(JulianDate, JulianDate, Int32, String)	Retrieves archived properties for all entities over the provided time period.
	GetArchivedData(Object, JulianDate, JulianDate, Int32, String)	Retrieves archived properties for the provided entity over the provided time period.
	GetArchivedInterval	Gets the overall interval that exists in the archive for any entity.
	GetArchivedInterval(Object)	Gets the overall interval that exists in the archive for the specified entity identifier.
	GetArchivedPrimitivePropertyComponents(IEnumerableArchivedProperty, JulianDate, JulianDate, Int32)	Retrieves archived primitive property components for all entities over the provided time period.
	GetArchivedPrimitivePropertyComponents(Object, IEnumerableArchivedProperty, JulianDate, JulianDate, Int32)	Retrieves archived primitive property components for the provided entity over the provided time period.
	GetEntityPrimitivePropertyComponents	Fills an array with the archived properties of an entity.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetMotionT(Object, JulianDate, JulianDate, String)	Gets time-varying data, such as position and velocity, from the archive.
	GetMotionT(Object, JulianDate, JulianDate, Int32, String)	Gets time-varying data, such as position and velocity, from the archive.
	GetMotionT, TDerivative(Object, JulianDate, JulianDate, String)	Gets time-varying data, such as position and velocity, from the archive.
	GetMotionT, TDerivative(Object, JulianDate, JulianDate, Int32, String)	Gets time-varying data, such as position and velocity, from the archive.
	GetOrientations(Object, JulianDate, JulianDate)	Gets a DateMotionCollectionT, TDerivative representing the archived orientation, rotational velocity and rotational acceleration of the specified entity beginning at the specified time and lasting for the specified duration.
	GetOrientations(Object, JulianDate, Int32)	Gets a DateMotionCollectionT, TDerivative representing the archived orientation, rotational velocity and rotational acceleration of the specified entity beginning at the specified time and lasting for the specified duration.
	GetOrientations(Object, JulianDate, JulianDate, Int32)	Gets a DateMotionCollectionT, TDerivative representing the archived orientation, rotational velocity and rotational acceleration of the specified entity beginning at the specified time and lasting for the specified duration.
	GetPositions(Object, JulianDate, JulianDate)	Gets a DateMotionCollectionT representing the archived position, velocity and acceleration of the specified entity beginning at the specified time and lasting for the specified duration.
	GetPositions(Object, JulianDate, Int32)	Gets a DateMotionCollectionT representing the archived position, velocity and acceleration of the specified entity beginning at the specified time and lasting for the specified duration.
	GetPositions(Object, JulianDate, JulianDate, Int32)	Gets a DateMotionCollectionT representing the archived position, velocity and acceleration of the specified entity beginning at the specified time and lasting for the specified duration.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	StartWriting	Starts the archiver. After this method is called, all updates to entities in the Context will be archived.
	StopWriting	Stops the archiver. After this method is called, updates to entities in the Context will no longer be archived. This method does not return until the current queue of updates to archive has been processed.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WaitForArchiveQueue	Waits for the currently queued transactions to be archived before returning. Additional committed transactions may be queued while waiting and these will NOT be waited upon.
	WritingShutdown	Called during StopWriting, after the last call to ArchiveEntities(Transaction, IEnumerableTEntity).
	WritingStartup	Called during StartWriting, before the first call to ArchiveEntities(Transaction, IEnumerableTEntity).

Top

Reference

AGI.Foundation.Tracking Namespace

TrackingArchiveAddLanguageSpecificTextSet("LSTBE6998C9_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TEntityAddLanguageSpecificTextSet("LSTBE6998C9_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

TrackingArchiveTEntity Class