MATLAB Link for Code Composer Studio Development Tools    

Link Properties

The MATLAB Link for Code Composer Studio provides links to your target hardware so you can communicate with processors for which you are developing systems and algorithms. Each link comprises two objects--a CCS IDE object and an RTDX Interface object. The link objects are not separable; the RTDX object is a subclass of the CCS IDE object. Each of the link objects has multiple properties. To configure the links for CCS IDE and RTDX, you set parameters that define details such as the desired target board, the target processor, the timeout period applied for communications operations, and a number of other values. Since the MATLAB Link for Code Composer Studio uses objects to create the links, the parameters you set are called properties and you treat them as properties when you set them, retrieve them, or modify them.

This section details the properties for the links for CCS IDE and RTDX. First the section provides tables of the properties, for quick reference. Following the tables, the section offers in-depth descriptions of each property, its name and use, and whether you can set and get the property value associated with the property. Descriptions include a few examples of the property in use.

MATLAB users may find much of this handling of objects familiar. Objects, or links as we call them in the MATLAB Link for Code Composer Studio, behave like objects in MATLAB and the other object-oriented toolboxes. For C++ programmers, this discussion of object-oriented programming is likely to be a review.

Quick Reference to Link Properties

The following table lists the properties for the links in the MATLAB Link for Code Composer Studio. The second column tells you which object the property belongs to. Knowing which property belongs to each object in a link tells you how to access the property.

Table 1-3: Properties for the Links in MATLAB Link for Code Composer Studio 
Property Name
Applies to Which Link?
User Settable?
Description
apiversion
CCS IDE
No
Reports the version number of your CCS API.
boardnum
CCS IDE
Yes/initially
Specifies the index number of a board that CCS IDE recognizes.
ccsappexe
CCS IDE
No
Specifies the path to the CCS IDE executable. Read-only property.
numchannels
RTDX
No
Contains the number of open RTDX channels for a specific link.
page
CCS IDE
Yes/default
Stores the default memory page for reads and writes.
procnum
CCS IDE
Yes/at start only
Stores the number CCS Setup Utility assigns to the processor.
rtdx
RTDX
No
Specifies RTDX in a syntax.
rtdxchannel
RTDX
No
A string. Identifies the RTDX channel for a link.
timeout
CCS IDE
Yes/default
Contains the global timeout setting for the link.
version
RTDX
No
Reports the version of your RTDX software.

Some properties are read only--you cannot set the property value. Other properties you can change at all times. If the entry in the User Settable column is "Yes/initially", you can set the property value only when you create the link. Thereafter it is read only.


  Overloaded Functions for Links Details About the Link Properties