Properties in DIAdem - Overview

DIAdem 2018 Help


Edition Date: June 2018
Part Number: 370858P-01
View Product Info

DOWNLOAD (Windows Only)


DIAdem 2017 Help
DIAdem 2018 Help
DIAdem 2019 Help
DIAdem 2020 Help
DIAdem 2020 SP1 Help

The following is an overview of the properties of data sets, groups, and channels in DIAdem. These properties are listed in the Property Display of the Data Portal in the Navigator and in the search input area for the advanced search.

Note  To determine the name of properties that you use in a script, enter the query in the search area of DIAdem NAVIGATOR and press <Ctrl-Shift-C>. Then DIAdem saves a script to the clipboard that also contains the script names of the properties.

Data Set Properties

Name — Specifies the name of the data set.

Script name name
Data type String
DataFinder No search possible
Note  If you load data to the Data Portal or save data from the Data Portal, DIAdem writes the filename to the Name data set property.


Description — Specifies the description of the data set.

Script name description
Data type String
DataFinder Search possible


Title — Specifies the title of the data set.

Script name title
Data type String
DataFinder Search possible


Author — Specifies the author of the data set.

Script name author
Data type String
DataFinder Search possible


Storage date — Specifies the date when you last saved the data set in DIAdem.

Script name datestring
Data type String
DataFinder No search possible
Note  If the Storage date property has no value in the loaded data set, DIAdem specifies the value from the Storage datetime property.
When you save data to a TDM file, DIAdem writes the current date and the current time to the properties Storage date, Storage time and Storage datetime. The time format of the storage date and storage time is the same format as the one you specify on the General tab in the Settings»DIAdem Settings dialog box.
DIAdem displays the properties Storage date and Storage time only in the Data Portal. You only can search for the Storage datetime property.


Storage time — Specifies the time when you last saved the data set in DIAdem.

Script name timestring
Data type String
DataFinder No search possible
Note  If the Storage time property has no value in the loaded data set, DIAdem specifies the value from the Storage datetime property.
When you save data to a TDM file, DIAdem writes the current date and the current time to the properties Storage date, Storage time and Storage datetime. The time format of the storage date and storage time is the same format as the one you specify on the General tab in the Settings»DIAdem Settings dialog box.
DIAdem displays the properties Storage date and Storage time only in the Data Portal. You only can search for the Storage datetime property.


Storage datetime — Specifies the date and the time when you last saved the TDM data set in DIAdem.

Script name datetime
Data type Date/Time
DataFinder Search possible
Note  When you save a TDM file, DIAdem writes the current date and the current time in the properties Storage date, Storage time, and Storage datetime.
DIAdem displays the property Storage datetime only in DIAdem NAVIGATOR. DIAdem displays the properties Storage date and Storage time only in the Data Portal.


Source name — Specifies the original name of the data set.

Script name sourceoriginalname
Data type String
DataFinder No search possible
Note  DIAdem writes the original name of the data set into the property sourceoriginalname when loading data. DIAdem displays this property only in the Data Portal. Use the name property of the data set to search for the original name of the data set in the advanced search.


RegisterTxt1 ... RegisterTxt3 — Specifies additional properties for descriptive information.

Script name registertxt1 ... registertxt3
Data type String
DataFinder No search possible


Filename — Specifies the name of the data set including the filename extension.

Script name fileName
Data type String
DataFinder Search possible
Note  This property does not exist in the Data Portal. When you load data from a file, DIAdem writes the filename to the channel property Source file.


Path — Specifies the path and the filename for the data set.

Script name fullpath
Data type String
DataFinder Search possible

Note  In version 2010 and later versions the file property Folder replaces the file property Fullpath. Searching for values of the Folder property is considerably faster.

Note  This property does not exist in the Data Portal. When you load data from a file, DIAdem writes the file path to the channel property Source file path and writes the filename to the channel property Source file.


Creation date— Specifies the time when the data set was generated in the operating system.

Script name createTime
Data type Date/Time
DataFinder Search possible
Note  This property does not exist in the Data Portal.


Modify date — Specifies when the data set was last modified in the operating system.

Script name modifyTime
Data type Date/Time
DataFinder Search possible
Note  This property does not exist in the Data Portal.


File size — Specifies the size of the data set.

Script name fileSize
Data type 32-bit integer
DataFinder No search possible
Note  DIAdem displays this property only in the Property Display of the Navigator. Use the DIAdem function DataFileSize to specify the size of saved TDM files, TDMS files, and DAT files.


DataPlugin name — Specifies the name of the DataPlugin that DIAdem uses to open the data set.

Script name dataPluginName
Data type String
DataFinder Search possible
Note  This property does not exist in the Data Portal. When you load a data file, DIAdem writes the name of the DataPlugin with which this data file was loaded into the channel property Data source type.


Error message — Specifies an error text if a DataPlugin cannot open a data set.

Script name errorLog
Data type String
DataFinder No search possible
Note  DIAdem displays this property only in the Property Display of the Navigator.


Index status — Specifies the status of data indexing from the search areas in the DataFinder.

Script name indexStatus
Data type Enumeration
DataFinder Search possible
Note  DIAdem displays this property only in the Property Display of the Navigator. The indexStatus property can have the following values:

Term

Explanation

eIndexedSuccess

The file has been indexed.

eIndexedTimeout

The time allowed for indexing has been exceeded.

eIndexedFailed

An error has occurred during indexing. The Error message property contains more details.

eIndexedNotYet The file has not been indexed yet.
eIndexedNotMyFile The file has a file extension for which a DataPlugin is registered. However the file format does not match this DataPlugin.
Note  You cannot search for values of the indexStatus property in the quick search. In the advanced search you cannot use the wildcards (? and *) when you search for values of the indexStatus property.

 

Channel Group Properties

Name — Specifies the name of the channel group.

Script name name
Data type String
DataFinder Search possible
Note  Adhere to the Name conventions for groups.


Description — Specifies the description of the channel group.

Script name description
Data type String
DataFinder Search possible


Index — Specifies the index of the channel group.

Script name index
Data type 32-bit integer
DataFinder No search possible
Note  DIAdem displays this property only in the Data Portal.


Source name — Specifies the original name of the channel group.

Script name sourceoriginalname
Data type String
DataFinder No search possible
Note  DIAdem writes the original name of the channel group into the property sourceoriginalname when loading data. DIAdem displays this property only in the Data Portal. Use the name property of the channel group to search for the original name of the channel group in the advanced search.


RegisterTxt1 ... RegisterTxt3 — Specifies additional properties for descriptive information.

Script name registertxt1 ... registertxt3
Data type String
DataFinder No search possible

 

Channel Properties


Name — Specifies the channel name.

Script name name
Data type String
DataFinder Search possible
Note  Adhere to the Name conventions for channels.


Description — Specifies the description of the channel.

Script name description
Data type String
DataFinder Search possible


Unit — Specifies the unit of the channel values.

Script name unit_string
Data type String
DataFinder Search possible


Minimum — Specifies the lowest channel value.

Script name minimum
Data type 64-bit floating point number
DataFinder Search possible
Note  This property is read-only. Select Update characteristic values from the context menu of the Data Portal to recalculate the value. Use the ChnCharacter command in scripts. If the minimum has not been calculated, the property has the value NoValue.
You use the RTT function to format the minimum value of time channels. The minimum value of text channels is always NoValue.


Maximum — Specifies the highest channel value.

Script name maximum
Data type 64-bit floating point number
DataFinder Search possible
Note  This property is read-only. Select Update characteristic values from the context menu of the Data Portal to recalculate the value. Use the ChnCharacter command in scripts. If the maximum has not been calculated, the property has the value NoValue. You use the RTT function to format the maximum value of time channels. The maximum value of text channels is always NoValue.


Length — Specifies the length of the channel.

Script name length
Data type 32-bit integer
DataFinder No search possible
Note  DIAdem displays the length property only in the Data Portal.


NoValues — Specifies whether the channel contains NoValues.

Script name novaluekey
Data type Enumeration
DataFinder Search possible
Note  The novaluekey property can accept the following values:

Script Term

Explanation

Yes

The channel contains NoValues.

No

The channel contains no NoValues.

Not calculated

Not calculated.


This property is read-only. Select Update characteristic values from the context menu of the Data Portal to recalculate the value. Use the ChnCharacter command in scripts.


Flags — Specifies whether DIAdem has set flags in the channel.

Script name flagkey
Data type Enumeration
DataFinder No search possible
Note  The flagkey property can accept the following values:
 

Script Term

Explanation

Yes

DIAdem has set flags.

No

DIAdem has set no flags.


This property is read-only. DIAdem does not save flags to a file. DIAdem displays this property only in the Data Portal.


Monotony — Specifies whether the values in the channel are monotonic increasing or monotonic decreasing.

Script name monotony
Data type Enumeration
DataFinder No search possible
Note  The monotony property can accept the following values:
 

Script Term

Interface Term, Explanation

not calculated

Not calculated

not monotone

Not monotone

decreasing

Decreasing

increasing

Increasing


This property is read-only. Select Update characteristic values from the context menu of the Data Portal to recalculate the value. Use the ChnCharacter command in scripts.
DIAdem displays this property only in the Data Portal.


Status — Specifies how the channel values were generated.

Script name status
Data type Enumeration
DataFinder No search possible
Note  The status property can accept the following values:
 

Script Term

Interface Term, Explanation

entered

Entered

read

Read

calculated

Calculated

measured

Measured

reduced

Reduced

readonly

Read-only


DIAdem has this property only for channels in the Data Portal.


Maximum length — Specifies the maximum length used up to the current time, for a dynamic channel, or the maximum possible length for a static channel.

Script name lengthmax
Data type 32-bit integer
DataFinder No search possible
Note  This property is read-only. DIAdem has this property only for internal channels in the Data Portal.


Index — Specifies the index of a channel in its group.

Script name groupindex
Data type 32-bit integer
DataFinder No search possible
Note  This property is read-only. DIAdem displays the property only in the Data Portal.


Number — Specifies the channel number.

Script name number
Data type 32-bit integer
DataFinder No search possible
Note  This property is read-only. DIAdem has this property only for internal channels in the Data Portal.


Display format — Specifies whether DIAdem displays the channels as numeric channels, time channels, or text channels.

Script name displaytype
Data type Enumeration
DataFinder Search possible
Note  The displaytype property can accept the following values:
 

Script Term

Interface Term, Explanation

numeric

Numeric

time

Time

text

Text

Note  If the data type of a channel is changed by a function or by the DisplayType channel property, you must first request the data type before you use other type-dependent properties.
Note  Use the DataType property from the object-oriented script interface for internal data instead of the earlier displaytype property.


Data type (Data Portal) — Displays the data type that DIAdem keeps the channels in internally.

Script name valuetype
Data type Enumeration
DataFinder No search possible
Note  The valuetype property can accept the following values:
 

Script Term

Explanation

float64

64-bit floating point number

string

Text


This property is read-only.

Note  Use the DataType property from the object-oriented script interface for internal data instead of the earlier valuetype property.


Data type (NAVIGATOR Property Display) — Displays the data type that the channels are saved in.

Script name datatype
Data type Enumeration
DataFinder No search possible
Note  The datatype property can accept the following values:
 

Script Term

Explanation

DT_Byte

8-bit integer

DT_Short

16-bit integer

DT_Long 32-bit integer
DT_LongLong 64-bit integer
DT_Float 32-bit floating point number
DT_Double 64-bit floating point number
DT_Date Date/time value
DT_String Text


The DataPlugins set the datatype property. This applies for all TDM DataPlugins, TDMS DataPlugins, DAT DataPlugins, and VBS DataPlugins.

Note  Use the DataType property from the object-oriented script interface for internal data instead of the earlier datatype property.


Group name — Specifies the name of the group that the channel is in.

Script name groupname
Data type String
DataFinder No search possible
Note  This property is read-only. DIAdem displays this property only in the Data Portal. Use the property group Name to search for a group name in the advanced search.


Data store source — Specifies the name of the data store from which DIAdem loaded the channel.

Script name sourcename
Data type String
DataFinder No search possible
Note  When you load data from a data store, DIAdem writes the name of the data store to the sourcename property. DIAdem has this property only in the Data Portal.


Source file — Specifies the name of the file from which DIAdem loaded the channel.

Script name sourcedatafilename
Data type String
DataFinder No search possible
Note  When you load data from a file, DIAdem writes the name of the file to the sourcedatafilename property. DIAdem has this property only in the Data Portal.


Source file path — Specifies the path of the file from which DIAdem loaded the channel.

Script name sourcedatafilepath
Data type String
DataFinder No search possible
Note  When you load data from a file, DIAdem writes the path of the file to the sourcedatafilepath property. DIAdem has this property only in the Data Portal.


Data source type — Specifies the name of the DataPlugin with which DIAdem loaded the channel.

Script name sourcetype
Data type String
DataFinder No search possible
Note  When DIAdem loads data, DIAdem writes the name of the DataPlugin to the sourcetype property. DIAdem has this property only in the Data Portal. Use the property DataPlugin name of the file to search for the name of a DataPlugin, in the advanced search.


Source context — Specifies the name of the channel group that the channel was in when it was loaded.

Script name sourceparentname
Data type String
DataFinder No search possible
Note  When DIAdem loads data, DIAdem writes the name of the channel group to the sourceparentname property. When you load from a data store that groups channels under other objects instead of grouping the channels into channel groups, DIAdem writes the name of the parent object to this property, instead of the name of the channel group.
DIAdem has this property only in the Data Portal.
Use the property group Name to search for a group name in the advanced search.


Source name — Specifies the original channel name.

Script name sourceoriginalname
Data type String
DataFinder No search possible
Note  DIAdem writes the original name of the channel into the property sourceoriginalname when loading data and creating channels. DIAdem displays this property only in the Data Portal. Use the name property of the channel to search for the original channel name in the advanced search.


Storage — Specifies how DIAdem stores the channel internally.

Script name representation
Data type Enumeration
DataFinder No search possible
Note  The representation property can accept the following values:
 

Script Term

Explanation

explicit

DIAdem stores the values explicitly.

implicit_linear

DIAdem stores the values explicitly linear.

registered DIAdem registers the channel.


This property is read-only. DIAdem displays this property only in the Data Portal.


Start value — Specifies the start value of the implicit channel.

Script name implicit_start
Data type 64-bit floating point number
DataFinder No search possible
Note  This property is read-only. DIAdem displays this property only in the Data Portal.


Step width — Specifies the step width of an implicit channel.

Script name implicit_increment
Data type 64-bit floating point number
DataFinder No search possible
Note  This property is read-only. DIAdem displays this property only in the Data Portal.




Waveform — Specifies whether the channel is a waveform channel.

Script name waveform
Data type Enumeration
DataFinder No search possible
Note  The waveform property can accept the following values:
 

Script Term

Explanation

Yes

Waveform

No

Not waveform


This property is read-only. DIAdem displays this property only in the Data Portal.


Waveform x-name — Specifies the name of the x-part of the waveform channel.

Script name wf_xname
Data type String
DataFinder Search possible


Waveform x-unit — Specifies the unit of the x-part of the waveform channel.

Script name wf_xunit_string
Data type String
DataFinder Search possible


Waveform x-offset — Specifies the offset of the x-part of the waveform channel.

Script name wf_start_offset
Data type 64-bit floating point number
DataFinder No search possible


Waveform x-step width — Specifies the step width of the x-part of the waveform channel.

Script name wf_increment
Data type 64-bit floating point number
DataFinder No search possible


Waveform x-start time — Specifies the start time of the x-part of the waveform channel.

Script name wf_start_time
Data type Date/Time
DataFinder Search possible




RegisterInt1 ... RegisterInt6 — Specifies additional properties for descriptive integer information.

Script name registerint1 ... registerint6
Data type 32-bit integer
DataFinder No search possible


RegisterVal1 ... RegisterVal6 — Specifies additional properties for descriptive non-integer information.

Script name registerval1 ... registerval6
Data type 64-bit floating point number
DataFinder No search possible


RegisterTxt1 ... RegisterTxt3 — Specifies additional properties for descriptive information.

Script name registertxt1 ... registertxt3
Data type String
DataFinder No search possible

Related Topics

Property: Value for Property <Data>

WAS THIS ARTICLE HELPFUL?

Not Helpful