Predefined schematic attributes

A number of schematic feature classes' predefined attributes are used by Schematics. These attributes have predefined names, allowing Schematics to automatically deal with them when they are configured.

Some predefined attributes are completely managed by Schematics by default and automatically stored in system fields in the schematic feature classes in the schematic dataset at the schematic feature creation; for example, spatial or topological attributes. Those attributes can be redefined if you want Schematics to behave in a different way than the default one. For example, for any node schematic feature associated with a GIS feature, the ROTATION field in the schematic feature class is populated by default with the same GIS feature's ROTATION field value at the generation. If you want this field to be populated by another value, you can configure the InitialRotation predefined attribute on the schematic feature class.

The table below lists all the predefined attributes that can be configured on schematic feature classes depending on their type:

Predefined attribute name

Schematic feature class Type

Description

AbsolutePosition

Node On Link

absolute position on the reference link

ContainerBottomMargin

Node

container margin at bottom

ContainerLeftMargin

Node

container margin at left

ContainerMargin

Node

constant container margin at right, left, top, and bottom

ContainerMarginSymbolsFlag

Node

indicates whether the margin includes the symbol size

ContainerMarginUnit

Node

container margin unit

ContainerRightMargin

Node

container margin at right

ContainerTopMargin

Node

container margin at top

EndFlag

Node

indicates whether it's an end node schematic feature

ExtremityNode

Link, Sub Link

extremity node or node on link identifier

ExtremityPortNumber

Link, Sub Link

port number on the extremity node or node on link symbol

FCN

Node, Node On Link, Link, Sub Link

name of the feature class or table that contains the GIS feature/object associated with the schematic feature

FDSN

Node, Node On Link, Link, Sub Link

name of the data source to connect the geodatabase that contains the GIS feature/object associated with the schematic feature

FOID

Node, Node On Link, Link, Sub Link

OBJECTID of the GIS feature/object associated with the schematic feature

InitialListPoints

Link

list of initial vertices

InitialXPosition

Node

initial x-coordinate

InitialYPosition

Node

initial y-coordinate

InitialRotation

Node

initial rotation angle in degrees

OriginNode

Link, Sub Link

origin node or node on link identifier

OriginPortNumber

Link, Sub Link

port number on the origin node or node on link symbol

PEN

Node, Node On Link, Link, SubLink

name of the parent schematic feature that is related to the schematic feature; for example, container name

PTN

Node, Node On Link, Link, Sub Link

name of the schematic feature class that implements the parent that is related to the schematic feature

ReferenceLink

Node On Link, Sub Link

reference link identifier

RelativePosition

Node On Link

relative position on the reference link

RootFlag

Node

indicates whether it's a root node schematic feature

The table below lists the type of values each predefined attribute is supposed to return and the system field to which this attribute is automatically related when such a field exists in the schematic feature class:

Predefined attribute name

Type of value

Related system field

AbsolutePosition

double (see Note 1)

INITIALPOSITION

ContainerBottomMargin

double

No field

ContainerLeftMargin

double

No field

ContainerMargin

double

No field

ContainerMarginSymbolsFlag

see Note 2

No field

ContainerMarginUnit

0, 1, or 2 (see Note 3)

No field

ContainerRightMargin

double

No field

ContainerTopMargin

double

No field

EndFlag

see Note 4

No field

ExtremityNode

string

TOTID

ExtremityPortNumber

integer

TOPORT

FCN

string

No field

FDSN

string

No field

FOID

string

No field

InitialListPoints

string

PROPERTYSET

InitialXPosition

double

INITIALX

InitialYPosition

double

INITIALX

InitialRotation

double

ROTATION

OriginNode

string

FROMTID

OriginPortNumber

integer

FROMPORT

PEN

string

No field

PTN

string

No field

ReferenceLink

string

REFERENCELINK

RelativePosition

double (see Note 5)

INITIALPOSITION

RootFlag

see Note 4

No field

NoteNote:

  1. Distance in the schematic feature class coordinate system from the origin node for a positive value, or from the extremity node for a negative value.
  2. The attribute value specifies whether the margin includes the size of the related node symbols:
    • 0: the margin size doesn't include the symbol size—that is, the margin is the distance between the container boundary and the nearest node center.
    • Any other value: the margin size includes the symbol size—that is, the margin is the distance between the container boundary and the nearest node's boundary symbol.
  3. The values specified through the ContainerBottomMargin, ContainerTopMargin, ContainerLeftMargin, and ContainerRightMargin attributes must be interpreted as the following:
    • Pixels when ContainerMarginUnit = 0
    • Schematic feature class coordinate system units when ContainerMarginUnit = 1
    • A percentage of the container size when ContainerMarginUnit = 2
  4. The attribute values determine whether the schematic features must be considered as root/end nodes:
    • NULL, EMPTY, 0: this is not a root/end node.
    • -1 or any other value: this is a root/end node.
  5. Value between 0. and 1., representing the percentage of the reference link length.

Related Topics

2/10/2012