Properties: Overview of the Base Properties
- Updated2024-09-12
- 2 minute(s) read
Properties: Overview of the Base Properties
The Properties object provides a collection of all the properties for the Root object, for the ChannelGroup object, or for the Channel object. The properties include the base properties of the data model and the user-defined properties.
Overview of the base properties of the data model.
| Root | ChannelGroup | Channel |
| Name | Name | Name |
| description | description | description |
| title | root | unit_string |
| author | minimum | |
| datetime | maximum | |
| wf_xname | ||
| wf_xunit_string | ||
| wf_start_time | ||
| wf_start_offset | ||
| wf_increment | ||
| wf_samples | ||
| wf_time_pref |
For DIAdem to evaluate the channel properties minimum and maximum set the custom properties monotony and novaluekey.
You can assign the following selection terms to the custom property Monotony:
|
Selection term |
Explanation |
not calculated |
Not calculated |
not monotone |
Not monotone |
decreasing |
Decreasing |
increasing |
Increasing |
You can assign the following selection terms to the custom property novaluekey:
|
Selection term |
Explanation |
Yes |
The channel contains NoValues. |
No |
The channel contains no NoValues. |
Not calculated |
Not calculated. |
The following example generates an implicit channel with the appropriate channel properties, in the MyChnGroup channel group.
Dim XOffset : Set XOffset = File.GetNextStringValue(eString) Dim oChannelGroup: Set oChannelGroup = Root.ChannelGroups.Add("MyChnGroup") Dim oMyChn Set oMyChn = oChannelGroup.Channels.AddImplicitChannel("X", XOffset, cdbl(1/1200), 1201, eR64) Call oMyChn.Properties.Add("description", "Longitude") Call oMyChn.Properties.Add("unit_string", "°") Call oMyChn.Properties.Add("minimum", XOffset) Call oMyChn.Properties.Add("maximum", XOffset+1) Call oMyChn.Properties.Add("monotony", "increasing") Call oMyChn.Properties.Add("novaluekey", "No")
The following example generates a waveform channel with the appropriate channel properties, in the MyChnGroup channel group.
Dim oChannelGroup: Set oChannelGroup = Root.ChannelGroups.Add("MyChnGroup") Dim oBlock: Set oBlock = File.GetStringBlock() Dim oMyChn: Set oMyChn = oBlock.Channels.Add("Temperature",eR64) Call oMyChn.Properties.Add("unit_string", "°C") Call oMyChn.Properties.Add("wf_xname", "Time") Call oMyChn.Properties.Add("wf_xunit_string", "h") Call oMyChn.Properties.Add("wf_start_offset", 0) Call oMyChn.Properties.Add("wf_increment", 1) Call oChannelGroup.Channels.AddDirectAccessChannel(oChn)