1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** GUIX Component */
17 /** */
18 /** Circular Gauge Management (Circular Gauge) */
19 /** */
20 /**************************************************************************/
21
22 #define GX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "gx_api.h"
28 #include "gx_circular_gauge.h"
29
30 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_circular_gauge_angle_range_set PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Kenneth Maxwell, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function checks for errors in circular gauge animation steps */
45 /* set call. */
46 /* */
47 /* INPUT */
48 /* */
49 /* circular_gauge Circular gauge control block */
50 /* info New circular gauge info */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* circular_gauge Circular gauge control block. */
59 /* animation_steps New animation steps. */
60 /* */
61 /* CALLED BY */
62 /* */
63 /* Application Code */
64 /* */
65 /* RELEASE HISTORY */
66 /* */
67 /* DATE NAME DESCRIPTION */
68 /* */
69 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
70 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
71 /* resulting in version 6.1 */
72 /* */
73 /**************************************************************************/
74
_gxe_circular_gauge_animation_set(GX_CIRCULAR_GAUGE * circular_gauge,INT steps,INT delay)75 UINT _gxe_circular_gauge_animation_set(GX_CIRCULAR_GAUGE *circular_gauge, INT steps, INT delay)
76 {
77 UINT status;
78
79 /* Check for appropriate caller. */
80 GX_INIT_AND_THREADS_CALLER_CHECKING
81
82 /* Check for invalid input pointers. */
83 if (circular_gauge == GX_NULL)
84 {
85 return GX_PTR_ERROR;
86 }
87
88 if (steps > 0 && delay <= 0)
89 {
90 return GX_INVALID_VALUE;
91 }
92
93 /* Call the actual gauge angle range set function. */
94 status = _gx_circular_gauge_animation_set(circular_gauge, steps, delay);
95
96 return status;
97 }
98
99
