DataHistoryVariableMetadataStruct
Last update: 16.07.2025public class DataHistoryVariableMetadataStruct
This object is used to pass variable metadata to the addVariableStructs function for data history, which sets the results for a run. This class is referenced by the DataHistoryVariableStruct object. For more information see addVariableStructs.
See also
| DataHistoryVariableStruct |
Constructors
| DataHistoryVariableMetadataStruct | constructor() |
Properties
| Name | Summary |
|---|---|
| customMetadata | open var customMetadata: Map<String, String> Map of name/value pairs representing each piece of custom metadata |
| enumAliases | open var enumAliases: String comma separated list of enumerated aliases of variable |
| enumValues | open var enumValues: String comma separated list of enumerated values of variable |
| equation | open var equation: String The equation of the variable |
| fileName | open var fileName: String The filename of a file variable |
| format | open var format: String The format of the variable |
| geomScript | open var geomScript: String The geomScript of the variable |
| isBinary | open var isBinary: Boolean true if file variable is a binary file, false otherwise |
| isDesignVar | open var isDesignVar: Boolean true if the variable is a design variable, false otherwise |
| isInput | open var isInput: Boolean true if the variable is an input, false otherwise |
| isNumeric | open var isNumeric: Boolean true if the variable is numeric, false otherwise |
| lowerBound | open var lowerBound: Any The lower bound of the variable |
| name | open var name: String The name of the variable |
| type | open var type: String The type of the variable |
| units | open var units: String The units of the variable |
| upperBound | open var upperBound: Any The upper bound of the variable |
Functions
| Name | Summary |
|---|---|
| getCustomMetadataNames | public getCustomMetadataNames(): Array<String> Gets an array of the names of the custom metadata fields. |
