JMadModelDefinitionExportRequest (jmad-core API)

java.lang.Object
- cern.accsoft.steering.jmad.modeldefs.io.JMadModelDefinitionExportRequest

```
public class JMadModelDefinitionExportRequest
extends java.lang.Object
```
This class allows to formulate a 'request' for exporting particular optics, sequences and/or ranges from a JMadModelDefinition. Request should be created using the builder, available through the from() method.
This class is immutable.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class JMadModelDefinitionExportRequest.Builder
Builder class

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static JMadModelDefinitionExportRequest`	`allFrom(JMadModelDefinition modelDefinition)`	Create a request to export ALL optics, sequences and ranges from a given model definition.
`static JMadModelDefinitionExportRequest.Builder`	`from(JMadModelDefinition modelDefinition)`	Start the creation of a `JMadModelDefinitionExportRequest` for the given model definition.
`JMadModelDefinition`	`getModelDefinition()`	Get the model definition to export
`java.util.Set<OpticsDefinition>`	`getOpticsToExport()`	Get all optics to export
`java.util.Set<RangeDefinition>`	`getRangesToExport()`	Get all ranges to export
`java.util.Set<SequenceDefinition>`	`getSequencesToExport()`	Get all sequences to export (derived from the selected ranges)

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

- Method Detail
  - allFrom
```
public static JMadModelDefinitionExportRequest allFrom(JMadModelDefinition modelDefinition)
```
    Create a request to export ALL optics, sequences and ranges from a given model definition.
    
    Parameters:
    
    modelDefinition - the model to export
    
    Returns:
    
    the JMadModelDefinitionExportRequest
  - from
```
public static JMadModelDefinitionExportRequest.Builder from(JMadModelDefinition modelDefinition)
```
    Start the creation of a JMadModelDefinitionExportRequest for the given model definition.
    
    Parameters:
    
    modelDefinition - the model to export
    
    Returns:
    
    a builder for JMadModelDefinitionExportRequest
  - getOpticsToExport
```
public java.util.Set<OpticsDefinition> getOpticsToExport()
```
    Get all optics to export
    
    Returns:
    
    collection of optics to export
  - getSequencesToExport
```
public java.util.Set<SequenceDefinition> getSequencesToExport()
```
    Get all sequences to export (derived from the selected ranges)
    
    Returns:
    
    collection of sequences to export
  - getRangesToExport
```
public java.util.Set<RangeDefinition> getRangesToExport()
```
    Get all ranges to export
    
    Returns:
    
    collection of ranges to export
  - getModelDefinition
```
public JMadModelDefinition getModelDefinition()
```
    Get the model definition to export
    
    Returns:
    
    the model definition