LogInfo Members
- Updated2023-02-21
- 4 minute(s) read
The LogInfo type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| 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.) | |
| ToString | Returns a String that represents the current Object. (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
| channels | The list of channels to log in the log file. | |
| description | The description for the data log file. | |
| file_path | The file path for the data log file. The file must be a TDMS file. | |
| high_limit | The high limit for trigger limit analysis. | |
| low_limit | The low limit for trigger limit analysis. | |
| rate | The requested rate in Hz at which data is logged to the log file. Data is logged at the closest possible rate to this value that does not exceed the rate at which a target produces data. The default value is Inf, which specifies that all samples are logged. | |
| replace_file | A flag specifying whether to replace an existing log file or append data to the file. TRUE specifies to replace the log file. FALSE specifies to append data to the log file. | |
| root_properties | A dictionary containing property name and property value strings. These properties are written as metadata to the root item in the log file. | |
| trigger_channel | The path to the channel, as specified in the system definition file, on which to perform trigger limit analysis. The path matches the node hierarchy that appears in the System Explorer window configuration tree. | |
| trigger_type | The type of LogInfo.trigger to use for the log file. |