Reference Guide
interface IGraph2
A Graph object is used to plot a response curve for a particular model. Graphs usually included with product component libraries are the whole system graph, the crossover frequency graph, and the polar plot graph.
Definition
- interface IGraph : IDispatch
-
- {
-
-
- [id(0), propget]
-
- HRESULT Name([out, retval] BSTR* rval);
-
- [propget]
-
- HRESULT Title([out, retval] BSTR* rval);
-
- [propget]
-
- HRESULT ChannelCount([out, retval] short* rval);
-
- [propget]
-
- HRESULT KeyFrequencies([out, retval] IValueList** rval);
-
- [propget]
-
- HRESULT KeyInputLevels([out, retval] IValueList** rval);
-
- HRESULT Prepare();
-
- HRESULT CalcPoint([in] double inputlevel, [in] double freq, [in, defaultvalue(0)] int chan, [out, retval] double* rval);
- };
-
- interface IGraph2 : IGraph
-
- {
-
-
- HRESULT CalcPointByFreqIndex([in] double inputlevel, [in] long freqindex, [in, defaultvalue(0)] int chan, [out, retval] double* rval);
- };
-
Descriptions
[id(0), propget]
HRESULT Name([out, retval] BSTR* rval); |
The short name of the graph. |
[propget]
HRESULT Title([out, retval] BSTR* rval); |
The descriptive name of the graph. |
[propget]
HRESULT ChannelCount([out, retval]short* rval); |
The number of channels that points can be calculated for. "Multiple channels" in this context refers to multiple outputs from the model that is being graphed. For example, the crossover frequency graph has a channel for each output of the band-split filter. |
[propget]
HRESULT KeyFrequencies([out,retval] IValueList** rval); |
The key frequencies that I/O curves should be plotted at. |
[propget]
HRESULT KeyInputLevels([out,retval] IValueList** rval); |
The key input levels that frequency response curves should be plotted at. |
| HRESULT Prepare(); |
Make initial calculations based on current parameters. This method is usually called once each time a graph is redrawn. |
| HRESULT CalcPoint([in] double inputlevel, [in] double freq, [in, defaultvalue(0)] int chan, [out, retval] double* rval); |
Calculate a point at a particular input level and frequency. |
| HRESULT CalcPointByFreqIndex([in] double inputlevel, [in] long freqindex, [in, defaultvalue(0)] int chan, [out, retval] double* rval); |
Calculate a point at a particular input level and frequency index. The index refers to a frequency in the array specified using SetGraphFrequencies or SetGraphFrequenciesSafe. These two methods are part of the IProductWithUtilities3 interface to the product component object for which the graph is being generated. These methods improve the performance of CalcPoint when the same set of frequencies are used repeatedly for graphing. |
|