SimEvents®

Manipulating Attributes of Entities

Writing Functions to Manipulate Attributes

To manipulate attributes via code, use the Attribute Function block. The block lets you access existing attributes of the arriving entity, modify the values of existing attributes, or create new attributes.

For examples that use the block, see

• Example: Setting Attributes

• Attribute Names Unique and Accessible in Composite Entity.

• Entity Combiner for Assembling Components demo

• Distributed Processing for Multi-Class Jobs demo, within the Distribution Center subsystem and its Service History Monitor subsystem

Procedure for Using the Attribute Function Block

The Attribute Function block has one entity input port and one entity output port. The block manipulates attributes of each arriving entity. To edit the computation, use this procedure:

1. Display the block's associated function in an editor window by double-clicking the Attribute Function block.

2. Write the first line of the function using arguments that reflect the attributes that the function manipulates. The arguments do not reflect input or output signals.

   Argument-Naming Rules   Input argument names must match the entity's attribute names. Output argument names must be out_ followed by the names of attributes to assign to the departing entity.

   The entity must possess any attributes named as input arguments of the function. If the entity does not possess an attribute named using an output argument of the function, then the block creates the attribute.

   The default function definition, below, indicates that the function called fcn uses the value of the attribute called Attribute1 to compute values of the attributes called Attribute1 and Attribute2.

   function [out_Attribute1, out_Attribute2] = fcn(Attribute1)

3. Write the function to implement your specific computation. The value of each attribute can be a real- or complex-valued array of any dimension and double data type, but cannot be a structure or frame. For each attribute, the dimensions and complexity must be consistent throughout the model. Also, the function must use the Embedded MATLAB™ subset. For more information, see Overview of the Embedded MATLAB Subset in the Embedded MATLAB documentation.

Note   If you try to update the diagram or run the simulation for a model that contains the Attribute Function block, then you must have write access to the current directory because the application creates files there.

Example: Incorporating Legacy Code

Suppose you already have an M-file function that represents your desired attribute manipulation and that uses the Embedded MATLAB subset. The function might or might not satisfy the argument-naming rules for the Attribute Function block. This example illustrates a technique that can help you satisfy the naming rule while preserving your legacy code.

1. Follow Argument-Naming Rule at Top Level

   The top level of the function associated with the Attribute Function block must satisfy the argument-naming rule. In this example, the function reads the entity's x attribute, so the function's input argument must be called x. The function assigns a new value to the entity's x attribute, so the function's output argument must be called out_x.

   function out_x = update_x_attribute(x)

2. Invoke Legacy Code

   Using the variable names x and out_x, invoke your legacy code. The usage below assumes that you have called the function mylegacyfcn.

   out_x = mylegacyfcn(x);

3. Include Legacy Code

   Include your legacy code as either a subfunction or an extrinsic function; see Calling Functions in the Embedded MATLAB Subset in the Embedded MATLAB documentation for details.

   In your legacy code, the function name and the number of input and output arguments must be compatible with the invocation above. However, the legacy code does not need to follow the argument-naming rules for the Attribute Function block. Below is an example of a function that is compatible with the invocation above.

   function outp = mylegacyfcn(inp)
   
   if inp < 0
      outp = 0;
   else
      if ((inp >= 0) && (inp < 1))
         outp = 0.25;
      else
         outp = 5;
      end
   end

Back to Top

Using Block Diagrams to Manipulate Attributes

To manipulate attributes using blocks to perform the computation, use an arrangement as in the figure below. You can vary the number of outputs of the Get Attribute block, the number of inputs of the Set Attribute block, or the connections or contents of the Discrete Event Subsystem block.

Top-Level Model

Subsystem Contents

The key components are in the table.

Back to Top

Setting Attributes of Entities

Accessing Attributes of Entities