| Embedded IDE Link™ CC | |
| On this page… |
|---|
When you create an object that accesses an enumerated symbol in your source code, the object constructor createobj returns an enum 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 enum class, enum objects inherit properties and methods from the numeric and memoryobj classes.
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 |
|---|---|---|---|
address | mxArray | [0 0] | Memory address of the symbol, in [Offset Page] format |
arrayorder | {col-major,row-major} | row-major | Ordering of values when moving data from linear memory storage to N-D arrays in MATLAB |
bitsperstorageunit | double | 8 | Bits per smallest addressable unit in the signal processor |
endianness | {little, big} | little | Specifies whether the data is stored as little endian or big endian data |
label | mxArray | N/A | Lists the enumerated labels for the object |
link | MATLAB handle | None | Object handle that identifies the object |
name | string | None | Name of the embedded symbol in the symbol table |
numberofstorageunits | double | 1 | Number of memory units needed to represent the 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 |
represent | {signed, unsigned, float, fract, ufract} | signed | Reports the data type of the values |
size | mxArray | 1 | Specifies the size of the array created in MATLAB from the data received from memory |
storageunitspervalue | int | 32 | Addressable units (au) per value in memory. May be less than one when you use bit packing |
timeout | double | 10 seconds | Time-out period for link methods |
value | mxArray | 0 | Contains a vector of the enumerated type |
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 |
|---|---|---|
| display | Yes | Display the properties of the object |
| equivalent | No | Return the equivalent string or numeric value based on the input argument |
| Bitfield Objects — Their Methods and Properties | Pointer 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 |