Bitfield Objects — Their Methods and Properties

When you create an object that accesses a bitfield symbol in your source code, the object constructor createobj returns a struct object the includes the bitfield as members of the struct object. Bitfields are always parts of structures, so you create struct objects to access bitfields. 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 class, bitfield objects inherit properties and methods from the numeric and memoryobj classes.

Properties of Bitfield Objects

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 NameProperty TypeDefault ValueDescription

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

binarypt

int

0

Location of the binary point for fractional data types

bitsperstorageunit

double

8

Bits per addressable unit in the signal processor

endianness

{little, big}

little

Specifies whether the data is stored as little endian or big endian data

length

int

0

Number of bits in the bitfield

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

offset

int

0

Starting point of the bitfield in relation to bit 0

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

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 Embedded IDE Link CC methods

wordsize

int

32

Number of bits in a word for the processor

Methods of Bitfield Objects

Like properties, methods for objects may come from the superclass or derive only from the class itself.

NameOverloaded?Description
cast

Yes

Copy an object and change the data type for a value at the same time

convert

No

Change the data type for a value

copy

Yes

Copy an existing object by creating a new pointer to the object

display

Yes

Display the properties of the object

read

Yes

Return the contents of the memory location specified by the symbol

write

Yes

Write one or more values to the memory location

  


 © 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