From 332f05f9aeb772ba31f6188aff07ec3150124384 Mon Sep 17 00:00:00 2001
From: Karl Sturm <72438620+sturmk@users.noreply.github.com>
Date: Fri, 4 Oct 2024 13:35:22 +0200
Subject: [PATCH] Updated documentation on the sample()-operator to include its
use for clocked discrete-time conversion
---
ModelicaReference/package.mo | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/ModelicaReference/package.mo b/ModelicaReference/package.mo
index e049ea2ee8..d874e78496 100644
--- a/ModelicaReference/package.mo
+++ b/ModelicaReference/package.mo
@@ -4669,13 +4669,17 @@ the return value changes discontinuously.]
extends ModelicaReference.Icons.Information;
annotation (Documentation(info="
-Trigger time events
+Trigger time events, or convert variables to clocked discrete-time domain
Syntax
sample(start, interval)
+y = sample(u, c)
Description
-Returns true and triggers time events at time instants
-"start + i*interval" (i=0, 1, ...).
+
Returns either:
+
+ - true and triggers time events at time instants
"start + i*interval" (i=0, 1, ...), or
+ - a clocked variable y that has c as associated clock and has the value of the left limit of u when c is active (that is the value of u just before the event of c is triggered)
+
During continuous integration the operator returns always
false. The starting time "start" and the sample
interval "interval" need to be parameter