Package jmri

Class EntryPoint

java.lang.Object

jmri.EntryPoint

public class EntryPoint
extends java.lang.Object

Represent an EntryPoint to a Section of track. Specifies a Block within the Section, and a Path of that Block.

An EntryPoint can be "forward" or "reverse" type, depending on if a train entering the Section at this entry point will be travelling in the forward direction or the reverse direction.

An EntryPoint is referenced via lists in its parent Section, and is stored on disk when its parent section is stored.

This module delays initialization of Blocks until first reference after an Entry Point is loaded from a configuration file.

Field Summary

Fields

Modifier and Type	Field	Description
static int	FORWARD
static int	REVERSE
static int	UNKNOWN	Constants representing the Direction of the Entry Point.

Constructor Summary

Constructors

Constructor	Description
EntryPoint(java.lang.String bName, java.lang.String fbName, java.lang.String fbDir)
EntryPoint(Block b, Block pb, java.lang.String fbDir)

Method Summary

Modifier and Type	Method	Description
Block	getBlock()	Get the block.
int	getDirection()
Block	getFromBlock()
java.lang.String	getFromBlockDirection()
java.lang.String	getFromBlockName()
boolean	isFixed()
boolean	isForwardType()
boolean	isReverseType()
boolean	isUnknownType()
void	setDirection(int dir)
void	setFixed(boolean f)
void	setTypeForward()
void	setTypeReverse()
void	setTypeUnknown()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNKNOWN

public static final int UNKNOWN

Constants representing the Direction of the Entry Point.

See Also:

Constant Field Values

FORWARD

public static final int FORWARD

See Also:

Constant Field Values

REVERSE

public static final int REVERSE

See Also:

Constant Field Values

Constructor Detail

EntryPoint

public EntryPoint(Block b,
                  Block pb,
                  java.lang.String fbDir)

EntryPoint

public EntryPoint(java.lang.String bName,
                  java.lang.String fbName,
                  java.lang.String fbDir)

Method Detail

getBlock

public Block getBlock()

Get the block.

Returns:

the block, initialized if needed

getFromBlockName

public java.lang.String getFromBlockName()

getFromBlock

public Block getFromBlock()

setTypeForward

public void setTypeForward()

setTypeReverse

public void setTypeReverse()

setTypeUnknown

public void setTypeUnknown()

isForwardType

public boolean isForwardType()

isReverseType

public boolean isReverseType()

isUnknownType

public boolean isUnknownType()

getDirection

public int getDirection()

setDirection

public void setDirection(int dir)

setFixed

public void setFixed(boolean f)

isFixed

public boolean isFixed()

getFromBlockDirection

public java.lang.String getFromBlockDirection()