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 separated 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 parameter's 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.
  
  
• Parameter position - Where a parameter is drawn on the screen depends on its modifier, i.e. on whether or not it is static.
  Non-static parameters are drawn as follows:
  • param_x int, param_y int specify the x and y coordinates of the position where the value of parameter is to be displayed. They are relative to the top left corner of the associated entity, e.g. a value of 0,0 will cause the parameter to be displayed at the top left hand corner of the entity.
    
    
  Static parameters are drawn as follows:
  • param_x int, param_y int specify the x coordinate of the position to display both the name and the value of the parameter. They are relative to the top left corner of the screen.
    
    

Example

The Entity Layout format is a list of lines each of which should have one of the following format:
object_id : POSITION (x,y) info1 info2 info3
or
object_id : PORT port_name SIDE entity_side POSITION port_position position_string ICON icon_file
or
object_id : PARAM param_name MODE mode_name POSITION (param_x,param_y)
or
object_id : STATES state_name1:gif_image1 state_name2:gif_image2 ...
or
object_id : LINKCORNER src_entity src_port dest_entity dest_port no_of_corners (cx1,cy1) ...


where object_id can be either an entity name (which has been declared in the entity library of the edl file, or a component name defined as a CHILD of a COMPENTITY or as an AENTITY in the STRUCTURE.