|
||||||||||
| PREV CLASS Documentation homepage NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectilog.cpl.model.IlpDefaultObject
ilog.tgo.model.IltObject
ilog.tgo.model.IltBTSAntenna
public class IltBTSAntenna
The class IltBTSAntenna is used to represent
cellular transmitting and receiving antennas.
An antenna must be contained in a BTS object.
| Nested Class Summary | |
|---|---|
static class |
IltBTSAntenna.Type
This enumeration lists the types of antennas. |
| Nested classes/interfaces inherited from class ilog.tgo.model.IltObject |
|---|
IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType |
| Field Summary | |
|---|---|
static IlpIntegerKey |
BeamDirection
|
static IltAttribute |
BeamDirectionAttribute
Attribute used to define the beam direction of the BTS antenna. |
static IlpIntegerKey |
BeamWidth
|
static IltAttribute |
BeamWidthAttribute
Attribute used to define the beam width of the BTS antenna. |
static IlpFloatKey |
MappedAlphaBeamWidth
|
static IlpBooleanKey |
MappedAntennaAntialiasing
|
static IlpIntegerKey |
MappedAntennaRadius
|
static IlpBooleanKey |
MappedAntennaVisible
|
static IlpBooleanKey |
MappedBeamWidthBorderVisible
|
static IlpIntegerKey |
MappedBeamWidthRadius
|
static IlpBooleanKey |
MappedBeamWidthVisible
|
static IlpIntegerKey |
MappedPowerMaxValue
|
static IlpIntegerKey |
MappedRotation
|
static IltObjectInfo |
metainfo
Contains metainformation about this IltObject class. |
static IlpIntegerKey |
Power
|
static IltAttribute |
PowerAttribute
Attribute used to define the power of the BTS antenna. |
static IltAttribute |
TypeAttribute
Attribute used to define the type of the BTS antenna in the Object System. |
| Fields inherited from interface ilog.cpl.model.IlpAttributeValueHolder |
|---|
VALUE_NOT_SET |
| Constructor Summary | |
|---|---|
IltBTSAntenna(IlpClass ilpClass,
Object identifier)
Creates a new object with the given class and identifier. |
|
IltBTSAntenna(Object identifier)
Creates a new object with the given identifier. |
|
IltBTSAntenna(String label,
IltObjectState state,
int beamDirection,
int power,
int beamWidth)
Creates a new antenna. |
|
| Method Summary | |
|---|---|
void |
applyTransform(IltGraphicManager manager,
IltGraphic graphic,
IlvTransformer t,
IlpPositionSource reason)
Deprecated. |
void |
computeGraphic(IltGraphicManager manager,
IlvPoint position)
Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation
visible. |
ilog.tgo.graphic.internal.base.IltBaseElement |
createBase(IltcGraphicElementAggregate root)
Creates a base element, suitable for this particular kind of object, for use with the Symbolic Graphic Representation Style. |
ilog.tgo.graphic.internal.IltGraphicUpdate |
createPositionUpdate(Object position,
Object positionInManager)
Creates the graphic update responsible for setting the position/shape to a graphical representation. |
Object |
defaultShape()
Returns the default shape, used when an object is made visible without having been assigned a shape. |
IlvRect |
getBaseRectangle(IltGraphicManager manager)
Returns the base rectangle of the graphic representation in a given IltGraphicManager. |
int |
getBeamDirection()
Returns the beam direction of the antenna, in degrees. |
int |
getBeamWidth()
Returns the beam width of the antenna, in degrees. |
protected IlvPoint |
getCenterPoint(IltGraphicManager manager,
IltGraphic graphic)
Returns the shape graphic setting. |
IlvPoint |
getCenterPointInManager(IltGraphicManager manager,
IltGraphic graphic)
Returns the position of the graphic representation in a given IltGraphicManager. |
static IltLegend |
GetClassLegend()
Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism. Please refer to the User's Manual for further information. |
IltBTS |
getContainer()
Deprecated. Containment relationships should be stored in a Datasource. Please use the DataSource API to retrieve the parent object for this BTS antenna. |
static IltObjectInfo |
GetIlpClass()
Returns the IlpClass corresponding to this Java class. |
ilog.util.internal.IlAVector |
getMappedForUserList()
|
IltGraphic |
getOutermostParentGraphic(IltGraphicManager manager)
This method is overridden by the subclasses which can be contained in other IltObjects. |
int |
getPower()
Returns the power of the antenna. |
IltBTSAntenna.Type |
getType()
Returns the type of the antenna. |
protected void |
initializeBTSAntenna(int beamDirection,
int power,
int beamWidth)
This method must only be called by the constructors. |
protected void |
initializeObject(IltObjectState state,
String name)
This method is only called by the constructor. |
boolean |
isValidPosition(Object position)
Determines whether the argument is a valid position/shape for this type of object. |
void |
postCreateGraphic(IltGraphicManager manager,
IltGraphic graphic)
This is called at the end of adding a graphic representation to a given view. |
void |
setAttributeValue(IlpAttribute attribute,
Object value)
Sets the value of an attribute of this object. |
void |
setBaseRectangle(IltGraphicManager manager,
IlvRect newBaseRectangle)
Applies a transformation to the graphic representation in a given IltGraphicManager, attempting to make the base rectangle resemble the given rectangle. |
void |
setBeamDirection(int beamDirection)
Changes the beam direction of the antenna. |
void |
setBeamWidth(int beamWidth)
Changes the beam width of the antenna. |
void |
setCenterPoint(IltGraphicManager manager,
IltGraphic graphic,
IlvPoint position,
IlpPositionSource reason)
Changes the shape graphic setting. |
void |
setContainer(IltBTS btsCont)
Specifies the container of this IltBTSAntenna. |
void |
setPower(int power)
Changes the power of the antenna. |
void |
setType(IltBTSAntenna.Type type)
Changes the type of the antenna. |
Object |
transformPosition(IltGraphicManager manager,
Object position)
Applies the manager transformer to the position parameter. |
void |
updateShapeGraphicSettingInManager(IltGraphicManager manager,
IltGraphic graphic,
Object newShape,
IlpPositionSource reason)
If the graphic representation is visible, updates the shape graphic setting in manager coordinates. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static IltObjectInfo metainfo
IltObject class.
public static IltAttribute TypeAttribute
Attribute name: type.
Value type: ilog.tgo.model.IltBTSAntenna.Type}
public static IltAttribute BeamWidthAttribute
Attribute name: beamWidth.
Value type: Integer.
public static IltAttribute PowerAttribute
Attribute name: power.
Value type: Integer.
public static IltAttribute BeamDirectionAttribute
Attribute name: beamDirection.
Value type: Integer.
public static IlpIntegerKey BeamWidth
public static IlpIntegerKey Power
public static IlpIntegerKey BeamDirection
public static IlpIntegerKey MappedRotation
public static IlpIntegerKey MappedPowerMaxValue
public static IlpIntegerKey MappedAntennaRadius
public static IlpFloatKey MappedAlphaBeamWidth
public static IlpIntegerKey MappedBeamWidthRadius
public static IlpBooleanKey MappedAntennaVisible
public static IlpBooleanKey MappedBeamWidthVisible
public static IlpBooleanKey MappedAntennaAntialiasing
public static IlpBooleanKey MappedBeamWidthBorderVisible
| Constructor Detail |
|---|
public IltBTSAntenna(String label,
IltObjectState state,
int beamDirection,
int power,
int beamWidth)
label - The label that will appear on the antennastate - The semantic state of the antennabeamDirection - The direction of the antenna, in degreespower - The power of the antennabeamWidth - The beamwidth of the antenna, in degreespublic IltBTSAntenna(Object identifier)
identifier - The identifier of this new instance
public IltBTSAntenna(IlpClass ilpClass,
Object identifier)
ilpClass - The business class of this new instance. It must be a
subclass of IltBTSAntenna.identifier - The identifier of this new instance| Method Detail |
|---|
public static IltObjectInfo GetIlpClass()
protected void initializeObject(IltObjectState state,
String name)
initializeObject in class IltObjectIltObject.initializeObject(ilog.tgo.model.IltObjectState, java.lang.String)
protected void initializeBTSAntenna(int beamDirection,
int power,
int beamWidth)
public void setBeamDirection(int beamDirection)
beamDirection - The beam direction of the antenna, in degreespublic int getBeamDirection()
public void setPower(int power)
power - The power of the antennapublic int getPower()
public void setBeamWidth(int beamWidth)
beamWidth - The beam width of the antenna, in degreespublic int getBeamWidth()
public IltBTSAntenna.Type getType()
public void setType(IltBTSAntenna.Type type)
public void setAttributeValue(IlpAttribute attribute,
Object value)
VALUE_NOT_SET for the value
argument.
setAttributeValue in interface IlpAttributeValueHoldersetAttributeValue in class IltObjectattribute - The attribute which value is setvalue - The new value of the attribute or
VALUE_NOT_SET to remove the value
of the attribute
IllegalArgumentException - if the attribute cannot have
its value modifiedpublic IltBTS getContainer()
IltBTS) of
this IltBTSAntenna.
IltDefaultDataSourcepublic void setContainer(IltBTS btsCont)
public IltGraphic getOutermostParentGraphic(IltGraphicManager manager)
public static IltLegend GetClassLegend()
public void computeGraphic(IltGraphicManager manager,
IlvPoint position)
IlpNetwork, is enough to make its graphic representation
visible.
IltGraphicManager. The graphic representation is put
at the given position.
public Object transformPosition(IltGraphicManager manager,
Object position)
computeGraphic (mgr, position)
transformPosition in class IltObjectpublic boolean isValidPosition(Object position)
IltObjectThis function overridden in subclasses. Accepted positions are:
IlvPoint for IltNetworkElement,
IltOffPageConnector, IltShelf,
IlvRect for IltRectGroup,
IltShelfItem,
IlpPolyline for IltAbstractLink,
IltLinearGroup,
IlpPolygon for IltPolyGroup.
isValidPosition in class IltObject
public ilog.tgo.graphic.internal.IltGraphicUpdate createPositionUpdate(Object position,
Object positionInManager)
null, the position/shape set will be
the default value.
createPositionUpdate in class IltObjectposition - the shape in stationary coordinatespositionInManager - the shape in manager coordinates (takes into
account the logical zoom transformer)
public void updateShapeGraphicSettingInManager(IltGraphicManager manager,
IltGraphic graphic,
Object newShape,
IlpPositionSource reason)
updateShapeGraphicSettingInManager in class IltObjectnewShape - the new shape in stationary coordinates; null
means the current value of the shape graphic settingreason - the reason for the shape change, or null if
unknown
protected IlvPoint getCenterPoint(IltGraphicManager manager,
IltGraphic graphic)
getCenterPoint in class IltObject
public void setCenterPoint(IltGraphicManager manager,
IltGraphic graphic,
IlvPoint position,
IlpPositionSource reason)
setCenterPoint in class IltObject
public IlvPoint getCenterPointInManager(IltGraphicManager manager,
IltGraphic graphic)
getCenterPointInManager in class IltObjectpublic IlvRect getBaseRectangle(IltGraphicManager manager)
getBaseRectangle in class IltObjectnull if the base has no extent at all
public void setBaseRectangle(IltGraphicManager manager,
IlvRect newBaseRectangle)
setBaseRectangle in class IltObjectpublic Object defaultShape()
defaultShape in class IltObject
public void applyTransform(IltGraphicManager manager,
IltGraphic graphic,
IlvTransformer t,
IlpPositionSource reason)
IltObjectIltGraphicManager.
Note: t is given relative to the stationary
coordinate system, which is the coordinate system used by the other
IltObject subclasses API functions.
Note that this method is not supposed to be used when this
IltObject is in a DataSource.
applyTransform in class IltObjectmanager - The graphic manager where the object is displayed.graphic - The graphic representation in the manager.t - The transform parameter.reason - The reason for the shape change, or null if unknownIltObject.applyTransform(ilog.tgo.graphic.IltGraphicManager, ilog.views.IlvTransformer),
IltGraphicManager.getZoomTransformer()
public void postCreateGraphic(IltGraphicManager manager,
IltGraphic graphic)
IltObject
postCreateGraphic in class IltObjectpublic ilog.tgo.graphic.internal.base.IltBaseElement createBase(IltcGraphicElementAggregate root)
IltObject
createBase in class IltObjectIltCompositeGraphic.createBase(IltcGraphicElementAggregate, IltObject),
IltObject.createTinyBase(IltcGraphicElementAggregate)public ilog.util.internal.IlAVector getMappedForUserList()
getMappedForUserList in class IltObject
|
||||||||||
| PREV CLASS Documentation homepage NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||