Avoid overloading of a Windows API function making compilation fail under Windows
[scilab.git] / scilab / modules / scicos_blocks / includes / scoGetProperty.h
1 /*  Scicos
2 *
3 *  Copyright (C) INRIA - METALAU Project <scicos@inria.fr>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 *
19 * See the file ./license.txt
20 */
21 /**
22 \file scoGetProperty.h
23 \author Benoit Bayol
24 \version 1.0
25 \date September 2006 - January 2007
26 \brief Header File of the scoGetProperty.c file 
27 */
28
29 #ifndef __SCO_GET_PROPERTY_H__
30 #define __SCO_GET_PROPERTY_H__
31
32 #include "dynlib_scicos_blocks.h"
33 #include "scoBase.h"
34
35 /**
36 \brief Get the internal time in seconds (micro or nano second max resolution)
37 \return double
38 */
39 SCICOS_BLOCKS_IMPEXP double scoGetRealTime(void);
40
41
42 /**
43 \brief Get the Handle of the Scope Window in the ScopeMemory
44 \param pScopeMemory a pointer on a ScopeMemory
45 \return hScopeWindow
46 */
47 SCICOS_BLOCKS_IMPEXP scoLongInteger scoGetHandleScopeWindow(ScopeMemory * pScopeMemory);
48
49 /**
50 \brief Get the Handle of Axes i in the ScopeMemory where i is the index of the axes
51 \param pScopeMemory a pointer on a ScopeMemory
52 \param i index of an Axes
53 \return hAxes[i]
54 */
55 SCICOS_BLOCKS_IMPEXP scoLongInteger scoGetHandleAxes(ScopeMemory * pScopeMemory, int i);
56
57 /**
58 \brief Get the Handle of the ShortDraw i,j in the ScopeMemory where i is the index of the axes and j is the index of the curve in the axes
59 \param pScopeMemory a pointer on a ScopeMemory
60 \param i index of an Axes
61 \param j index of a curve
62 \return hShortDraw[i][j]
63 */
64 SCICOS_BLOCKS_IMPEXP scoLongInteger scoGetHandleShortDraw(ScopeMemory * pScopeMemory, int i, int j);
65
66 /**
67 \brief Get the Handle of the LongDraw i,j in the ScopeMemory where i is the index of the axes and j is the index of the curve in the axes
68 \param pScopeMemory a pointer on a ScopeMemory
69 \param i index of an Axes
70 \param j index of a curve
71 \return hLongDraw[i][j]
72 */
73 SCICOS_BLOCKS_IMPEXP scoLongInteger scoGetHandleLongDraw(ScopeMemory * pScopeMemory, int i, int j);
74
75 /**
76 \brief Get the NewDraw value of Axes i in the ScopeMemory
77 \param pScopeMemory a pointer on a ScopeMemory
78 \param i index of an axes
79 \return new_draw[i]
80 */
81 SCICOS_BLOCKS_IMPEXP scoInteger scoGetNewDraw(ScopeMemory * pScopeMemory, int i);
82
83 /**
84 \brief Get the PeriodCounter of Axes i in the ScopeMemory
85 \param pScopeMemory a pointer on a ScopeMemory
86 \param i index of an axes
87 \return period_counter[i]
88 */
89 SCICOS_BLOCKS_IMPEXP scoInteger scoGetPeriodCounter(ScopeMemory * pScopeMemory, int i);
90
91 /**
92 \brief Get the TraceLength of the Axes i in the ScopeMemory
93 \param pScopeMemory a pointer on a ScopeMemory
94 \param i index of an axes
95 \return trace_length[i]
96 */
97 SCICOS_BLOCKS_IMPEXP scoInteger scoGetLongDrawSize(ScopeMemory * pScopeMemory, int i);
98
99 /**
100 \brief Get the NumberOfSubwin in the ScopeMemory
101 \param pScopeMemory a pointer on a ScopeMemory
102 \return number_of_subwin[i]
103 */
104 SCICOS_BLOCKS_IMPEXP scoInteger scoGetNumberOfSubwin(ScopeMemory * pScopeMemory);
105
106 /**
107 \brief Get the NumberOfCurvesBySubwin of Axes i in the ScopeMemory
108 \param pScopeMemory a pointer on a ScopeMemory
109 \param i index of an axes
110 \return number_of_curves_by_subwin[i]
111 */
112 SCICOS_BLOCKS_IMPEXP scoInteger scoGetNumberOfCurvesBySubwin(ScopeMemory * pScopeMemory,int i);
113
114 /**
115 \brief Get the WindowID of the Scope Graphic Window in the ScopeMemory
116 \param pScopeMemory a pointer on a ScopeMemory
117 \return win_id
118 */
119 SCICOS_BLOCKS_IMPEXP scoInteger scoGetWindowID(ScopeMemory * pScopeMemory);
120
121 /**
122 \brief Get the BufferSize of the Axes i in the ScopeMemory
123 \param pScopeMemory a pointer on a ScopeMemory
124 \param i index of an axes
125 \return buffer_sze[i]
126 */
127 SCICOS_BLOCKS_IMPEXP scoInteger scoGetShortDrawSize(ScopeMemory * pScopeMemory,int i);
128
129 /**
130 \brief Get the Period of the Axes i in the ScopeMemory
131 \param pScopeMemory a pointer on a ScopeMemory
132 \param i index of an axes
133 \return period[i]
134 */
135 SCICOS_BLOCKS_IMPEXP scoDouble scoGetPeriod(ScopeMemory * pScopeMemory, int i);
136
137
138 /**
139 \brief Get the Pointer on the ScopeWindow
140 \param pScopeMemory a pointer on a ScopeMemory
141 \return an scoGraphicalObject which is the pointer on the Scope Window
142 */
143 SCICOS_BLOCKS_IMPEXP scoGraphicalObject scoGetPointerScopeWindow(ScopeMemory * pScopeMemory);
144
145 /**
146 \brief Get the Pointer on Axes[i]
147 \param pScopeMemory a pointer on a ScopeMemory
148 \param i index of an axe
149 \return an scoGraphicalObject which is the pointer on the Axes[i]
150 */
151 SCICOS_BLOCKS_IMPEXP scoGraphicalObject scoGetPointerAxes(ScopeMemory * pScopeMemory, int i);
152
153 /**
154 \brief Get the Pointer on ShortDraw[i][j]
155 \param pScopeMemory a pointer on a ScopeMemory
156 \param i index of an axe
157 \param j index of a curve in the Axes[i]
158 \return an scoGraphicalObject which is the pointer on the ShortDraw[i][j]
159 */
160 SCICOS_BLOCKS_IMPEXP scoGraphicalObject scoGetPointerShortDraw(ScopeMemory * pScopeMemory, int i, int j);
161
162 /**
163 \brief Get the Pointer on LongDraw[i][j]
164 \param pScopeMemory a pointer on a ScopeMemory
165 \param i index of an axe
166 \param j index of a curve in the Axes[i]
167 \return an scoGraphicalObject which is the pointer on the LongDraw[i][j]
168 */
169 SCICOS_BLOCKS_IMPEXP scoGraphicalObject scoGetPointerLongDraw(ScopeMemory * pScopeMemory, int i, int j);
170
171 /**
172 \brief Get status of activation of the block
173 \return 1 activated or 0 deactivated (by default)
174
175 */
176 SCICOS_BLOCKS_IMPEXP scoInteger scoGetScopeActivation(ScopeMemory * pScopeMemory);
177
178 #endif