Skip to content
Nimbus Driver Studio

Method State Caching Editor

Nimbus allows state caching to be enabled on a property-by-property basis. The Method State Caching Editor allows the driver developer to specify cache couplings. See the topic Understanding Nimbus State Caching for more information.

Properties invalidated when this property is set

This list contains the cache keys for any cached properties that will be invalidated whenever this method is invoked. Invoking this method will cause any previously cached values corresponding to the specified keys to be discarded.

To add a cache entry key to the invalidation list

Section titled “To add a cache entry key to the invalidation list”

  1. Click the ”+” button to add a new entry.

  2. Enter a cache entry key. Cache keys are expressed in one of the following three formats:

    • PropertyName

      Use this format to invalidate a property defined on the same interface as the method being configured.

      For example, if the method being configured is defined on the IAcme4301Trigger interface, entering Frequency indicates that whenever this method is invoked, any value previously cached by the implementation of IAcme4301Trigger.Frequency should be discarded.

    • InterfaceName.PropertyName

      Use this format to invalidate a property defined on the same class as the method being configured, where the property satisfies the implementation of the specified interface.

      For example, if the class containing the method being configured implements both the IIviDownconverterIFOutput and IIviDownconverterRFInput interfaces (both of which define a Frequency property), specifying IIviDownconverterIFOutput.Frequency indicates that whenever this method is invoked, any value previously cached by the implementation of IIviDownconverterIFOutput.Frequency should be discarded. Any value previously cached by the implementation of IIviDownconverterRFInput.Frequency will not be affected.

    • CollectionStyleRepCapItemPath.InterfaceName.PropertyName

      Use this format to invalidate a property defined on a collection-style repeated capability interface.

      In this case, a combination of repeated capability names and repeated capability selectors are specified in addition to the appropriate interface and property name. Examples include:

      • Channel[CHANNEL1].Trace[TRACE2].IAcme4321Acquisition.Frequency
      • Channel[*].Trace[TRACE2].IAcme4321Acquisition.Frequency
      • Channel[CHANNEL1].Trace[*].IAcme4321Acquisition.Frequency
      • Channel[CHANNEL1-CHANNEL3].Trace[*].IAcme4321Acquisition.Frequency
      • Channel[*].Trace[TRACE2,TRACE4].IAcme4321Acquisition.Frequency
      • Channel[CHANNEL1,CHANNEL3-CHANNEL5].Trace[*].IAcme4321Acquisition.Frequency

  3. Press the enter key.

See also

Section titled “See also”