Entity Layout PARAM

Synopsis

• object_id str - The name of the entity that is associated with the parameter. This can be the type name of an entity defined in the entity library, in which case the parameter will be positioned on all the entities of that type. It can also be the the instance name of the required entity. The instance name should be the complete hierarchical name. When specifying a level name from the hierarchy, the instance name, not the type name, should be used. Each level in the hierarchy should be seperated by a '.'. Therefore the syntax for a complete hierarchical name is : top_level_instance_name.next_level_name. ... .last_level_name.
  The param information given to an instance overrides the param information of the library component.
  
  
• param_name str - The instance name of the parameter to be displayed.
  
  
• mode_name str - This specifies how the parameter is to be displayed. At the moment this can be one of VALUE, NAME_VALUE, ENT_ICON or PORT_ICON. VALUE displays the parameters value updating as it changes through the animation. NAME_VALUE displays the parameters name as well as its value. ENT_ICON allows enumerated parameters to be used to change the icon of the entity depending upon the parameters state (To keep a separation between the architecture specification in edl and the graphical specification in elf, the user should better use STATES instead). PORT_ICON allows enumerated parameters to be used to change the icon of a port depending upon the parameters state.
  
  
• param_x int - This specifies the x coordinate of the position to display the parameter. It is relative to the top left corner of the associated entity. Therefore a value of 0 will be level with the left of the entity.
  
  
• param_y int - This specifies the y coordinate of the position to display the parameter. It is relative to the top left corner of the associated entity. Therefore a value of 0 will be level with the top of the entity.
  
  

Example