fipref Object Properties

On this page…
Display, Data Type Override, and Logging Properties Setting fipref Object Properties

Display, Data Type Override, and Logging Properties

The following properties of fipref objects are always writable:

• FimathDisplay — Display options for the local fimath attributes of a fi object

• DataTypeOverride — Data type override options

• LoggingMode — Logging options for operations performed on fi objects

• NumericTypeDisplay — Display options for the numeric type attributes of a fi object

• NumberDisplay — Display options for the value of a fi object

These properties are described in detail in the Property Reference. To learn how to specify properties for fipref objects in Fixed-Point Toolbox software, refer to Setting fipref Object Properties.

Back to Top

Setting fipref Object Properties

Setting fipref Properties at Object Creation

You can set properties of fipref objects at the time of object creation by including properties after the arguments of the fipref constructor function. For example, to set NumberDisplay to bin and NumericTypeDisplay to short,

P = fipref('NumberDisplay', 'bin', ...
           'NumericTypeDisplay', 'short')
 
P =
         NumberDisplay: 'bin'
    NumericTypeDisplay: 'short'
         FimathDisplay: 'full'
           LoggingMode: 'Off'
      DataTypeOverride: 'ForceOff'

Using Direct Property Referencing with fipref

You can reference directly into a property for setting or retrieving fipref object property values using MATLAB structure-like referencing. You do this by using a period to index into a property by name.

For example, to get the NumberDisplay of P,

P.NumberDisplay

ans =

bin

To set the NumericTypeDisplay of P,

P.NumericTypeDisplay = 'full'
 
P =
         NumberDisplay: 'bin'
    NumericTypeDisplay: 'full'
         FimathDisplay: 'full'
           LoggingMode: 'Off'
      DataTypeOverride: 'ForceOff'

Back to Top

Constructing fipref Objects

Using fipref Objects to Set Display Preferences

© 1984-2012- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS