Properties: Overview of the Base Properties

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 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 registertxt1 minimum
datetime registertxt2 maximum
registertxt1 registertxt3 wf_xname
registertxt2   wf_xunit_string
registertxt3   wf_start_time
    wf_start_offset
    wf_increment
    wf_samples
    wf_time_pref
    registerint1
    registerint2
    registerint3
    registerint4
    registerint5
    registerint6
    registerval1
    registerval2
    registerval3
    registerval4
    registerval5
    registerval6
    registertxt1
    registertxt2
    registertxt3

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.

Copy script

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.

Copy script

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)

WAS THIS ARTICLE HELPFUL?

Not Helpful