Cicode Programming Reference > Cicode Function Categories > Trend Functions Introduction > TrnGetDisplayMode

TrnGetDisplayMode

Returns the display mode of the selected trend pen. The display mode is set using TrnSetDisplayMode.

Syntax

TrnGetDisplayMode(AN, PenNumber)

AN:

The AN of the chosen trend.

PenNumber:

The trend pen number:

0 - The pen currently in focus.

1...8 - Pen1. . .Pen8.

Return Value

An integer representing the trend's display mode:

Invalid/Gated trend options:

0 - Convert invalid/gated trend samples to zero.

1 - Leave invalid/gated trend samples as they are.

Ordering trend sample options:

0 - Order returned trend samples from oldest to newest.

2 - Order returned trend samples from newest to oldest.

Condense method options:

0 - Set the condense method to use the mean of the samples.

4 - Set the condense method to use the minimum of the samples.

8 - Set the condense method to use the maximum of the samples.

12 - Set the condense method to use the newest of the samples.

Stretch method options:

0 - Set the stretch method to step.

128 - Set the stretch method to use a ratio.

256 - Set the stretch method to use raw samples.

Gap Fill Constant option:

n - the number of missed samples that the user wants to gap fill) x 4096.

Display as Periodic options:

0 - Display according to trend type.

1048576 - display as periodic regardless of trend type.

Related Functions

TrnSetDisplayMode

Example

int DisplayMode = TrnGetDisplayMode (10, 7)
/* Returns The Display Mode of pen 7 for the trend at AN 10.*/

See Also

Trend Functions