Interface ZOSAPI::Analysis::IUserGridRGBData

Definition:

Properties and methods for configuring a 2D rgb grid User Analysis plot. This interface can be accessed via the IUserAnalysisData interface.

Members

• DataDX
• DataDY
• NumberOfXDataValues
• NumberOfYDataValues
• PlotDescription
• SetData
• SetDataRGB
• SetDataRGBSafe
• SetDataSafe
• SetXDataDimensions
• SetYDataDimensions
• ValueLabel
• XAxisMax
• XAxisMaxAuto
• XAxisMin
• XAxisMinAuto
• XAxisSymmetric
• XDataMax
• XDataMin
• XLabel
• XYAspectRatio
• YAxisMax
• YAxisMaxAuto
• YAxisMin
• YAxisMinAuto
• YAxisSymmetric
• YDataMax
• YDataMin
• YLabel

Properties

Property PlotDescription

Definition:

string ZOSAPI.Analysis.IUserGridRGBData.PlotDescription

Return type: string

Property XLabel

Definition:

string ZOSAPI.Analysis.IUserGridRGBData.XLabel

Return type: string

Property YLabel

Definition:

string ZOSAPI.Analysis.IUserGridRGBData.YLabel

Return type: string

Property ValueLabel

Definition:

string ZOSAPI.Analysis.IUserGridRGBData.ValueLabel

Return type: string

Property NumberOfXDataValues

Definition:

uint ZOSAPI.Analysis.IUserGridRGBData.NumberOfXDataValues

Return type: uint

Property XDataMin

Definition:

double ZOSAPI.Analysis.IUserGridRGBData.XDataMin

Return type: double

Property XDataMax

Definition:

double ZOSAPI.Analysis.IUserGridRGBData.XDataMax

Return type: double

Property DataDX

Definition:

double ZOSAPI.Analysis.IUserGridRGBData.DataDX

Return type: double

Property NumberOfYDataValues

Definition:

uint ZOSAPI.Analysis.IUserGridRGBData.NumberOfYDataValues

Return type: uint

Property YDataMin

Definition:

double ZOSAPI.Analysis.IUserGridRGBData.YDataMin

Return type: double

Property YDataMax

Definition:

double ZOSAPI.Analysis.IUserGridRGBData.YDataMax

Return type: double

Property DataDY

Definition:

double ZOSAPI.Analysis.IUserGridRGBData.DataDY

Return type: double

Property XAxisMin

Definition:

double ZOSAPI.Analysis.IUserGridRGBData.XAxisMin

Return type: double

Property XAxisMinAuto

Definition:

bool ZOSAPI.Analysis.IUserGridRGBData.XAxisMinAuto

Return type: bool

Property XAxisMax

Definition:

double ZOSAPI.Analysis.IUserGridRGBData.XAxisMax

Return type: double

Property XAxisMaxAuto

Definition:

bool ZOSAPI.Analysis.IUserGridRGBData.XAxisMaxAuto

Return type: bool

Property XAxisSymmetric

Definition:

bool ZOSAPI.Analysis.IUserGridRGBData.XAxisSymmetric

Return type: bool

Property YAxisMin

Definition:

double ZOSAPI.Analysis.IUserGridRGBData.YAxisMin

Return type: double

Property YAxisMinAuto

Definition:

bool ZOSAPI.Analysis.IUserGridRGBData.YAxisMinAuto

Return type: bool

Property YAxisMax

Definition:

double ZOSAPI.Analysis.IUserGridRGBData.YAxisMax

Return type: double

Property YAxisMaxAuto

Definition:

bool ZOSAPI.Analysis.IUserGridRGBData.YAxisMaxAuto

Return type: bool

Property YAxisSymmetric

Definition:

bool ZOSAPI.Analysis.IUserGridRGBData.YAxisSymmetric

Return type: bool

Property XYAspectRatio

Definition:

double ZOSAPI.Analysis.IUserGridRGBData.XYAspectRatio

Return type: double

Public functions

Function SetXDataDimensions

void ZOSAPI.Analysis.IUserGridRGBData.SetXDataDimensions(double xDataMin, double xDataMax)

Parameters:

• double xDataMin
• double xDataMax

Return type: void

Function SetYDataDimensions

void ZOSAPI.Analysis.IUserGridRGBData.SetYDataDimensions(double yDataMin, double yDataMax)

Parameters:

• double yDataMin
• double yDataMax

Return type: void

Function SetDataRGB

void ZOSAPI.Analysis.IUserGridRGBData.SetDataRGB(uint fullSize, uint numXValues, uint numYValues, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In]double[] rData, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In]double[] gData, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In]double[] bData)

Parameters:

• uint fullSize
• uint numXValues
• uint numYValues
• [In] double[] rData
• [In] double[] gData
• [In] double[] bData

Return type: void

Function SetDataRGBSafe

void ZOSAPI.Analysis.IUserGridRGBData.SetDataRGBSafe([In]double[,] rData, [In]double[,] gData, [In]double[,] bData)

Parameters:

• [In] double rData<!-- TODO:

• array {"type":"element","name":"array","attributes":{},"children":[{"type":"text","text":"[,]"}]} -->

• [In] double gData<!-- TODO:

• array {"type":"element","name":"array","attributes":{},"children":[{"type":"text","text":"[,]"}]} -->

• [In] double bData<!-- TODO:

• array {"type":"element","name":"array","attributes":{},"children":[{"type":"text","text":"[,]"}]} -->

Return type: void

Function SetData

void ZOSAPI.Analysis.IUserGridRGBData.SetData(uint fullSize, uint numXValues, uint numYValues, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In]double[] rgbData)

Parameters:

• uint fullSize
• uint numXValues
• uint numYValues
• [In] double[] rgbData

Return type: void

Function SetDataSafe

void ZOSAPI.Analysis.IUserGridRGBData.SetDataSafe([In]double[,,] rgbData)

Parameters:

• [In] double rgbData<!-- TODO:

• array {"type":"element","name":"array","attributes":{},"children":[{"type":"text","text":"[,,]"}]} -->

Return type: void