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

Interface Protocol

All Superinterfaces:

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

All Known Implementing Classes:

ProtocolImpl

public interface Protocol
extends DocumentedElement

A representation of the model object 'Protocol'.

The following features are supported:

• Messages
• Name
• Structures
• Package Prefix
• Included Protocols
• License Header
• Enums
• Interfaces
• Version

See Also:

ProtocolPackage.getProtocol()

Method Summary

Modifier and Type	Method and Description
org.eclipse.emf.common.util.EList<Enum>	getEnums() Returns the value of the 'Enums' containment reference list.
org.eclipse.emf.common.util.EList<Protocol>	getIncludedProtocols() Returns the value of the 'Included Protocols' reference list.
org.eclipse.emf.common.util.EList<Interface>	getInterfaces() Returns the value of the 'Interfaces' containment reference list.
String	getLicenseHeader() Returns the value of the 'License Header' attribute.
org.eclipse.emf.common.util.EList<Message>	getMessages() Returns the value of the 'Messages' containment reference list.
String	getName() Returns the value of the 'Name' attribute.
String	getPackagePrefix() Returns the value of the 'Package Prefix' attribute.
org.eclipse.emf.common.util.EList<Structure>	getStructures() Returns the value of the 'Structures' containment reference list.
short	getVersion() Returns the value of the 'Version' attribute.
void	setLicenseHeader(String value) Sets the value of the 'License Header' attribute.
void	setName(String value) Sets the value of the 'Name' attribute.
void	setPackagePrefix(String value) Sets the value of the 'Package Prefix' attribute.
void	setVersion(short value) Sets the value of the 'Version' attribute.

Methods inherited from interface org.eclipse.scada.protocol.ngp.model.Protocol.DocumentedElement

getDescription, getShortDescription, setDescription, setShortDescription

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

getMessages

org.eclipse.emf.common.util.EList<Message> getMessages()

Returns the value of the 'Messages' containment reference list. The list contents are of type Message. It is bidirectional and its opposite is 'Protocol'.

If the meaning of the 'Messages' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Messages' containment reference list.

See Also:

ProtocolPackage.getProtocol_Messages(), Message.getProtocol()

getName

String getName()

Returns the value of the 'Name' attribute.

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

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), ProtocolPackage.getProtocol_Name()

setName

void setName(String value)

Sets the value of the 'Name' attribute.

Parameters:

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

See Also:

getName()

getIncludedProtocols

org.eclipse.emf.common.util.EList<Protocol> getIncludedProtocols()

Returns the value of the 'Included Protocols' reference list. The list contents are of type Protocol.

If the meaning of the 'Included Protocols' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Included Protocols' reference list.

See Also:

ProtocolPackage.getProtocol_IncludedProtocols()

getLicenseHeader

String getLicenseHeader()

Returns the value of the 'License Header' attribute.

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

Returns:

the value of the 'License Header' attribute.

See Also:

setLicenseHeader(String), ProtocolPackage.getProtocol_LicenseHeader()

setLicenseHeader

void setLicenseHeader(String value)

Sets the value of the 'License Header' attribute.

Parameters:

value - the new value of the 'License Header' attribute.

See Also:

getLicenseHeader()

getEnums

org.eclipse.emf.common.util.EList<Enum> getEnums()

Returns the value of the 'Enums' containment reference list. The list contents are of type Enum. It is bidirectional and its opposite is 'Protocol'.

If the meaning of the 'Enums' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Enums' containment reference list.

See Also:

ProtocolPackage.getProtocol_Enums(), Enum.getProtocol()

getInterfaces

org.eclipse.emf.common.util.EList<Interface> getInterfaces()

Returns the value of the 'Interfaces' containment reference list. The list contents are of type Interface. It is bidirectional and its opposite is 'Protocol'.

If the meaning of the 'Interfaces' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Interfaces' containment reference list.

See Also:

ProtocolPackage.getProtocol_Interfaces(), Interface.getProtocol()

getVersion

short getVersion()

Returns the value of the 'Version' attribute.

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

Returns:

the value of the 'Version' attribute.

See Also:

setVersion(short), ProtocolPackage.getProtocol_Version()

setVersion

void setVersion(short value)

Sets the value of the 'Version' attribute.

Parameters:

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

See Also:

getVersion()

getStructures

org.eclipse.emf.common.util.EList<Structure> getStructures()

Returns the value of the 'Structures' containment reference list. The list contents are of type Structure. It is bidirectional and its opposite is 'Protocol'.

If the meaning of the 'Structures' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Structures' containment reference list.

See Also:

ProtocolPackage.getProtocol_Structures(), Structure.getProtocol()

getPackagePrefix

String getPackagePrefix()

Returns the value of the 'Package Prefix' attribute.

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

Returns:

the value of the 'Package Prefix' attribute.

See Also:

setPackagePrefix(String), ProtocolPackage.getProtocol_PackagePrefix()

setPackagePrefix

void setPackagePrefix(String value)

Sets the value of the 'Package Prefix' attribute.

Parameters:

value - the new value of the 'Package Prefix' attribute.

See Also:

getPackagePrefix()