org.eclipse.scada.configuration.iec60870

Interface ProtocolOptions

All Superinterfaces:

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

All Known Implementing Classes:

ProtocolOptionsImpl

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

A representation of the model object 'Protocol Options'.

The following features are supported:

• Timeout1
• Timeout2
• Timeout3
• Asdu Address Size
• Information Object Address Size
• Cause Of Transmission Size
• W
• K
• Target Time Zone
• Ignore Daylight Saving Time

See Also:

IEC60870Package.getProtocolOptions()

Method Summary

Methods

Modifier and Type	Method and Description
byte	getAsduAddressSize() Returns the value of the 'Asdu Address Size' attribute.
byte	getCauseOfTransmissionSize() Returns the value of the 'Cause Of Transmission Size' attribute.
byte	getInformationObjectAddressSize() Returns the value of the 'Information Object Address Size' attribute.
int	getK() Returns the value of the 'K' attribute.
String	getTargetTimeZone() Returns the value of the 'Target Time Zone' attribute.
int	getTimeout1() Returns the value of the 'Timeout1' attribute.
int	getTimeout2() Returns the value of the 'Timeout2' attribute.
int	getTimeout3() Returns the value of the 'Timeout3' attribute.
int	getW() Returns the value of the 'W' attribute.
boolean	isIgnoreDaylightSavingTime() Returns the value of the 'Ignore Daylight Saving Time' attribute.
void	setAsduAddressSize(byte value) Sets the value of the 'Asdu Address Size' attribute.
void	setCauseOfTransmissionSize(byte value) Sets the value of the 'Cause Of Transmission Size' attribute.
void	setIgnoreDaylightSavingTime(boolean value) Sets the value of the 'Ignore Daylight Saving Time' attribute.
void	setInformationObjectAddressSize(byte value) Sets the value of the 'Information Object Address Size' attribute.
void	setK(int value) Sets the value of the 'K' attribute.
void	setTargetTimeZone(String value) Sets the value of the 'Target Time Zone' attribute.
void	setTimeout1(int value) Sets the value of the 'Timeout1' attribute.
void	setTimeout2(int value) Sets the value of the 'Timeout2' attribute.
void	setTimeout3(int value) Sets the value of the 'Timeout3' attribute.
void	setW(int value) Sets the value of the 'W' 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

getTimeout1

int getTimeout1()

Returns the value of the 'Timeout1' attribute. The default value is "15000".

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

Returns:

the value of the 'Timeout1' attribute.

See Also:

setTimeout1(int), IEC60870Package.getProtocolOptions_Timeout1()

setTimeout1

void setTimeout1(int value)

Sets the value of the 'Timeout1' attribute.

Parameters:

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

See Also:

getTimeout1()

getTimeout2

int getTimeout2()

Returns the value of the 'Timeout2' attribute. The default value is "10000".

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

Returns:

the value of the 'Timeout2' attribute.

See Also:

setTimeout2(int), IEC60870Package.getProtocolOptions_Timeout2()

setTimeout2

void setTimeout2(int value)

Sets the value of the 'Timeout2' attribute.

Parameters:

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

See Also:

getTimeout2()

getTimeout3

int getTimeout3()

Returns the value of the 'Timeout3' attribute. The default value is "20000".

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

Returns:

the value of the 'Timeout3' attribute.

See Also:

setTimeout3(int), IEC60870Package.getProtocolOptions_Timeout3()

setTimeout3

void setTimeout3(int value)

Sets the value of the 'Timeout3' attribute.

Parameters:

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

See Also:

getTimeout3()

getAsduAddressSize

byte getAsduAddressSize()

Returns the value of the 'Asdu Address Size' attribute. The default value is "2".

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

Returns:

the value of the 'Asdu Address Size' attribute.

See Also:

setAsduAddressSize(byte), IEC60870Package.getProtocolOptions_AsduAddressSize()

setAsduAddressSize

void setAsduAddressSize(byte value)

Sets the value of the 'Asdu Address Size' attribute.

Parameters:

value - the new value of the 'Asdu Address Size' attribute.

See Also:

getAsduAddressSize()

getInformationObjectAddressSize

byte getInformationObjectAddressSize()

Returns the value of the 'Information Object Address Size' attribute. The default value is "3".

If the meaning of the 'Information Object Address Size' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Information Object Address Size' attribute.

See Also:

setInformationObjectAddressSize(byte), IEC60870Package.getProtocolOptions_InformationObjectAddressSize()

setInformationObjectAddressSize

void setInformationObjectAddressSize(byte value)

Sets the value of the 'Information Object Address Size' attribute.

Parameters:

value - the new value of the 'Information Object Address Size' attribute.

See Also:

getInformationObjectAddressSize()

getCauseOfTransmissionSize

byte getCauseOfTransmissionSize()

Returns the value of the 'Cause Of Transmission Size' attribute. The default value is "2".

If the meaning of the 'Cause Of Transmission Size' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Cause Of Transmission Size' attribute.

See Also:

setCauseOfTransmissionSize(byte), IEC60870Package.getProtocolOptions_CauseOfTransmissionSize()

setCauseOfTransmissionSize

void setCauseOfTransmissionSize(byte value)

Sets the value of the 'Cause Of Transmission Size' attribute.

Parameters:

value - the new value of the 'Cause Of Transmission Size' attribute.

See Also:

getCauseOfTransmissionSize()

getW

int getW()

Returns the value of the 'W' attribute. The default value is "10".

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

Returns:

the value of the 'W' attribute.

See Also:

setW(int), IEC60870Package.getProtocolOptions_W()

setW

void setW(int value)

Sets the value of the 'W' attribute.

Parameters:

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

See Also:

getW()

getK

int getK()

Returns the value of the 'K' attribute. The default value is "15".

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

Returns:

the value of the 'K' attribute.

See Also:

setK(int), IEC60870Package.getProtocolOptions_K()

setK

void setK(int value)

Sets the value of the 'K' attribute.

Parameters:

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

See Also:

getK()

getTargetTimeZone

String getTargetTimeZone()

Returns the value of the 'Target Time Zone' attribute. This defines in which time zone the timestamps will be converted before they are sent/or after they have been received from communication partner. IEC60870-5 recommends to use the UTC as time zone, however not all systems follow that recommendation. This value must be a valid Java time zone ID.

Returns:

the value of the 'Target Time Zone' attribute.

See Also:

setTargetTimeZone(String), IEC60870Package.getProtocolOptions_TargetTimeZone()

setTargetTimeZone

void setTargetTimeZone(String value)

Sets the value of the 'Target Time Zone' attribute.

Parameters:

value - the new value of the 'Target Time Zone' attribute.

See Also:

getTargetTimeZone()

isIgnoreDaylightSavingTime

boolean isIgnoreDaylightSavingTime()

Returns the value of the 'Ignore Daylight Saving Time' attribute. The default value is "false".

If the meaning of the 'Ignore Daylight Saving Time' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Ignore Daylight Saving Time' attribute.

See Also:

setIgnoreDaylightSavingTime(boolean), IEC60870Package.getProtocolOptions_IgnoreDaylightSavingTime()

setIgnoreDaylightSavingTime

void setIgnoreDaylightSavingTime(boolean value)

Sets the value of the 'Ignore Daylight Saving Time' attribute.

Parameters:

value - the new value of the 'Ignore Daylight Saving Time' attribute.

See Also:

isIgnoreDaylightSavingTime()