Skip to main content Skip to search

VeriStand .NET API Reference

Table of Contents

StartLoggingStep Members

Download PDF

Updated2023-02-21
6 minute(s) read

The StartLoggingStep type exposes the following members.

	Name	Description
	StartLoggingStep	Overloaded. Initializes a new instance of StartLoggingStep.

Methods

	Name	Description
	AddChannelGroup	Adds the specified channelGroup to the StartLoggingStep.
	CheckForErrors	Performs checks on a step and returns any errors, warnings, or messages that are relevant to the step's current configuration. (Overrides ActionStep.CheckForErrors().)
	Clone	Creates a new object that is a copy of the current instance. (Inherited from BaseNode.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RemoveChannelGroup	Removes the specified channelGroupName from the StartLoggingStep.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Properties

	Name	Description
	ChannelGroups	Gets or sets the groups of channels to log data for when the StartLoggingStep executes or the TriggerCondition is met.
	ConfigurationName	Gets or sets the name of the logging configuration, which you can use to control data logging after it starts. For example, you can pass this value to a StopLoggingStep to stop logging.
	Description	Gets or sets the description of the node that appears in the Property Browser when you select the node in the Stimulus Profile Editor. (Inherited from BaseNode.)
	FilePath	Gets or sets the path to the log file to save data to. The Stimulus Profile Editor creates log files in the TDMS file format.
	HighLimit	Gets or sets the high limit used when TriggerCondition is `in_limits` or `out_of_limits`. The value of TriggerChannel must be less than or equal to this value and greater than or equal to LowLimit to be considered within limits.
	Id	Gets the unique identifier for a step, which is the full path to the step in the stimulus profile hierarchy. (Inherited from ActionStep.)
	LogFileSegmentingOptions	Gets or sets a value indicating whether and how to segment the log file.
	LowLimit	Gets or sets the low limit used when TriggerCondition is `in_limits` or `out_of_limits`. The value of TriggerChannel must be greater than or equal to this value and less than or equal to HighLimit to be considered within limits.
	PostTriggerDuration	Gets or sets a value indicating the duration in seconds to continue logging data after a stop trigger occurs.
	PreTriggerDuration	Gets or sets a value indicating the number of seconds of data to retain in the buffer in case a start trigger occurs. When the start trigger occurs, any buffered data is included in the log.
	Rate	Gets or sets the rate in hertz at which data is logged.
	ReplaceFile	Gets or sets whether NI VeriStand overwrites an existing log file if a new logging operation with the same FilePath starts.
	ResXKey	Gets or sets the ResX key for the node, which is a pointer to a `.resx` file that contains a context help description for the node. (Inherited from BaseNode.)
	Size	Gets or sets a value indicating the maximum size of a log file segment, in bytes.
	State	Gets the execution state of a step (Idle, Initializing, Running, and so on.) (Inherited from ActionStep.)
	StepName	Gets the name of the step. (Overrides ActionStep.StepName.)
	TimestampFile	Gets or sets whether a timestamp is appended to the log file name when logging begins. The timestamp contains the month, day, year, hour, minute and second at which logging begins.
	TriggerChannel	Gets or sets the channel to watch for the TriggerCondition.
	TriggerCondition	Gets or sets a trigger condition to use to start data logging.

Events

	Name	Description
	PropertyChanged	Occurs when a property value changes. (Inherited from BaseNode.)

See Also

Reference

StartLoggingStep Class

NationalInstruments.VeriStand.StimulusProfileDefinitionApi Namespace

Previous

No previous section

Next

No next section

Previous

No previous section

Next

No next section

Log in to get a better experience