vega.uplink.pointing

Class PtrSegment

java.lang.Object

Product

vega.uplink.pointing.PointingBlocksSlice

vega.uplink.pointing.PtrSegment

All Implemented Interfaces:

PointingBlockSetInterface

public class PtrSegment
extends PointingBlocksSlice

Contains the pointing request for a certain MTP period

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATA_TAG
static java.lang.String	FRAME_TAG
static java.lang.String	HREF_TAG
static java.lang.String	INCLUDE_TAG
static java.lang.String	METADATA_TAG
static java.lang.String	NAME_TAG
static java.lang.String	SEGMENT_TAG
static java.lang.String	TIMELINE_TAG

Constructor Summary

Constructors

Constructor and Description
PtrSegment(java.lang.String segmentName) Create a PTR segment with the given name

Method Summary

Methods

Modifier and Type	Method and Description
void	addBlock(PointingBlock newBlock) Add a new block to the given segment
void	addInclude(java.lang.String newInclude) Add a single include to this segment
Product	asProduct()
PointingBlock	blockAfter(PointingBlock block)
PointingBlock	blockBefore(PointingBlock block) Get the block before the one given (before the start time the block), or null if there is no block before this one
PtrSegment	copy()
PointingBlocksSlice	getAllBlocksOfInstrument(java.lang.String instrument)
PointingBlocksSlice	getAllBlocksOfType(java.lang.String blockType) Get all blocks of a given type
PointingBlocksSlice	getAllBlocksOfVstp(int vstp)
PointingBlock[]	getAllSlews()
PointingBlocksSlice[]	getAllSlices()
PointingBlock	getBlockAt(java.util.Date time) Get the block with a start time equal to the given one or the greates value before the given date
PointingBlock[]	getBlocks() Get all the blocks in this segment
PointingBlocksSlice	getBlocksAt(java.util.Date startTime, java.util.Date endTime)
java.lang.String	getName() Get the name of this segment
java.lang.String	getPdfm()
java.util.Date	getSegmentEndDate()
java.util.Date	getSegmentStartDate()
PointingBlocksSlice	getSlice(int number)
java.lang.String	getTimeLineFrame() Get the time frame of this segment
int[]	getVstpNumbers()
protected void	hardInsertBlock(PointingBlock block)
protected void	hardInsertBlocks(PointingBlock[] blocks)
protected void	hardRemoveBlock(PointingBlock block)
protected void	hardRemoveBlocks(PointingBlock[] blocks)
protected void	hardSetSlice(PointingBlocksSlice slice)
void	removeBlock(PointingBlock block) Remove a block from the segment.
void	removeBlocks(PointingBlock[] blocks)
void	repairConsecutiveBlocks()
void	repairMocm() Check if there is any gap before a MOCM, MWOL or MSLW block (which have) internal slews and extend the observation before to end at the beginning of the maintenance block
void	repairSlews() Check if there is any gap and fill it with slews.
void	setBlocks(PointingBlock[] newBlocks) Remove all currents blocks and substitute by the given ones
void	setIncludes(java.lang.String[] newIncludes) Set or replace the includes of this segment (will appear in the XML)
void	setName(java.lang.String newName) Set or replace the name of this segment
void	setSlice(PointingBlocksSlice slice)
void	setTimeLineFrame(java.lang.String newFrame) Set the time frame that will be specified in the xml
java.lang.String	toXml(int indent) Get the XML representation of this segment as per FD ICD

Methods inherited from class vega.uplink.pointing.PointingBlocksSlice

addBlock, blockAfter, blockBefore, getAllMaintenanceBlocks, hardInsertBlock, regenerate, removeBlock, setBlocks, setSlice

Methods inherited from class java.lang.Object

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

Field Detail

SEGMENT_TAG

public static java.lang.String SEGMENT_TAG

METADATA_TAG

public static java.lang.String METADATA_TAG

NAME_TAG

public static java.lang.String NAME_TAG

INCLUDE_TAG

public static java.lang.String INCLUDE_TAG

HREF_TAG

public static java.lang.String HREF_TAG

DATA_TAG

public static java.lang.String DATA_TAG

TIMELINE_TAG

public static java.lang.String TIMELINE_TAG

FRAME_TAG

public static java.lang.String FRAME_TAG

Constructor Detail

PtrSegment

public PtrSegment(java.lang.String segmentName)

Create a PTR segment with the given name

Parameters:

segmentName - Name of the segment

Method Detail

copy

public PtrSegment copy()

Overrides:

copy in class PointingBlocksSlice

asProduct

public Product asProduct()

Overrides:

asProduct in class PointingBlocksSlice

getSegmentStartDate

public java.util.Date getSegmentStartDate()

getSegmentEndDate

public java.util.Date getSegmentEndDate()

hardRemoveBlock

protected void hardRemoveBlock(PointingBlock block)

Overrides:

hardRemoveBlock in class PointingBlocksSlice

hardRemoveBlocks

protected void hardRemoveBlocks(PointingBlock[] blocks)

Overrides:

hardRemoveBlocks in class PointingBlocksSlice

hardInsertBlock

protected void hardInsertBlock(PointingBlock block)

hardInsertBlocks

protected void hardInsertBlocks(PointingBlock[] blocks)

removeBlock

public void removeBlock(PointingBlock block)

Remove a block from the segment. It adjust as well the slews if they are affected by the removal.

Parameters:

block - Block to be removed

blockBefore

public PointingBlock blockBefore(PointingBlock block)

Get the block before the one given (before the start time the block), or null if there is no block before this one

Parameters:

block -

Returns:

blockAfter

public PointingBlock blockAfter(PointingBlock block)

repairConsecutiveBlocks

public void repairConsecutiveBlocks()

repairMocm

public void repairMocm()

Check if there is any gap before a MOCM, MWOL or MSLW block (which have) internal slews and extend the observation before to end at the beginning of the maintenance block

Overrides:

repairMocm in class PointingBlocksSlice

repairSlews

public void repairSlews()

Check if there is any gap and fill it with slews. It is recommended to run repairMocm() before to avoid that a slew

Overrides:

repairSlews in class PointingBlocksSlice

addBlock

public void addBlock(PointingBlock newBlock)

Add a new block to the given segment

Parameters:

newBlock - Block to be added

getBlocks

public PointingBlock[] getBlocks()

Get all the blocks in this segment

Specified by:

getBlocks in interface PointingBlockSetInterface

Overrides:

getBlocks in class PointingBlocksSlice

Returns:

Array with all the blocks in this segment

setBlocks

public void setBlocks(PointingBlock[] newBlocks)

Remove all currents blocks and substitute by the given ones

Parameters:

newBlocks - New blocks to replace the current ones

setTimeLineFrame

public void setTimeLineFrame(java.lang.String newFrame)

Set the time frame that will be specified in the xml

Parameters:

newFrame - The new time frame

getTimeLineFrame

public java.lang.String getTimeLineFrame()

Get the time frame of this segment

Returns:

THe string representing the time frame of this segment

getName

public java.lang.String getName()

Get the name of this segment

Specified by:

getName in interface PointingBlockSetInterface

Overrides:

getName in class PointingBlocksSlice

Returns:

name of the segment

getPdfm

public java.lang.String getPdfm()

setName

public void setName(java.lang.String newName)

Set or replace the name of this segment

Specified by:

setName in interface PointingBlockSetInterface

Overrides:

setName in class PointingBlocksSlice

Parameters:

newName -

setIncludes

public void setIncludes(java.lang.String[] newIncludes)

Set or replace the includes of this segment (will appear in the XML)

Parameters:

newIncludes -

addInclude

public void addInclude(java.lang.String newInclude)

Add a single include to this segment

Parameters:

newInclude - new include to be added

toXml

public java.lang.String toXml(int indent)

Get the XML representation of this segment as per FD ICD

Specified by:

toXml in interface PointingBlockSetInterface

Overrides:

toXml in class PointingBlocksSlice

Parameters:

indent - the Number of tabs to be added before each line

Returns:

The XML representation of this segment

getBlockAt

public PointingBlock getBlockAt(java.util.Date time)

Get the block with a start time equal to the given one or the greates value before the given date

Specified by:

getBlockAt in interface PointingBlockSetInterface

Overrides:

getBlockAt in class PointingBlocksSlice

Parameters:

time - The desired time

Returns:

The block with a start time less or equal to the given time or null if there is no such block

getBlocksAt

public PointingBlocksSlice getBlocksAt(java.util.Date startTime,
                              java.util.Date endTime)

Specified by:

getBlocksAt in interface PointingBlockSetInterface

Overrides:

getBlocksAt in class PointingBlocksSlice

removeBlocks

public void removeBlocks(PointingBlock[] blocks)

Specified by:

removeBlocks in interface PointingBlockSetInterface

Overrides:

removeBlocks in class PointingBlocksSlice

getAllBlocksOfType

public PointingBlocksSlice getAllBlocksOfType(java.lang.String blockType)

Get all blocks of a given type

Specified by:

getAllBlocksOfType in interface PointingBlockSetInterface

Overrides:

getAllBlocksOfType in class PointingBlocksSlice

Parameters:

blockType - type of blocks to search for

Returns:

an array of blocks of the given type

getAllSlews

public PointingBlock[] getAllSlews()

getAllBlocksOfVstp

public PointingBlocksSlice getAllBlocksOfVstp(int vstp)

getVstpNumbers

public int[] getVstpNumbers()

getAllSlices

public PointingBlocksSlice[] getAllSlices()

getSlice

public PointingBlocksSlice getSlice(int number)

hardSetSlice

protected void hardSetSlice(PointingBlocksSlice slice)

setSlice

public void setSlice(PointingBlocksSlice slice)

getAllBlocksOfInstrument

public PointingBlocksSlice getAllBlocksOfInstrument(java.lang.String instrument)