org.netxms.client.maps.elements

Class NetworkMapElement

java.lang.Object

org.netxms.client.maps.elements.NetworkMapElement

Direct Known Subclasses:

NetworkMapDCIContainer, NetworkMapDCIImage, NetworkMapDecoration, NetworkMapObject, NetworkMapResource

public class NetworkMapElement
extends Object

Network map element.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	id
static int	MAP_ELEMENT_DCI_CONTAINER
static int	MAP_ELEMENT_DCI_IMAGE
static int	MAP_ELEMENT_DECORATION
static int	MAP_ELEMENT_GENERIC
static int	MAP_ELEMENT_OBJECT
protected int	type
protected int	x
protected int	y

Constructor Summary

Constructors

Modifier	Constructor and Description
	NetworkMapElement(long id) Create new generic element
protected	NetworkMapElement(org.netxms.base.NXCPMessage msg, long baseId) Create element from NXCP message.

Method Summary

Modifier and Type	Method and Description
void	addFlag(int flags)
static NetworkMapElement	createMapElement(org.netxms.base.NXCPMessage msg, long baseId) Factory method for creating map element from NXCP message.
boolean	equals(Object obj)
void	fillMessage(org.netxms.base.NXCPMessage msg, long baseId) Fill NXCP message with element data
int	getFlags()
long	getId()
int	getType()
int	getX()
int	getY()
int	hashCode()
void	removeFlag(int flags)
void	setFlags(int flags)
void	setLocation(int x, int y) Set elements's location

Methods inherited from class java.lang.Object

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

Field Detail

MAP_ELEMENT_GENERIC

public static final int MAP_ELEMENT_GENERIC

See Also:

Constant Field Values

MAP_ELEMENT_OBJECT

public static final int MAP_ELEMENT_OBJECT

See Also:

Constant Field Values

MAP_ELEMENT_DECORATION

public static final int MAP_ELEMENT_DECORATION

See Also:

Constant Field Values

MAP_ELEMENT_DCI_CONTAINER

public static final int MAP_ELEMENT_DCI_CONTAINER

See Also:

Constant Field Values

MAP_ELEMENT_DCI_IMAGE

public static final int MAP_ELEMENT_DCI_IMAGE

See Also:

Constant Field Values

id

protected long id

type

protected int type

x

protected int x

y

protected int y

Constructor Detail

NetworkMapElement

protected NetworkMapElement(org.netxms.base.NXCPMessage msg,
                            long baseId)

Create element from NXCP message.

Parameters:

msg - NXCP message

baseId - base variable ID

NetworkMapElement

public NetworkMapElement(long id)

Create new generic element

Method Detail

createMapElement

public static NetworkMapElement createMapElement(org.netxms.base.NXCPMessage msg,
                                                 long baseId)

Factory method for creating map element from NXCP message.

Parameters:

msg - NXCP message

baseId - base variable ID

Returns:

map element object

fillMessage

public void fillMessage(org.netxms.base.NXCPMessage msg,
                        long baseId)

Fill NXCP message with element data

Parameters:

msg - NXCP message

baseId - base variable ID

getType

public int getType()

Returns:

the type

getX

public int getX()

Returns:

the x

getY

public int getY()

Returns:

the y

getId

public long getId()

Returns:

the id

setLocation

public void setLocation(int x,
                        int y)

Set elements's location

Parameters:

x -

y -

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getFlags

public int getFlags()

Returns:

the flags

setFlags

public void setFlags(int flags)

Parameters:

flags - the flags to set

addFlag

public void addFlag(int flags)

Parameters:

flags - the flag to be added to current flags

removeFlag

public void removeFlag(int flags)

Parameters:

flags - the flag