Documentation

xPCParameter Class

Single run-time tunable parameter

Syntax

public class xPCParameter : xPCApplicationNotficationObject

Description

Namespace: MathWorks.xPCTarget.FrameWork

Syntax Language: C#

public class xPCParameter : xPCApplicationNotficationObject initializes a new instance of the xPCParameter class. An xPCParameter object represents a single specific real-time application parameter. You can tune the parameter using xPCParameter objects.

Methods

MethodDescription
xPCParameter.GetParamGet parameter values from target computer
xPCParameter.GetParamAsyncAsynchronous request to get parameter values from target computer
xPCParameter.SetParamChange value of parameter on target computer
xPCParameter.SetParamAsyncAsynchronous request to change parameter value on target computer

Events

EventDescription
xPCParameter.GetParamCompletedEvent when xPCParameter.GetParamAsync is complete
xPCParameter.SetParamCompletedEvent when xPCParameter.SetParamAsync is complete

Properties

PropertyC# Declaration SyntaxDescriptionException

BlockPath

public string BlockPath {get;}

Get the full block path name of the parameter for an instance of an xPCParameter object.

 

DataType

public string DataType {get;}

Get the Simulink® type, as a character string, of the parameter for an instance of an xPCParameter object.

 

Dimensions

public int[] Dimensions {get;}

Get an array that contains elements of dimension lengths.

 

Name

public string Name {get;}

Get the name of the parameter to an instance of an xPCParameter

 

ParameterId

public int ParameterId {get;}

Get the numeric index (identifier) that maps to an instance of an xPCParameter object.

 

Rank

public int Rank {get;}

Get the number of dimensions of the parameter

 

Value

public Array Value {get; set;}

Get and set the parameter value.

xPCException — When problem occurs, query xPCException object Reason property.

Introduced in R2011b

Was this topic helpful?