rs.sol.soloist.server.guiconfiguration.nonvisualcompoments
Class GUIBufferComponent

java.lang.Object
  rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance
      rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance
          rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance
              rs.sol.soloist.server.builtindomains.common.ObjectOfClass
                  rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
                      rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUINonVisualComponent
                          rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUIBufferComponent

All Implemented Interfaces:

IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class GUIBufferComponent
extends GUINonVisualComponent

An invisible widget that buffers value(s) received on input input pin (ipInput() method). The value(s) is/are buffered until this widget receives an event on its send input pin (ipSend() method), after which it sends value(s) from input pin on its output output pin (opOutput()).

Author:

SOL Expert Group

Nested Class Summary

static class	GUIBufferComponent.FQPropertyNames Deprecated. Not for public use.
static class	GUIBufferComponent.PROPERTIES Deprecated. Not for public use.

Field Summary

static IClass	CLASSIFIER UML class reference
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name
IAssociationEndInstance<rs.sol.soloist.server.builtindomains.common.ElementDescriptor>	input Deprecated. Not for public use.
IAttributeValue<Text>	output Deprecated. Not for public use.
IAttributeValue<Text>	send Deprecated. Not for public use.
IAttributeValue<Boolean>	sendOnInit Deprecated. Not for public use.

Fields inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyle, context, description, enabled, init, inputBindings, layoutData, logger, name, outputBindings, ownerTable, parent, removeStyle, show, showInParent, styleName, tooltip, visible

Constructor Summary

GUIBufferComponent()

Method Summary

void	addInitialValue(rs.sol.soloist.server.uml.concepts.IElement el) Adds the new initial value.
void	clearInitialValues() Clears the initial value collection.
void	constructor() The domain-specific constructor of the Classifier.
static GUIBufferComponent	create(GUIContainerComponent parent) Deprecated. Not for public use.
static GUIBufferComponent	create(GUIContainerComponent parent, boolean sendOnInit, rs.sol.soloist.server.uml.concepts.IElement... input) Returns new GUIBufferComponent and assigns it to its parent widget.
static GUIBufferComponent	create(GUIContainerComponent parent, rs.sol.soloist.server.uml.concepts.IElement... input) Deprecated. Not for public use.
static GUIBufferComponent	create(GUIContainerComponent parent, ISlot pinInput) Deprecated. Not for public use.
java.util.List<rs.sol.soloist.server.uml.concepts.IElement>	getInitialValues() Returns the initial value(s).
boolean	getSendOnInit() Returns whether this widget will send initial values on the output output pin (opOutput() method) immediately after it gets initialized or not.
ISlot<?>	ipInput() Returns the input input pin; when event occurs, value(s) accepted on that pin is/are stored in this widget internally so it/they can be provided on the output output pin (opOutput() method) when new event appears at the send input pin (ipSend() method).
ISlot<?>	ipSend() Returns the send input pin; when event occurs, the last value received on the input input pin (ipInput() method) is provided on the output output pin (opOutput() method).
ISlot<?>	opOutput() Returns the output output pin; when event appears on the send input pin (ipSend() method) the last value from the binding message accepted over input input pin (ipInput() method) will be provided on this (output) pin.
void	removeInitialValue(rs.sol.soloist.server.uml.concepts.IElement el) Removes one initial value.
void	setInitialValues(java.util.List<rs.sol.soloist.server.uml.concepts.IElement> elements) Sets the initial values.
void	setSendOnInit(boolean value) Sets whether this widget will send initial values on the output output pin (opOutput() method) immediately after it gets initialized or not.

Methods inherited from class rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUINonVisualComponent

setCellAlignment, setCellSize, setCellStyle, setCenter, setDirectionAndSize, setLeftRightWidth, setRowColumn, setRowColumn, setSize, setTopBottomHeight, setXY

Methods inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyleNames, addValueToSlot, clearSlot, clone, createInfo, createInfoAlreadyValidated, destructor, fillElementInfo, getApplication, getCommands, getCommands, getCommonOwner, getContext, getDescription, getDescrString, getDragIcon, getEnabled, getFeature, getFeature, getInputBindings, getInputPin, getInputPins, getLabelString, getLargeIcon, getLayoutData, getName, getNameString, getOutputPin, getOutputPins, getOwner, getParts, getSetting, getSmallIcon, getStyle, getSubnodes, getTooltip, getTooltipString, getTypeString, getVisible, handle, ipAddStyle, ipEnabled, ipInit, ipRemoveStyle, ipShow, ipShowInParent, ipVisible, isInputPin, isOutputPin, putFeatureInfo, readElement, readElements, readSlot, readSlotAsInfo, readSubnodes, removeValueFromSlot, setContext, setDescription, setEnabled, setLayoutData, setName, setSlot, setSlot, setStyle, setTooltip, setVisible, toTranslateDescriptors, translatePinName, updateInfo, validate, validateParts, validateParts

Methods inherited from class rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance

destroy, equals, getAssociationEndInstance, getAssociationEndInstances, getAttributeValue, getAttributeValues, getMyClass, getMyID, getSlot, getSlot, getSlots, getUMLClass, hashCode, isMarkedAsDeleted, toString

Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance

accept, accept, exists, getAssociationEndInstance, getAssociationEndInstance, getAssociationEndInstance, getClassifier, hasIdentity, isClassInstance, isDataTypeInstance, isEqualTo, makeClone, markAsDeleted

Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance

conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getMElement, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf, isKindOf, isModelElement, isRTElement

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IClassifierInstance

conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IRTElement

getMElement

Methods inherited from interface rs.sol.soloist.server.uml.concepts.IElement

isKindOf, isModelElement, isRTElement

Field Detail

sendOnInit

@Deprecated
public IAttributeValue<Boolean> sendOnInit

Deprecated. Not for public use.

send

@Deprecated
public IAttributeValue<Text> send

Deprecated. Not for public use.

output

@Deprecated
public IAttributeValue<Text> output

Deprecated. Not for public use.

FQ_TYPE_NAME

public static final java.lang.String FQ_TYPE_NAME

Fully qualified UML class name

See Also:

Constant Field Values

CLASSIFIER

public static final IClass CLASSIFIER

UML class reference

input

@Deprecated
public IAssociationEndInstance<rs.sol.soloist.server.builtindomains.common.ElementDescriptor> input

Deprecated. Not for public use.

Constructor Detail

GUIBufferComponent

public GUIBufferComponent()

Method Detail

constructor

public void constructor()

Description copied from interface: IClassifierInstance

The domain-specific constructor of the Classifier.

Specified by:

constructor in interface IClassifierInstance

Overrides:

constructor in class GUINonVisualComponent

create

public static GUIBufferComponent create(GUIContainerComponent parent,
                                        boolean sendOnInit,
                                        rs.sol.soloist.server.uml.concepts.IElement... input)

Returns new GUIBufferComponent and assigns it to its parent widget.

Parameters:

parent - the parent GUIContainerComponent widget

sendOnInit - a boolean that specifies whether new buffer will send initial value as soon as it gets initialized, or will wait until it gets signal on the send input pin (ipSend() method)

input - the collection of initial values

Returns:

the new GUIBufferComponent

create

@Deprecated
public static GUIBufferComponent create(GUIContainerComponent parent)

Deprecated. Not for public use.

create

@Deprecated
public static GUIBufferComponent create(GUIContainerComponent parent,
                                                   ISlot pinInput)

Deprecated. Not for public use.

create

@Deprecated
public static GUIBufferComponent create(GUIContainerComponent parent,
                                                   rs.sol.soloist.server.uml.concepts.IElement... input)

Deprecated. Not for public use.

ipSend

public ISlot<?> ipSend()

Returns the send input pin; when event occurs, the last value received on the input input pin (ipInput() method) is provided on the output output pin (opOutput() method). If there were no values yet received over the input input pin, then the initial value(s) are provided (sent) instead.

The content of the binding message accepted on this pin is of no importance. Only event is what matters.

Returns:

the send input pin

See Also:

GUIComponentBinding

ipInput

public ISlot<?> ipInput()

Returns the input input pin; when event occurs, value(s) accepted on that pin is/are stored in this widget internally so it/they can be provided on the output output pin (opOutput() method) when new event appears at the send input pin (ipSend() method).

Returns:

the input input pin

See Also:

GUIComponentBinding

opOutput

public ISlot<?> opOutput()

Returns the output output pin; when event appears on the send input pin (ipSend() method) the last value from the binding message accepted over input input pin (ipInput() method) will be provided on this (output) pin. If there were no values yet received over the input input pin, then the initial value(s) are provided (sent) instead.

Returns:

the output output pin

See Also:

GUIComponentBinding

getSendOnInit

public boolean getSendOnInit()

Returns whether this widget will send initial values on the output output pin (opOutput() method) immediately after it gets initialized or not.

Returns:

whether this widget will send initial values on the output output pin immediately after it gets initialized or not

setSendOnInit

public void setSendOnInit(boolean value)

Sets whether this widget will send initial values on the output output pin (opOutput() method) immediately after it gets initialized or not.

Parameters:

value - a boolean that tells whether this widget will send initial values on the output output pin immediately after it gets initialized or not

getInitialValues

public java.util.List<rs.sol.soloist.server.uml.concepts.IElement> getInitialValues()

Returns the initial value(s).

Returns:

the initial value(s)

setInitialValues

public void setInitialValues(java.util.List<rs.sol.soloist.server.uml.concepts.IElement> elements)

Sets the initial values.

Parameters:

elements - the new list of initial values

addInitialValue

public void addInitialValue(rs.sol.soloist.server.uml.concepts.IElement el)

Adds the new initial value.

Parameters:

el - the new initial value to be added

removeInitialValue

public void removeInitialValue(rs.sol.soloist.server.uml.concepts.IElement el)

Removes one initial value.

Parameters:

el - the initial value to be removed

clearInitialValues

public void clearInitialValues()

Clears the initial value collection.