org.eclipse.scada.protocol.ngp.model.Protocol

Interface DocumentedElement

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

Attribute, AttributeStructure, BooleanAttribute, Enum, EnumAttribute, FloatAttribute, IntegerAttribute, Interface, LongAttribute, Message, PropertiesAttribute, Protocol, StringAttribute, Structure, StructureAttribute, VariantAttribute, VariantMapAttribute

All Known Implementing Classes:

AttributeImpl, AttributeStructureImpl, BooleanAttributeImpl, DocumentedElementImpl, EnumAttributeImpl, EnumImpl, FloatAttributeImpl, IntegerAttributeImpl, InterfaceImpl, LongAttributeImpl, MessageImpl, PropertiesAttributeImpl, ProtocolImpl, StringAttributeImpl, StructureAttributeImpl, StructureImpl, VariantAttributeImpl, VariantMapAttributeImpl

public interface DocumentedElement
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Documented Element'.

The following features are supported:

• Description
• Short Description

See Also:

ProtocolPackage.getDocumentedElement()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the value of the 'Description' attribute.
String	getShortDescription() Returns the value of the 'Short Description' attribute.
void	setDescription(String value) Sets the value of the 'Description' attribute.
void	setShortDescription(String value) Sets the value of the 'Short Description' attribute.

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getDescription

String getDescription()

Returns the value of the 'Description' attribute.

If the meaning of the 'Description' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Description' attribute.

See Also:

setDescription(String), ProtocolPackage.getDocumentedElement_Description()

setDescription

void setDescription(String value)

Sets the value of the 'Description' attribute.

Parameters:

value - the new value of the 'Description' attribute.

See Also:

getDescription()

getShortDescription

String getShortDescription()

Returns the value of the 'Short Description' attribute.

If the meaning of the 'Short Description' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Short Description' attribute.

See Also:

setShortDescription(String), ProtocolPackage.getDocumentedElement_ShortDescription()

setShortDescription

void setShortDescription(String value)

Sets the value of the 'Short Description' attribute.

Parameters:

value - the new value of the 'Short Description' attribute.

See Also:

getShortDescription()