Package cern.accsoft.steering.jmad.modeldefs.domain

Interface JMadModelDefinition

All Superinterfaces:

ModelFileDependant

All Known Implementing Classes:

AbstractModelDefinition, JMadModelDefinitionImpl

public interface JMadModelDefinition
extends ModelFileDependant

This interface represents a general definition of a model-configuration for jmad. It can be implemented directly by a class, which provides a configuration.

Method Summary

Modifier and Type	Method	Description
OpticsDefinition	getDefaultOpticsDefinition()
RangeDefinition	getDefaultRangeDefinition()	convenience method to return the default range of the default sequence.
SequenceDefinition	getDefaultSequenceDefinition()
java.util.List<ModelFile>	getInitFiles()	this method must return all the ModelFiles that shall be called during the initialization process of the model.
java.lang.String	getModelPackUri()
ModelPathOffsets	getModelPathOffsets()
java.lang.String	getName()
OpticsDefinition	getOpticsDefinition(java.lang.String name)	retrieves the optics definition by its name.
java.util.List<OpticsDefinition>	getOpticsDefinitions()
java.util.List<RangeDefinition>	getRangeDefinitions()	convenience method to return all range definitions which are contained in the sequence definitions.
SequenceDefinition	getSequenceDefinition(java.lang.String name)	retrieves the sequence definition of the given name.
java.util.List<SequenceDefinition>	getSequenceDefinitions()
SourceInformation	getSourceInformation()

Methods inherited from interface cern.accsoft.steering.jmad.domain.file.ModelFileDependant

getRequiredFiles

Method Detail

getName

java.lang.String getName()

Returns:

the name

getInitFiles

java.util.List<ModelFile> getInitFiles()

this method must return all the ModelFiles that shall be called during the initialization process of the model.

Returns:

the files to be called

getSequenceDefinitions

java.util.List<SequenceDefinition> getSequenceDefinitions()

Returns:

the names of all SequenceImpls defined for this machine

getDefaultSequenceDefinition

SequenceDefinition getDefaultSequenceDefinition()

Returns:

the sequence definition, which shall be selected by default

getSequenceDefinition

SequenceDefinition getSequenceDefinition(java.lang.String name)

retrieves the sequence definition of the given name.

Parameters:

name - the name of the sequence definition

Returns:

the SequenceDefinition if found, null otherwise.

getRangeDefinitions

java.util.List<RangeDefinition> getRangeDefinitions()

convenience method to return all range definitions which are contained in the sequence definitions.

Returns:

all the range definitions

getDefaultRangeDefinition

RangeDefinition getDefaultRangeDefinition()

convenience method to return the default range of the default sequence.

Returns:

the default range

getOpticsDefinitions

java.util.List<OpticsDefinition> getOpticsDefinitions()

Returns:

all the possible optics definitions available for this model

getDefaultOpticsDefinition

OpticsDefinition getDefaultOpticsDefinition()

Returns:

the default optics definition for this model

getOpticsDefinition

OpticsDefinition getOpticsDefinition(java.lang.String name)

retrieves the optics definition by its name.

Parameters:

name - the name of the opticsDefinition

Returns:

the opticsDefinition if found, null otherwise

getModelPathOffsets

ModelPathOffsets getModelPathOffsets()

Returns:

the ModelPathOffsets for the ModelFiles

getSourceInformation

SourceInformation getSourceInformation()

Returns:

the SourceInformation for the model definition, which describes from which source the Model definition was loaded.

getModelPackUri

java.lang.String getModelPackUri()

Returns:

the URI to the origin model pack of the model definition. This URI can be used with jmad-modelpack-service to retrieve this definition at a later time. If this definition was not loaded from a model pack, null is returned. Unlike getSourceInformation(), this provides a more "high level" view on the origin location, independent of the (possibly temporary) location in the file system.