Conference azur::mcc

4306.0. "V1.3 DECMCC MAP FILE FORMATS" by VERNA::V_GILBERT () Tue Dec 22 1992 11:37

	V1.3 DECMCC MAP FILE FORMATS
	----------------------------

1.0 Introduction

This document describes the format of the map files produced by the V1.3 DECmcc
Iconic Map presentation module (also referred to as the IMPM).

Some reference is made to previous versions of map files, but the focus of this
document is V1.3 map files. Any files produced by previous versions of the 
DECmcc Iconic Map presentation module will be read by the V1.3 IMPM, but if 
saved will be saved in the V1.3 format. If some aspect of the map file format 
is described without specific mention of a version, assume that it applies only
to V1.3 map files. 


2.0 Map File Format

The ASCII map files produced by the DECmcc Iconic Map presentation module are 
composed of two parts: a header and a body. The header contains general 
information which identifies the map file, including a version number and 
domain name. Also included in the header are a pointer to a backdrop file (if 
the map has a backdrop) and an indication of the last position on the map which
was viewed when the map was saved. The body contains information about each 
of the objects in the map. An object is described by a formatted block of 
lines, the first of which specifies an object type. These object blocks are 
separated by blank lines. 

2.1 A Note About Order and Spacing of Lines in Map Files

Note that spaces within the text of map file lines must appear as presented in 
this document. If not otherwise specified, each 'word' in a line of text is 
separated by one space. Also make note of the specified number of spaces which
appear before the text on each line.

For a given type of map object, the lines which describe that object must 
appear in the order presented in this document.

All text in this document which appears between <>'s is non-literal. This text 
serves as a place holder and describes the meaning of the actual text which 
would appear in that place in the map file.

2.2 Map File Header

The map file header begins and ends with a blank line. Other lines in the 
header include the following (each line begins with one space):

  version 3
  domain <domain name>
  background_pixmap <filename of valid pixmap>
  mcc_backdrop <filename of valid DECmcc vector backdrop>
  last_x <float> last_y <float>

All of these lines are optional, with the exception of "version 3", which must 
be present required. (V1.2 map files have "version 2".) If a backdrop is 
desired, only one of the two lines "background_pixmap..." and "mcc_backdrop..."
should be specified. If both are present, the background_pixmap will be used.  
By default no backdrop is specified. Default values for last_x and last_y are 
0.000000 (the coordinates of the lower left corner of the map scrolling area).

2.3 Map File Body

Each object specified in the body of a DECmcc map file falls into one of the 
following categories: entities, sub-entities and non-entities. Entities and 
sub-entities are registered members of the domain, non-entities are not.

Entities can be represented in a map file using one of the following types of 
objects: ICON, LINE_ENTITY, RING_ENTITY, BOX_ENTITY or DOUBLE_LINE_ENTITY.

Sub-entities can be represented in a map file using any of the following types 
of object: SUBICON, LINE_ENTITY, RING_ENTITY, BOX_ENTITY, DOUBLE_LINE_ENTITY.

Non-entities can be represented in a map file using one of the following types 
of objects: LINE, RING, BOX or DOUBLE_LINE.

Entities and sub-entities have associated with them a name, the text of which 
appears on the map and is logically connected to the map object for that entity
or sub-entity.

Non-entities are not named, but can be labeled in a map file using the TEXT 
object.

2.4 Map Object Blocks

The format of a ICON object block is as follows (the first line of the block 
begins with one space; all the others begin with three):

 object_type 1
   icon_file <filename>
   mcc_code <code>
   center_x <float> center_y <float>
   text_x <float> text_y <float>  
   ident_dt <integer>  
   name <object name>

The format of a LINE_ENTITY object block is as follows (the first line of the 
block begins with one space; all the others begin with three):

 object_type 15
   var <integer>
   width <float>
   start_x <float> start_y <float>
   stop_x <float> stop_y <float>
   text_x <float> text_y <float>
   mcc_code <code>
   name <object name>
   ident_dt <integer>

The format of a DOUBLE_LINE_ENTITY object block is the same as that of a 
LINE_ENTITY object block, except that the object_type is 16, not 15.

The format of a RING_ENTITY object block is as follows (the first line of the 
block begins with one space; all the others begin with three):

 object_type 14
   var <integer> 
   width <float>  
   radius <float>
   center_x <float> center_y <float>
   text_x <float> text_y <float>
   ident_dt <integer>
   mcc_code <code>
   name <object name>

The format of a BOX_ENTITY object block is as follows (the first line of the 
block begins with one space; all the others begin with three):

 object_type 17
   var <integer>
   width <float>
   x1 <float> y1 <float>
   x2 <float> y2 <float>  
   text_x <float> text_y <float>  
   ident_dt <integer> 
   mcc_code <code>
   name <object name>

The format of a SUBICON object block is as follows (the first line of the block
begins with one space; all the others begin with three):

 object_type 13  
   center_x <float> center_y <float>  
   ident_dt <integer> 
   mcc_code <code>
   name <object name>

The format of a LINE object block is as follows (the first line of the block 
begins with one space; all the others begin with three):

 object_type 2
   var <integer>  
   width <float>  
   start_x <float> start_y <float>  
   stop_x <float> stop_y <float>

The format of a DOUBLE_LINE object block is the same as that of a LINE object 
block, except that the object_type is 12, not 2.

The format of a RING object block is as follows (the first line of the block 
begins with one space; all the others begin with three):

 object_type 9
   var <integer>  
   width <float>  
   radius <float>  
   center_x <float> center_y <float>

The format of a BOX object block is as follows (the first line of the block 
begins with one space; all the others begin with three):

 object_type 11
   var <integer>
   width <float>  
   x1 <float> y1 <float>  
   x2 <float> y2 <float>

The format of a TEXT object block is as follows (the first line of the block 
begins with one space; all the others begin with three):

 object_type 7  
   text <text>  
   x <float> y <float>


3.0 Map File Naming Conventions

In order for a map file to be found and loaded by the IMPM when a domain is 
opened, the map file must be named using one of two formats. The first format 
is mcc_<id number>.mcc_map_<domain name>, where <id_number> is a unique id 
number which is generated using the internal identifier for <domain name>. 
This is the format which is used to name IMPM-generated map files. The second 
format is mcc_<domain name>.mcc_map. This is the format which should be used 
to name map files which are generated outside of the IMPM.

If an IMPM-generated map file is present for a given domain, that map file will
be used. If not, the IMPM will attempt to open a map file named using the 
second format. If no map file is found which matches that name, the entities 
in the domain will be placed in the map window using a default placement 
algorithm.


4.0 Backdrop File Format

DECmcc vector backdrop files are ASCII files which are formatted with a header
and a body. Their format is similar to that of DECmcc map files.

The header of a vector backdrop file begins and ends with a blank line. Other 
lines in the header include the following (each line begins with one space):

 version 3 
 domain <domain name>

The line which specifies version is required. The line which specifies a 
'domain' is optional, but recommended. If well chosen, the 'domain' name may 
indicate what background the backdrop portrays.

There are three types of objects which can be specified in a DECmcc vector 
backdrop file. They are: POLYGON's, FILLED_POLYGON's and BACKDROP_TEXT. 
POLYGON's and FILLED_POLYGON's (POLYGON's which are shaded grey) are specified 
as a series of vectors (lines), each with two floating point coordinates which 
specify the beginning and end of the line, respectively.

The body of a vector backdrop file is composed of object blocks, each separated
by a blank line. Object blocks which specify POLYGONS (and/or FILLED_POLYGONS) 
appear first. Following these blocks are those which specify BACKDROP_TEXT, if 
the backdrop has text. (Note that backdrop text differs from text found in a 
map file in that backdrop text cannot be deleted.) All three types of objects 
are optional.

The format of a POLYGON object block is as follows (the first line of the 
block begins with one space; all the others begin with three):

 object_type 3
   count <number of vectors>
   <float> <float>

The format of a FILLED_POLYGON object block is the same as that of a polygon, 
except that the object_type is 4, not 3.

For both types of polygons, the number of lines which specify coordinates must 
match the number in the "count" line for that block.

The format of a BACKDROP_TEXT object block is as follows (the first line of 
the block begins with one space; all the others begin with three):

 object_type 18
   text <text>
   x <float> y <float>


5.0 Disclaimer

While the DECmcc map files are ASCII files which can be created or manipulated 
using any text editor or program, the code which parses and loads the data 
within the map files is not guaranteed to gracefully identify and report all 
errors. Any errors encountered in map files created and saved by the V1.3 
DECmcc Iconic Map presentation module are clearly the responsibility of 
Network Management Frameworks. However, no time or effort will be given to 
debug maps created or modified by other software.

While we do not expect this to happen, the map file format described in this 
document is subject to change without notice.

Network Management Frameworks
December, 1992

Is there any plans on uppgrading the MCC_GRAPH tool to support V1.3 map format ?

/Stefan

    Can I give the information in .1 to a customer ??
    
    Thanks,
    Jill 

    Where do the values for mcc_code and ident_dt come from?
    
    Also, do you have an answer to .3?
    
    Thanks
    
    Gary