Documentation

xPCFileScope Class

Access to file scopes

Syntax

public class xPCFileScope : xPCScope

Description

Namespace: MathWorks.xPCTarget.FrameWork

Syntax Language: C#

public class xPCFileScope : xPCScope initializes a new instance of the xPCFileScope class.

There are the following limitations:

  • You can have at most eight files open on the target computer at the same time.

  • The largest single file that you can create on the target computer is 4 GB.

  • A fully qualified folder name can have a maximum of 248 characters, including the drive letter, colon, and backslash.

  • A fully qualified file name can have a maximum of 260 characters: The file part can have at most 12 characters: eight for the file name, one for the period, and at most three for the file extension. A file name longer than eight characters is truncated to six characters followed by '~1'.

  • Do not write data to the private folder on your target computer. It is reserved for Simulink® Real-Time™ internal use.

Methods

The xPCFileScope class inherits methods from xPCScope Class.

Events

The xPCFileScope class inherits events from xPCScope Class.

Properties

The xPCFileScope class inherits its other properties from xPCScope Class.

PropertyC# Declaration SyntaxDescriptionException

AutoRestart

public bool AutoRestart {get; set;}

Get or set the file scope autorestart setting. AutoRestart is a Boolean. Values are 'on' and 'off'.

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

DataTimeObject

public xPCDataHostScSignalObject DataTimeObject {get;}

Get data time object.

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

DynamicMode

public bool DynamicMode {get; set;}

Get or set ability to create multiple log files for file scopes. Values are 'on' and 'off'. By default, the value is 'off'.

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

FileMode

public SCFILEMODE FileMode {get; set;}

Get or set write mode of file. See xPCFileMode Enumerated Data Type.

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

FileName

public string FileName {get; set;}

Get or set file name for scope.

 

MaxWriteFileSize

public uint MaxWriteFileSize {get; set;}

Get or set the maximum file size in bytes allowed before incrementing to the next file.

When the size of a log file reaches MaxWriteFileSize, the software creates the next numbered file name. It continues logging data, incrementing to the next file as required, until it reaches the highest log file number you specified.

If the software cannot create additional log files, it overwrites the first log file.

This value must be a multiple of WriteSize. Default is 536870912.

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

Signals

public xPCTargetScopeSignalCollection Signals {get;}

Get collection of file scope signals (xPCFileScopeSignalCollection) assigned to this scope object.

 

TriggerSignal

public xPCTgtScopeSignal TriggerSignal {get; set;}

Get or set file scope signal (xPCFileScopeSignal) used to trigger the scope.

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

WriteSize

public int WriteSize {get; set;}

Get or set the unit number of bytes for memory buffer writes. The memory buffer accumulates data in multiples of write size. WriteSize must be multiple of 512.

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

Introduced in R2011b

Was this topic helpful?