Diamond (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.gui.visualization.jfreechart.shape.AbstractShapeGenerator
      - adams.gui.visualization.jfreechart.shape.Diamond

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable
```
public class Diamond
extends AbstractShapeGenerator
```
Generates a diamond.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected float m_Size
the size.
- Fields inherited from class adams.core.option.AbstractOptionHandler
  m_OptionManager
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

Diamond()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected Shape`	`doGenerate()`	Generates the shape.
`float`	`getSize()`	Returns the size of the diamond.
`String`	`globalInfo()`	Returns a string describing the object.
`void`	`setSize(float value)`	Sets the size of the diamond.
`String`	`sizeTipText()`	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.jfreechart.shape.AbstractShapeGenerator
check, generate

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - m_Size
```
protected float m_Size
```
    the size.
- Constructor Detail
  - Diamond
```
public Diamond()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - setSize
```
public void setSize(float value)
```
    Sets the size of the diamond.
    
    Parameters:
    
    value - the size
  - getSize
```
public float getSize()
```
    Returns the size of the diamond.
    
    Returns:
    
    the size
  - sizeTipText
```
public String sizeTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - doGenerate
```
protected Shape doGenerate()
```
    Generates the shape.
    
    Specified by:
    
    doGenerate in class AbstractShapeGenerator
    
    Returns:
    
    the shape, null if none generated