vega.uplink.pointing

Interface PointingBlockSetInterface

All Known Implementing Classes:

Itl, Observation, ObservationPointingSlice, PointingBlocksSlice, PtrSegment

public interface PointingBlockSetInterface

Method Summary

Methods

Modifier and Type	Method and Description
void	addBlock(PointingBlockInterface newBlock) Add a new block to the given segment
PointingBlockInterface	blockAfter(PointingBlockInterface block)
PointingBlockInterface	blockBefore(PointingBlockInterface block) Get the block before the one given (before the start time the block), or null if there is no block before this one
PointingBlockSetInterface	getAllBlocksOfType(java.lang.String blockType) Get all blocks of a given type
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
PointingBlockInterface[]	getBlocks() Get all the blocks in this segment
PointingBlockSetInterface	getBlocksAt(java.util.Date startTime, java.util.Date endTime)
java.lang.String	getName() Get the name of this segment
void	regenerate(PointingBlockSetInterface slice)
void	removeBlock(PointingBlockInterface block) Remove a block from the segment.
void	removeBlocks(PointingBlock[] blocks)
void	setBlocks(PointingBlockInterface[] newBlocks) Remove all currents blocks and substitute by the given ones
void	setName(java.lang.String newName) Set or replace the name of this segment
void	setSlice(PointingBlockSetInterface slice)
java.lang.String	toXml(int indent) Get the XML representation of this segment as per FD ICD

Method Detail

regenerate

void regenerate(PointingBlockSetInterface slice)

getName

java.lang.String getName()

Get the name of this segment

Returns:

name of the segment

setName

void setName(java.lang.String newName)

Set or replace the name of this segment

Parameters:

newName -

removeBlock

void removeBlock(PointingBlockInterface 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

PointingBlockInterface blockBefore(PointingBlockInterface 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

PointingBlockInterface blockAfter(PointingBlockInterface block)

addBlock

void addBlock(PointingBlockInterface newBlock)

Add a new block to the given segment

Parameters:

newBlock - Block to be added

getBlocks

PointingBlockInterface[] getBlocks()

Get all the blocks in this segment

Returns:

Array with all the blocks in this segment

setBlocks

void setBlocks(PointingBlockInterface[] newBlocks)

Remove all currents blocks and substitute by the given ones

Parameters:

newBlocks - New blocks to replace the current ones

toXml

java.lang.String toXml(int indent)

Get the XML representation of this segment as per FD ICD

Parameters:

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

Returns:

The XML representation of this segment

getBlockAt

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

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

PointingBlockSetInterface getBlocksAt(java.util.Date startTime,
                                    java.util.Date endTime)

removeBlocks

void removeBlocks(PointingBlock[] blocks)

getAllBlocksOfType

PointingBlockSetInterface getAllBlocksOfType(java.lang.String blockType)

Get all blocks of a given type

Parameters:

blockType - type of blocks to search for

Returns:

an array of blocks of the given type

setSlice

void setSlice(PointingBlockSetInterface slice)