org.eclipse.etrice.core.room
Interface ProtocolClass

All Superinterfaces:

RoomClass

All Known Implementing Classes:

ProtocolClassImpl

public interface ProtocolClass
extends RoomClass

A representation of the model object 'Protocol Class'.

The following features are supported:

• Base
• User Code1
• User Code2
• Incoming Messages
• Outgoing Messages
• Regular
• Conjugate
• Semantics

See Also:

RoomPackage.getProtocolClass()

EMF generated code

EMF model element

Method Summary

ProtocolClass	getBase() Returns the value of the 'Base' reference.
PortClass	getConjugate() Returns the value of the 'Conjugate' containment reference.
	getIncomingMessages() Returns the value of the 'Incoming Messages' containment reference list.
	getOutgoingMessages() Returns the value of the 'Outgoing Messages' containment reference list.
PortClass	getRegular() Returns the value of the 'Regular' containment reference.
ProtocolSemantics	getSemantics() Returns the value of the 'Semantics' containment reference.
DetailCode	getUserCode1() Returns the value of the 'User Code1' containment reference.
DetailCode	getUserCode2() Returns the value of the 'User Code2' containment reference.
void	setBase(ProtocolClass value) Sets the value of the 'Base' reference.
void	setConjugate(PortClass value) Sets the value of the 'Conjugate' containment reference.
void	setRegular(PortClass value) Sets the value of the 'Regular' containment reference.
void	setSemantics(ProtocolSemantics value) Sets the value of the 'Semantics' containment reference.
void	setUserCode1(DetailCode value) Sets the value of the 'User Code1' containment reference.
void	setUserCode2(DetailCode value) Sets the value of the 'User Code2' containment reference.

Methods inherited from interface org.eclipse.etrice.core.room.RoomClass

getDocu, getName, setDocu, setName

Method Detail

getBase

ProtocolClass getBase()

Returns the value of the 'Base' reference.

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

Returns:

the value of the 'Base' reference.

See Also:

setBase(ProtocolClass), RoomPackage.getProtocolClass_Base()

EMF generated code

EMF model element

setBase

void setBase(ProtocolClass value)

Sets the value of the 'Base' reference.

Parameters:

value - the new value of the 'Base' reference.

See Also:

getBase()

EMF generated code

getUserCode1

DetailCode getUserCode1()

Returns the value of the 'User Code1' containment reference.

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

Returns:

the value of the 'User Code1' containment reference.

See Also:

setUserCode1(DetailCode), RoomPackage.getProtocolClass_UserCode1()

EMF generated code

EMF model element

containment="true"

setUserCode1

void setUserCode1(DetailCode value)

Sets the value of the 'User Code1' containment reference.

Parameters:

value - the new value of the 'User Code1' containment reference.

See Also:

getUserCode1()

EMF generated code

getUserCode2

DetailCode getUserCode2()

Returns the value of the 'User Code2' containment reference.

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

Returns:

the value of the 'User Code2' containment reference.

See Also:

setUserCode2(DetailCode), RoomPackage.getProtocolClass_UserCode2()

EMF generated code

EMF model element

containment="true"

setUserCode2

void setUserCode2(DetailCode value)

Sets the value of the 'User Code2' containment reference.

Parameters:

value - the new value of the 'User Code2' containment reference.

See Also:

getUserCode2()

EMF generated code

getIncomingMessages

 getIncomingMessages()

Returns the value of the 'Incoming Messages' containment reference list. The list contents are of type Message.

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

Returns:

the value of the 'Incoming Messages' containment reference list.

See Also:

RoomPackage.getProtocolClass_IncomingMessages()

EMF generated code

EMF model element

containment="true"

getOutgoingMessages

 getOutgoingMessages()

Returns the value of the 'Outgoing Messages' containment reference list. The list contents are of type Message.

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

Returns:

the value of the 'Outgoing Messages' containment reference list.

See Also:

RoomPackage.getProtocolClass_OutgoingMessages()

EMF generated code

EMF model element

containment="true"

getRegular

PortClass getRegular()

Returns the value of the 'Regular' containment reference.

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

Returns:

the value of the 'Regular' containment reference.

See Also:

setRegular(PortClass), RoomPackage.getProtocolClass_Regular()

EMF generated code

EMF model element

containment="true"

setRegular

void setRegular(PortClass value)

Sets the value of the 'Regular' containment reference.

Parameters:

value - the new value of the 'Regular' containment reference.

See Also:

getRegular()

EMF generated code

getConjugate

PortClass getConjugate()

Returns the value of the 'Conjugate' containment reference.

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

Returns:

the value of the 'Conjugate' containment reference.

See Also:

setConjugate(PortClass), RoomPackage.getProtocolClass_Conjugate()

EMF generated code

EMF model element

containment="true"

setConjugate

void setConjugate(PortClass value)

Sets the value of the 'Conjugate' containment reference.

Parameters:

value - the new value of the 'Conjugate' containment reference.

See Also:

getConjugate()

EMF generated code

getSemantics

ProtocolSemantics getSemantics()

Returns the value of the 'Semantics' containment reference.

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

Returns:

the value of the 'Semantics' containment reference.

See Also:

setSemantics(ProtocolSemantics), RoomPackage.getProtocolClass_Semantics()

EMF generated code

EMF model element

containment="true"

setSemantics

void setSemantics(ProtocolSemantics value)

Sets the value of the 'Semantics' containment reference.

Parameters:

value - the new value of the 'Semantics' containment reference.

See Also:

getSemantics()

EMF generated code