org.eclipse.etrice.core.room
Interface ActorClass

All Superinterfaces:
ActorContainerClass, RoomClass, StructureClass
All Known Subinterfaces:
ExpandedActorClass
All Known Implementing Classes:
ActorClassImpl, ExpandedActorClassImpl

public interface ActorClass
extends ActorContainerClass

A representation of the model object 'Actor Class'.

The following features are supported:

See Also:
RoomPackage.getActorClass()
EMF generated code
EMF model element

Method Summary
  getAnnotations()
          Returns the value of the 'Annotations' containment reference list.
  getAttributes()
          Returns the value of the 'Attributes' containment reference list.
 ActorClass getBase()
          Returns the value of the 'Base' reference.
 Documentation getBehaviorDocu()
          Returns the value of the 'Behavior Docu' containment reference.
 ActorCommunicationType getCommType()
          Returns the value of the 'Comm Type' attribute.
  getExtPorts()
          Returns the value of the 'Ext Ports' containment reference list.
  getIfPorts()
          Returns the value of the 'If Ports' containment reference list.
  getIntPorts()
          Returns the value of the 'Int Ports' containment reference list.
  getOperations()
          Returns the value of the 'Operations' containment reference list.
  getServiceImplementations()
          Returns the value of the 'Service Implementations' containment reference list.
 StateGraph getStateMachine()
          Returns the value of the 'State Machine' containment reference.
  getStrSAPs()
          Returns the value of the 'Str SA Ps' containment reference list.
 Documentation getStructureDocu()
          Returns the value of the 'Structure Docu' containment reference.
 boolean isAbstract()
          Returns the value of the 'Abstract' attribute.
 void setAbstract(boolean value)
          Sets the value of the 'Abstract' attribute.
 void setBase(ActorClass value)
          Sets the value of the 'Base' reference.
 void setBehaviorDocu(Documentation value)
          Sets the value of the 'Behavior Docu' containment reference.
 void setCommType(ActorCommunicationType value)
          Sets the value of the 'Comm Type' attribute.
 void setStateMachine(StateGraph value)
          Sets the value of the 'State Machine' containment reference.
 void setStructureDocu(Documentation value)
          Sets the value of the 'Structure Docu' containment reference.
 
Methods inherited from interface org.eclipse.etrice.core.room.ActorContainerClass
getActorRefs, getIfSPPs, getUserCode1, getUserCode2, getUserCode3, setUserCode1, setUserCode2, setUserCode3
 
Methods inherited from interface org.eclipse.etrice.core.room.StructureClass
getBindings, getConnections
 
Methods inherited from interface org.eclipse.etrice.core.room.RoomClass
getDocu, getName, setDocu, setName
 

Method Detail

isAbstract

boolean isAbstract()
Returns the value of the 'Abstract' attribute.

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

Returns:
the value of the 'Abstract' attribute.
See Also:
setAbstract(boolean), RoomPackage.getActorClass_Abstract()
EMF generated code
EMF model element

setAbstract

void setAbstract(boolean value)
Sets the value of the 'Abstract' attribute.

Parameters:
value - the new value of the 'Abstract' attribute.
See Also:
isAbstract()
EMF generated code

getCommType

ActorCommunicationType getCommType()
Returns the value of the 'Comm Type' attribute. The literals are from the enumeration ActorCommunicationType.

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

Returns:
the value of the 'Comm Type' attribute.
See Also:
ActorCommunicationType, setCommType(ActorCommunicationType), RoomPackage.getActorClass_CommType()
EMF generated code
EMF model element

setCommType

void setCommType(ActorCommunicationType value)
Sets the value of the 'Comm Type' attribute.

Parameters:
value - the new value of the 'Comm Type' attribute.
See Also:
ActorCommunicationType, getCommType()
EMF generated code

getBase

ActorClass 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(ActorClass), RoomPackage.getActorClass_Base()
EMF generated code
EMF model element

setBase

void setBase(ActorClass value)
Sets the value of the 'Base' reference.

Parameters:
value - the new value of the 'Base' reference.
See Also:
getBase()
EMF generated code

getIfPorts

 getIfPorts()
Returns the value of the 'If Ports' containment reference list. The list contents are of type Port.

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

Returns:
the value of the 'If Ports' containment reference list.
See Also:
RoomPackage.getActorClass_IfPorts()
EMF generated code
EMF model element
containment="true"

getStructureDocu

Documentation getStructureDocu()
Returns the value of the 'Structure Docu' containment reference.

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

Returns:
the value of the 'Structure Docu' containment reference.
See Also:
setStructureDocu(Documentation), RoomPackage.getActorClass_StructureDocu()
EMF generated code
EMF model element
containment="true"

setStructureDocu

void setStructureDocu(Documentation value)
Sets the value of the 'Structure Docu' containment reference.

Parameters:
value - the new value of the 'Structure Docu' containment reference.
See Also:
getStructureDocu()
EMF generated code

getIntPorts

 getIntPorts()
Returns the value of the 'Int Ports' containment reference list. The list contents are of type Port.

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

Returns:
the value of the 'Int Ports' containment reference list.
See Also:
RoomPackage.getActorClass_IntPorts()
EMF generated code
EMF model element
containment="true"

getExtPorts

 getExtPorts()
Returns the value of the 'Ext Ports' containment reference list. The list contents are of type ExternalPort.

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

Returns:
the value of the 'Ext Ports' containment reference list.
See Also:
RoomPackage.getActorClass_ExtPorts()
EMF generated code
EMF model element
containment="true"

getServiceImplementations

 getServiceImplementations()
Returns the value of the 'Service Implementations' containment reference list. The list contents are of type ServiceImplementation.

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

Returns:
the value of the 'Service Implementations' containment reference list.
See Also:
RoomPackage.getActorClass_ServiceImplementations()
EMF generated code
EMF model element
containment="true"

getStrSAPs

 getStrSAPs()
Returns the value of the 'Str SA Ps' containment reference list. The list contents are of type SAPRef.

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

Returns:
the value of the 'Str SA Ps' containment reference list.
See Also:
RoomPackage.getActorClass_StrSAPs()
EMF generated code
EMF model element
containment="true"

getAttributes

 getAttributes()
Returns the value of the 'Attributes' containment reference list. The list contents are of type Attribute.

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

Returns:
the value of the 'Attributes' containment reference list.
See Also:
RoomPackage.getActorClass_Attributes()
EMF generated code
EMF model element
containment="true"

getBehaviorDocu

Documentation getBehaviorDocu()
Returns the value of the 'Behavior Docu' containment reference.

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

Returns:
the value of the 'Behavior Docu' containment reference.
See Also:
setBehaviorDocu(Documentation), RoomPackage.getActorClass_BehaviorDocu()
EMF generated code
EMF model element
containment="true"

setBehaviorDocu

void setBehaviorDocu(Documentation value)
Sets the value of the 'Behavior Docu' containment reference.

Parameters:
value - the new value of the 'Behavior Docu' containment reference.
See Also:
getBehaviorDocu()
EMF generated code

getAnnotations

 getAnnotations()
Returns the value of the 'Annotations' containment reference list. The list contents are of type Annotation.

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

Returns:
the value of the 'Annotations' containment reference list.
See Also:
RoomPackage.getActorClass_Annotations()
EMF generated code
EMF model element
containment="true"

getOperations

 getOperations()
Returns the value of the 'Operations' containment reference list. The list contents are of type StandardOperation.

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

Returns:
the value of the 'Operations' containment reference list.
See Also:
RoomPackage.getActorClass_Operations()
EMF generated code
EMF model element
containment="true"

getStateMachine

StateGraph getStateMachine()
Returns the value of the 'State Machine' containment reference.

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

Returns:
the value of the 'State Machine' containment reference.
See Also:
setStateMachine(StateGraph), RoomPackage.getActorClass_StateMachine()
EMF generated code
EMF model element
containment="true"

setStateMachine

void setStateMachine(StateGraph value)
Sets the value of the 'State Machine' containment reference.

Parameters:
value - the new value of the 'State Machine' containment reference.
See Also:
getStateMachine()
EMF generated code