VeriStand .NET API Reference

DataLoggingSpecification Members

The DataLoggingSpecification type exposes the following members.

NameDescription
DataLoggingSpecification
Overloaded. Initializes a new instance of the DataLoggingSpecification class with default settings. The log is set to start immediately and log indefinitely. Data is logged at the rate at which the targets are running.

Methods

NameDescription
EqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
FinalizeAllows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
GetTypeGets the Type of the current instance. (Inherited from Object.)
MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
ToStringReturns a String that represents the current Object. (Inherited from Object.)

Properties

NameDescription
CustomRate Gets or sets a value indicating the requested rate in Hertz at which data will be logged. The actual rates at which data is logged may be coerced to an even divisor of the rates at which the targets in the system definition produce data. This property is ignored unless LogDataAtTargetRate is false.
LogDataAgainstAbsoluteTimeBase Gets or sets a value indicating whether to log data against an absolute time base from the system clock on the target. If this value is false, no timing informating will be added to the log file.
LogDataAtTargetRate Gets or sets a value indicating whether data is logged at the rate at which the target is running. Set this property to true to log all data produced by a target. If this property is false, data is logged using the rate specified by CustomRate.
LogFile Gets or sets a value indicating the log file specification for the data logging session. This includes information about the type of log files to create and the channels to log.
MinimumBufferSize Gets or sets a value indicating the minimum size of data buffered while logging. Increasing the minimum buffer size can improve logging performance but requires additional memory resources.
PostTriggerDuration Gets or sets a value indicating the duration in seconds of data that is logged after the stop trigger condition occurs.
PreTriggerDuration Gets or sets a value indicating the duration in seconds of data that is logged before the start trigger condition occurs.
Retriggerable Gets or sets a value indicating whether logging is retriggerable. If this is true, then data logging can be triggered by the start trigger condition after it has completed logging data from the previous start trigger instance.
SegmentFileOnTrigger Gets or sets a value indicating whether to create a new file instance each time the start trigger condition occurs. Segmenting the log file for each start trigger instance ensures that all data logged to a file is contiguous in time.
SegmentingSpecification Gets or sets a value indicating the condition that determines when to segment a log file. When the condition occurs, the current instance of the log file is closed, and data continues to be logged to a new log file instance.
SetLogFilesReadOnlyOnClose Gets or sets a value indicating whether log files should be set as read-only after being closed.
StartTrigger Gets or sets a value indicating the condition used to determine when to start logging.
StopLogOnDataLoss Gets or sets a value indicating whether to stop logging data in the case of data loss. The default value is true. If this value is false and data loss occurs, an error will be generated, but data logging will continue.
StopTrigger Gets or sets a value indicating the condition used to determine when to stop logging.

See Also

Log in to get a better experience