com.esri.arcgis.schematic
Interface ISchematicAttribute

All Superinterfaces:

Serializable

All Known Subinterfaces:

ISchematicAttributeAssociatedField, ISchematicAttributeConstant, ISchematicAttributeDynamic, ISchematicAttributeField, ISchematicAttributeFormatted, ISchematicAttributeFunction, ISchematicAttributeGeometry, ISchematicAttributeProperty, ISchematicAttributeQuery, ISchematicAttributeScript, ISchematicAttributeStatic

All Known Implementing Classes:

ISchematicAttributeAssociatedFieldProxy, ISchematicAttributeConstantProxy, ISchematicAttributeDynamicProxy, ISchematicAttributeFieldProxy, ISchematicAttributeFormattedProxy, ISchematicAttributeFunctionProxy, ISchematicAttributeGeometryProxy, ISchematicAttributePropertyProxy, ISchematicAttributeProxy, ISchematicAttributeQueryProxy, ISchematicAttributeScriptProxy, ISchematicAttributeStaticProxy, SchematicAttributeAssociatedField, SchematicAttributeConstant, SchematicAttributeDynamic, SchematicAttributeField, SchematicAttributeFormatted, SchematicAttributeFunction, SchematicAttributeGeometry, SchematicAttributeProperty, SchematicAttributeQuery, SchematicAttributeScript, SchematicAttributeStatic

public interface ISchematicAttribute
extends Serializable

Provides access to members that manage the schematic attribute.

Description

A schematic attribute gives information about a schematic feature or schematic diagram.

• For a schematic feature, a schematic attribute is a piece of data describing its characteristics. Schematics attributes give spatial or nonspatial information and can also be used to represent and label the schematic feature in a map.
• For a schematic diagram, schematic attributes may include its name, its description, and so on.

Remarks

You can create a new attribute using the Schematics Dataset Editor or by calling the CreateSchematicAttribute method available from the desired ISchematicObjectClass interface; that is through the object class related to the schematic diagram class or schematic element class you want.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	delete() Deletes the schematic attribute.
IUID	getCLSID() CLSID of the schematic attribute.
String	getDescription() Description of the schematic attribute.
String	getName() Name of the schematic attribute.
ISchematicObjectClass	getSchematicObjectClass() Schematic object class the schematic attribute belongs to.
Object	getValue(ISchematicObject schematicObject) The schematic attribute value for the specified schematic object.
void	setName(String name) Name of the schematic attribute.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the schematic attribute.

Description

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.

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, SubLink	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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

Name of the schematic attribute.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

Description of the schematic attribute.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCLSID

IUID getCLSID()
              throws IOException,
                     AutomationException

CLSID of the schematic attribute.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicObjectClass

ISchematicObjectClass getSchematicObjectClass()
                                              throws IOException,
                                                     AutomationException

Schematic object class the schematic attribute belongs to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicObjectClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

void delete()
            throws IOException,
                   AutomationException

Deletes the schematic attribute.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

Object getValue(ISchematicObject schematicObject)
                throws IOException,
                       AutomationException

The schematic attribute value for the specified schematic object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

schematicObject - A reference to a com.esri.arcgis.schematic.ISchematicObject (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.