Index: trunk/doc/design/02_data.html =================================================================== --- trunk/doc/design/02_data.html (revision 99) +++ trunk/doc/design/02_data.html (revision 100) @@ -126,16 +126,16 @@
{des2:00} +
{des2:17} The attributes of a wire-net are the same as the attributes of a network (see below).
{des2:17} +
{des2:18} The graphical representation of (a part of) a component is called symbol. -
{des2:18} +
{des2:19} A symbol is a group of ports, bus-ports, attributes, wire segments, bus segments, other symbols and decoration (drawing primitives - TODO: link the later chapter about this). When a symbol is placed on a schematic @@ -144,7 +144,7 @@ an instantiation-time cschem generated unique ID for each instance ("instance UID"). -
{des2:19} +
{des2:20} A symbol is usually part of a component, donating ports and attributes to the logical component. The simplest component is created by a single symbol. More complex components are created by a combination of multiple @@ -152,17 +152,17 @@ placed on non-graphical schematics sheets). Attribute collisions are handled as specified in chapter (TODO: reference to later chapter) -
{des2:20} +
{des2:21} Among the attributes of symbols instance is one called name, which is the project-unique identifier of the component the symbol instance contributes to. (TODO: refernece to later chapter: The refdes can be calculated from the name, e.g. hierarchy) -
{des2:21} +
{des2:22} A symbol can be marked being decoration, in which case it does not contribute to any component. -
{des2:22} +
{des2:23} A symbol can be used to describe connection between different schematics sheets, to represent (and reference to) a whole schematics sheet in a hierarchy (TODO: link later chapter), @@ -170,31 +170,31 @@ (TODO: THIS CHAPTER). -
{des2:23} +
{des2:24} The graphical representation of a port is called terminal. A terminal is modelled as a line. A terminal hosts a list of attributes. -
{des2:24} +
{des2:25} Similar to port, the bus-port's representation is called bus-terminal, it is also modeled as a line and hosts a list of attributes.
{des2:25} TODO: need to figure how we want do do non-graphical sheets +
{des2:26} TODO: need to figure how we want do do non-graphical sheets
{des2:26} The abstract schematics consits only of a few object types. Their +
{des2:27} The abstract schematics consits only of a few object types. Their parent-children relations are illustrated by the tree below:
-
{des2:00} +
{des2:28} The attributes of a symbol, terminal and bus-terminal are the same as the attributes of a component, port or bus-port, respectively (see below).
{des2:27} +
{des2:29} A component is a project-global object that has:
{des2:28} +
{des2:30} A port is a point of connect owned by a component. A port can connect a component to a net. -
{des2:29} +
{des2:31} A port is a component-local object that is created by a graphical symbol or a data symbol (TODO). -
{des2:30} +
{des2:32} A port has:
{des2:31} +
{des2:33} If there are multiple terminals with the same name within the same component (within one or multiple symbols; specified graphically or via data), their attributes are combined, with the usual attribute collision rules (TODO: reference to later chapter). -
{des2:32} +
{des2:34} A bus-port is a port with multiple "parallel" channels, each channel modelled as a separate port, called channel-port. A channel-port has a chan attribute that specifies which network the given chan @@ -232,11 +232,11 @@ will try to connect to when a bus or network is connected to the bus-port. -
{des2:33} Note: details on addressing networks by name is in a later chapter (TODO: link) +
{des2:35} Note: details on addressing networks by name is in a later chapter (TODO: link)
{des2:34} core attributes of a component + | ||
---|---|---|
{des2:36} core attributes of a component | ||
attribute | value | description |
uid | unique ID | cschem-generated UID |
connect | PORT:NET list | non-graphical connection; PORT is an existing port's name within the component; NET is the name of a net @@ -243,7 +243,7 @@ |
{des2:35} core attributes of a port + | ||
---|---|---|
{des2:37} core attributes of a port | ||
attribute | value | description |
uid | unique ID | cschem-generated UID |
name | name of the port | user assigned port name @@ -252,7 +252,7 @@ |
{des2:36} core attributes of a bus-port + | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{des2:38} core attributes of a bus-port | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attribute | value | description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
uid | unique ID | cschem-generated UID | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | name of the port | user assigned port name
@@ -262,10 +262,10 @@
2.5.2. networks-({des2:37} TODO: details of networks, without going too deep (we'll + ({des2:39} TODO: details of networks, without going too deep (we'll have separate chapters about netlists and hierarchy)) - {des2:38} + {des2:40} A network is:
{des2:39} + {des2:41} A network has a project-wise unique name netname, which is derived from the user specified name attribute and other factors (e.g. hierarchy). A network also has a cschem generated unique ID. - {des2:40} + {des2:42} A network is combined from:
|