| Embedded IDE Link™ CC | |
| On this page… |
|---|
When you create an object that accesses a string symbol stored in a register in your source code, the object constructor createobj returns an rstring object. createobj uses the information in your source code to set the properties of the object appropriately to match the code. Within the properties and their values you find all the information about the symbol, so that MATLAB understands how to handle the symbol in your MATLAB workspace.
To add to the properties of the rstring class, rstring objects inherit properties and methods from the rnumeric and register classes.
Classes that inherit from the registerobj base class always access data that resides in registers on the processor, not in memory locations.
Object properties can include both properties that the object inherits from its superclass, if any, and some properties that are unique to the class itself. For this reason, many objects in Embedded IDE Link CC share common properties; as you use the objects you will become familiar with the common and special properties for each.
| Property Name | Property Type | Default Value | Description |
|---|---|---|---|
arrayorder | {'col-major' 'row-major'} | row-major | Describes the ordering of the data moved from linear memory storage to n-dimensional arrays |
binarypt | int | 0 | Locates binary point needed to interpret fractional data types |
bitsperstorageunit | double | 8 | Bits per smallest register unit in the signal processor |
charconversion | mxArray | ASCII | Conversion character set applied for the characters in the referent string |
link | MATLAB handle | None | Object handle that identifies the object |
name | string | None | Name of the register symbol in the symbol table |
numberofstorageunits | double | 1 | Number of register units needed to represent the register object |
postpad | int | 0 | Number of bits of padding added at the end of the memory buffer. Added bits are ignored in final numeric values |
prepad | int | 0 | Number of bits of padding added at the beginning of the memory buffer. Added bits are ignored in final numeric values |
regname | mxArray | None | Name of the register on the signal processor |
represent | {signed, unsigned, float, fract, ufract} | signed | Reports the representation of the values in the object, such as numeric or string |
size | mxArray | 1 | Specifies the size of the array created in MATLAB from the data received from memory |
storageunitspervalue | double | 1 | Register units per register value in memory on the DSP |
timeout | double | 10 seconds | Time-out period for link methods |
wordsize | int | 0 | Valid bits per value (read-only) |
Like properties, methods for objects may come from the superclass or derive only from the class itself. For example, the cast and convert methods do not appear in all objects; listing them here indicates that the object does not inherit these methods but provides them itself.
| Name | Overloaded? | Description |
|---|---|---|
| equivalent | Yes | Return the equivalent numeric value for the input string |
| readnumeric | Yes | Return the data in memory as a numeric array in MATLAB |
| write | Yes | Write data to memory on the processor |
| writebin | Yes | Write data to memory on the processor as binary data – 0s and 1s |
| Rpointer Objects — Their Methods and Properties | Function Objects — Their Methods and Properties | |
| © 1984-2008- The MathWorks, Inc. - Site Help - Patents - Trademarks - Privacy Policy - Preventing Piracy - RSS |
| © 1984-2008- The MathWorks, Inc. - Site Help - Patents - Trademarks - Privacy Policy - Preventing Piracy - RSS |