com.highqsoft.interfaces.p2d

Interface P2DChannelModelInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, java.lang.Comparable, javax.infobus.DataItem, java.util.EventListener, FwkCompareInterface, FwkControlledByInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInfoBusConsumerInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkMimeTypeInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, javax.infobus.InfoBusDataConsumer, javax.infobus.InfoBusEventListener, javax.infobus.InfoBusMember, P2DModelInterface, java.beans.PropertyChangeListener, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Implementing Classes:

P2DChannelModel

public interface P2DChannelModelInterface
extends P2DModelInterface, FwkInfoBusConsumerInterface

The P2DChannelModelInterface defines the channel model behaviour.

Since:

$Date: 2017/04/06 13:30:03 $

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

Field Summary

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkInfoBusConsumerInterface

BUSNAME

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

INFOBUS_SOURCE

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getEnvelope(P2DComponentInterface component) Get the flag that controls the channel to draw all points (no envelope).
boolean	getEnvelopeMaxLineVisible(P2DComponentInterface component) Get the envelope maximum line visible flag.
boolean	getEnvelopeMeanLineVisible(P2DComponentInterface component) Get the mean line visible flag.
boolean	getEnvelopeMinLineVisible(P2DComponentInterface component) Get the envelope minimum line visible flag.
long	getMaxCount(P2DComponentInterface component) Retrieves highest value of the three column data counts.
double	getMaxXStepSize(P2DComponentInterface component) Get the maximum step size.
long	getMinCount(P2DComponentInterface component) Retrieves lowest value of the three column data counts.
P2DPointInterface	getPointAt(P2DComponentInterface component, int index) Get the point at the specified index.
P2DRange2DInterface	getRange(P2DComponentInterface component) Get the range of the channel.
java.awt.Stroke	getShapeStroke(P2DComponentInterface component) Get the stroke used parallel to the dotjoin stroke.
P2DAxisInterface	getXAxis(P2DComponentInterface component) Retrieve the x-axis.
java.lang.String	getXAxisName(P2DComponentInterface component) Get the name of the x-axis.
FwkColumnAccessInterface	getXColumn(P2DComponentInterface component) The the x column that belongs to that channel.
java.lang.String	getXDataItemName(P2DComponentInterface component) Get the name of the X DataItem.
P2DRange1DInterface	getXRange(P2DComponentInterface component) Get the x range of the channel.
P2DAxisInterface	getYAxis(P2DComponentInterface component) Retrieve the y-axis.
java.lang.String	getYAxisName(P2DComponentInterface component) Get the name of the y-axis.
FwkColumnAccessInterface	getYColumn(P2DComponentInterface component) The the y column that belongs to that channel.
java.lang.String	getYDataItemName(P2DComponentInterface component) Get the name of the y DataItem.
P2DRange1DInterface	getYRange(P2DComponentInterface component) Get the y range of the channel.
void	initializeAxis(P2DComponentInterface component) Initialize the axes.
void	setEnvelope(P2DComponentInterface component, boolean flag) Configure the channel to draw all points (no envelope).
void	setEnvelopeMaxLineVisible(P2DComponentInterface component, boolean flag) Set the envelope maximum line visible.
void	setEnvelopeMeanLineVisible(P2DComponentInterface component, boolean flag) Set the mean line visible.
void	setEnvelopeMinLineVisible(P2DComponentInterface component, boolean flag) Set the envelope minimum line visible.
void	setMaxXStepSize(P2DComponentInterface component, double maxStepSize) If this channel defines a continuous x data channel, that has steps, the normal drawing behavior is to draw a line from the end to the beginning of the next measuring point.
void	setShapeStroke(P2DComponentInterface component, java.awt.Stroke stroke) Set the additional stroke for the shape.
void	setXAxisName(P2DComponentInterface component, java.lang.String axisName) Set the name of the x-axis.
void	setXDataItemName(P2DComponentInterface component, java.lang.String dataItemName) Set the name of the x DataItem.
void	setYAxisName(P2DComponentInterface component, java.lang.String axisName) Set the name of the y-axis.
void	setYDataItemName(P2DComponentInterface component, java.lang.String dataItemName) Set the name of the y DataItem.

Methods inherited from interface com.highqsoft.interfaces.p2d.P2DModelInterface

addDialogPane, boundsAcceptable, calculateBoundingBoxRelativeTo, configure, containsAllChildren, containsAllChildren, frameHasHandles, getActive, getActiveHandle, getAllArmedComponents, getAllArmedComponents, getAppearance, getBackground, getBackgroundColor, getBackgroundTransparency, getBackgroundVisible, getBoundingBox, getChild, getChild, getCommands, getContainerMap, getDecorated, getDialogPane, getDialogPanes, getDialogPaneValue, getDialogPaneValues, getFrame, getFrameColor, getFrameHandlesVisible, getFrameLinesVisible, getFrameTransparency, getFrameVisible, getHeight, getRatioFix, getShortName, getTransform, getWidth, hasActiveChild, initialize, install, isInside, isInside, isInternalMouseListenerActive, registerContainer, removeDialogPane, resetActiveHandle, revalidate, scaleStroke, scaleStroke, setActive, setActiveHandle, setAppearance, setBackgroundColor, setBackgroundTransparency, setBackgroundVisible, setBoundingBox, setContainerMap, setDecorated, setDialogPaneValues, setFrameColor, setFrameHandlesVisible, setFrameLinesVisible, setFrameTransparency, setFrameVisible, setInternalMouseListenerActive, setRatioFix, setTransform, transformPoint, transformPoint, uninstall, unregisterContainer

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInfoBusConsumerInterface

findDataItem, findDataItem, findMultipleDataItems, findMultipleDataItems, isAssignable, register, unregister

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkMimeTypeInterface

addMimeType, getDataFlavor, getDataFlavors, getMimeTypes, removeMimeType

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInfoBusMemberInterface

getInfoBusName, getMemberName, isConnected, setInfoBusName, setMemberName

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getProperty, getPropertyGroup, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPersistenceInterface

getCommands, getPersistentObjectNames

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControllerInterface

destroyController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkVetoableChangeInterface

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface

addCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getCommands, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Methods inherited from interface javax.infobus.DataItem

getSource, release

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControlledByInterface

getController, setController

Methods inherited from interface javax.infobus.InfoBusDataConsumer

dataItemAvailable, dataItemRevoked

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Method Detail

getRange

P2DRange2DInterface getRange(P2DComponentInterface component)

Get the range of the channel.

Returns:

The range of the channel.

getXRange

P2DRange1DInterface getXRange(P2DComponentInterface component)

Get the x range of the channel.

Returns:

The x range of the channel.

getYRange

P2DRange1DInterface getYRange(P2DComponentInterface component)

Get the y range of the channel.

Returns:

The y range of the channel.

getMinCount

long getMinCount(P2DComponentInterface component)

Retrieves lowest value of the three column data counts.

Returns:

The lowest value count.

getMaxCount

long getMaxCount(P2DComponentInterface component)

Retrieves highest value of the three column data counts.

Returns:

The highest value count.

setXAxisName

void setXAxisName(P2DComponentInterface component,
                java.lang.String axisName)

Set the name of the x-axis. This routine fires a PropertyChangeEvent on propterty XAxis.

Parameters:

axisName - The new x-axis name.

getXAxisName

java.lang.String getXAxisName(P2DComponentInterface component)

Get the name of the x-axis. This method return null, if there isn't a axis available.

Returns:

The current name of the x-axis.

getXAxis

P2DAxisInterface getXAxis(P2DComponentInterface component)

Retrieve the x-axis.

Returns:

The x-axis object.

setYAxisName

void setYAxisName(P2DComponentInterface component,
                java.lang.String axisName)

Set the name of the y-axis. This routine fires a PropertyChangeEvent on propterty YAxis.

Parameters:

axisName - The new y-axis name.

getYAxisName

java.lang.String getYAxisName(P2DComponentInterface component)

Get the name of the y-axis. This method return null, if there isn't a axis available.

Returns:

The current name of the y-axis.

getYAxis

P2DAxisInterface getYAxis(P2DComponentInterface component)

Retrieve the y-axis.

Returns:

The y-axis object.

setXDataItemName

void setXDataItemName(P2DComponentInterface component,
                    java.lang.String dataItemName)

Set the name of the x DataItem. This name is used as a infobus membername. It must specify the item and the bus name in the following syntax:

itemName@infobusName

This routine fires a PropertyChangeEvent on propterty XDataItemName.

Parameters:

dataItemName - The new name of the x DataItem.

getXDataItemName

java.lang.String getXDataItemName(P2DComponentInterface component)

Get the name of the X DataItem. This method return null, if there isn't an item available.

Returns:

The current name of the X DataItem.

setYDataItemName

void setYDataItemName(P2DComponentInterface component,
                    java.lang.String dataItemName)

Set the name of the y DataItem. This name is used as a infobus membername. It must specify the item and the bus name in the following syntax:

itemName@infobusName

This routine fires a PropertyChangeEvent on propterty YDataItemName.

Parameters:

dataItemName - The new name of the y DataItem.

getYDataItemName

java.lang.String getYDataItemName(P2DComponentInterface component)

Get the name of the y DataItem. This method return null, if there isn't an item available.

Returns:

The current name of the y DataItem.

getPointAt

P2DPointInterface getPointAt(P2DComponentInterface component,
                           int index)

Get the point at the specified index.

Returns:

The poibnt at specified index.

initializeAxis

void initializeAxis(P2DComponentInterface component)

Initialize the axes. This method is called by an axis after creation.

getXColumn

FwkColumnAccessInterface getXColumn(P2DComponentInterface component)

The the x column that belongs to that channel.

Returns:

The column

getYColumn

FwkColumnAccessInterface getYColumn(P2DComponentInterface component)

The the y column that belongs to that channel.

Returns:

The column

setEnvelopeMeanLineVisible

void setEnvelopeMeanLineVisible(P2DComponentInterface component,
                              boolean flag)

Set the mean line visible.

Parameters:

flag - if true the mean line will be drawn.

getEnvelopeMeanLineVisible

boolean getEnvelopeMeanLineVisible(P2DComponentInterface component)

Get the mean line visible flag.

Returns:

true if the mean line will be drawn.

setEnvelopeMaxLineVisible

void setEnvelopeMaxLineVisible(P2DComponentInterface component,
                             boolean flag)

Set the envelope maximum line visible. This flag is checked when the display resolution is lower the the data resolution.

Parameters:

flag - if true the envelope maximum line will be drawn.

getEnvelopeMaxLineVisible

boolean getEnvelopeMaxLineVisible(P2DComponentInterface component)

Get the envelope maximum line visible flag. This flag is checked when the display resolution is lower the the data resolution.

Returns:

true if the envelope maximum line will be drawn.

setEnvelopeMinLineVisible

void setEnvelopeMinLineVisible(P2DComponentInterface component,
                             boolean flag)

Set the envelope minimum line visible. This flag is checked when the display resolution is lower the the data resolution.

Parameters:

flag - if true the envelope minimum line will be drawn.

getEnvelopeMinLineVisible

boolean getEnvelopeMinLineVisible(P2DComponentInterface component)

Get the envelope minimum line visible flag. This flag is checked when the display resolution is lower the the data resolution.

Returns:

true if the envelope minimum line will be drawn.

setShapeStroke

void setShapeStroke(P2DComponentInterface component,
                  java.awt.Stroke stroke)

Set the additional stroke for the shape.

Parameters:

component - The component the belongs to that model.

stroke - the additional stroke use parallel to the dotjoin stroke.

getShapeStroke

java.awt.Stroke getShapeStroke(P2DComponentInterface component)

Get the stroke used parallel to the dotjoin stroke.

Parameters:

component - The component the belongs to that model.

Returns:

The shape stroke.

setEnvelope

void setEnvelope(P2DComponentInterface component,
               boolean flag)

Configure the channel to draw all points (no envelope). Per default an envelope will be determined, if the resolution of the destination is to low.

Parameters:

component - The component the belongs to that model.

flag - if false the channel draws all the points.

getEnvelope

boolean getEnvelope(P2DComponentInterface component)

Get the flag that controls the channel to draw all points (no envelope). Per default an envelope will be determined, if the resolution of the destination is to low.

Parameters:

component - The component the belongs to that model.

Returns:

if false the channel draws all the points.

setMaxXStepSize

void setMaxXStepSize(P2DComponentInterface component,
                   double maxStepSize)

If this channel defines a continuous x data channel, that has steps, the normal drawing behavior is to draw a line from the end to the beginning of the next measuring point. An example is a time measurement with constant sample rate, but with interruptions. Stop after 3 three minutes and start again 2 minutes later. During the measurement the sample rate doesn't change. The section between should not be draw as line, because there are no valid points. Use this method to specify an interval that is used to omit greater time steps. If you use a constants sample rate the following value may be a good choice: maxStepSize = getRange()/nPoints

Parameters:

component - The component the belongs to that model.

maxStepSize - the maximum step size that is concatenated by line in plot.

getMaxXStepSize

double getMaxXStepSize(P2DComponentInterface component)

Get the maximum step size.

Parameters:

component - The component the belongs to that model.

Returns:

the maximum step size that is concatenated by line in plot.

See Also:

setMaxXStepSize(P2DComponentInterface, double)