de.cesr.more.basic.agent
Class MAbstractAnalyseNetworkAgent<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>

java.lang.Object
  de.cesr.more.basic.agent.MAbstractNetworkAgent<A,E>
      de.cesr.more.basic.agent.MAbstractAnalyseNetworkAgent<A,E>

All Implemented Interfaces:

MoreAgentAnalyseNetworkComp<A,E>, MoreAgentNetworkComp<A,E>, MoreNetworkAgent<A,E>, MoreNodeMeasureSupport, MoreDistanceAttachableAgent

public abstract class MAbstractAnalyseNetworkAgent<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>
extends MAbstractNetworkAgent<A,E>
implements MoreAgentAnalyseNetworkComp<A,E>, MoreDistanceAttachableAgent

MORe

Date:

16.12.2011

Field Summary

Fields inherited from class de.cesr.more.basic.agent.MAbstractNetworkAgent

measures

Constructor Summary

MAbstractAnalyseNetworkAgent()

MAbstractAnalyseNetworkAgent(repast.simphony.space.gis.Geography<Object> geography)

Method Summary

void	addAmbassador()
int	getBlacklistSize()
int	getInDegree() Returns the number of incoming links.
float	getNbrDispers() Calculates the average distance between this household and its neighbours.
int	getNetKDev()
double	getNetPrefDev()
double	getNetworkDistanceWeight(double meanDistance, double distance) Provides a weight regarding the given distance.
float	getNNAvgDeg() Returns the average in-degree of nearest neighbours (see Boguna2004)
int	getNumAmbassadors()
int	getOutDegree() Returns the number of outgoing links.
int	getXtInDegree() Adds 1 to prevent 0 values for sizing in GIS
void	setNumAmbassadors(int number) USed in combination with MGeoRsHomophilyDistanceFfNetworkService.

Methods inherited from class de.cesr.more.basic.agent.MAbstractNetworkAgent

getMainNetwork, getNetwork, getNetworkComp, getNetworkMeasureObject, getNetworks, getThis, setMainNetwork, setNetwork, setNetworkComp, setNetworkMeasureObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.cesr.more.basic.agent.MoreAgentNetworkComp

getMainNetwork, getNetwork, getNetworks, setMainNetwork, setNetwork

Constructor Detail

MAbstractAnalyseNetworkAgent

public MAbstractAnalyseNetworkAgent(repast.simphony.space.gis.Geography<Object> geography)

Parameters:

env -

name -

MAbstractAnalyseNetworkAgent

public MAbstractAnalyseNetworkAgent()

Parameters:

env -

name -

Method Detail

getInDegree

public int getInDegree()

Description copied from interface: MoreAgentAnalyseNetworkComp

Returns the number of incoming links.

Specified by:

getInDegree in interface MoreAgentAnalyseNetworkComp<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>

Returns:

indegree

See Also:

MoreAgentAnalyseNetworkComp.getInDegree()

getXtInDegree

public int getXtInDegree()

Description copied from interface: MoreAgentAnalyseNetworkComp

Adds 1 to prevent 0 values for sizing in GIS

Specified by:

getXtInDegree in interface MoreAgentAnalyseNetworkComp<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>

Returns:

indegree + 1

See Also:

MoreAgentAnalyseNetworkComp.getXtInDegree()

getOutDegree

public int getOutDegree()

Description copied from interface: MoreAgentAnalyseNetworkComp

Returns the number of outgoing links.

Specified by:

getOutDegree in interface MoreAgentAnalyseNetworkComp<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>

Returns:

outdegree

See Also:

MoreAgentAnalyseNetworkComp.getOutDegree()

getNbrDispers

public float getNbrDispers()

Description copied from interface: MoreAgentAnalyseNetworkComp

Calculates the average distance between this household and its neighbours.

Specified by:

getNbrDispers in interface MoreAgentAnalyseNetworkComp<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>

Returns:

average distance

See Also:

MoreAgentAnalyseNetworkComp.getNbrDispers()

getNNAvgDeg

public float getNNAvgDeg()

Description copied from interface: MoreAgentAnalyseNetworkComp

Returns the average in-degree of nearest neighbours (see Boguna2004)

Specified by:

getNNAvgDeg in interface MoreAgentAnalyseNetworkComp<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>

Returns:

average degree of nearest neighbours

See Also:

MoreAgentAnalyseNetworkComp.getNNAvgDeg()

getNetPrefDev

public double getNetPrefDev()

Specified by:

getNetPrefDev in interface MoreAgentAnalyseNetworkComp<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>

Returns:

See Also:

MoreAgentAnalyseNetworkComp.getNetPrefDev()

getNetKDev

public int getNetKDev()

Specified by:

getNetKDev in interface MoreAgentAnalyseNetworkComp<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>

Returns:

See Also:

MoreAgentAnalyseNetworkComp.getNetKDev()

addAmbassador

public void addAmbassador()

getNumAmbassadors

public int getNumAmbassadors()

Specified by:

getNumAmbassadors in interface MoreAgentAnalyseNetworkComp<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>

setNumAmbassadors

public void setNumAmbassadors(int number)

Description copied from interface: MoreAgentAnalyseNetworkComp

USed in combination with MGeoRsHomophilyDistanceFfNetworkService.

Specified by:

setNumAmbassadors in interface MoreAgentAnalyseNetworkComp<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>

See Also:

MoreAgentAnalyseNetworkComp.setNumAmbassadors(int)

getNetworkDistanceWeight

public double getNetworkDistanceWeight(double meanDistance,
                                       double distance)

Description copied from interface: MoreDistanceAttachableAgent

Provides a weight regarding the given distance. I.e., some agents might prefer distant links, others might solely like local links. High weights promote agents that are the given distance away, low weights discriminate such agents. Since such a preference may not only depend on the agent's milieu but also on its geographical embeddedness (in urban context the perception of distance is potentially different from rural contexts) the weight can be provided on an individual level instead by milieu preferences.

Specified by:

getNetworkDistanceWeight in interface MoreAgentAnalyseNetworkComp<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>

Specified by:

getNetworkDistanceWeight in interface MoreDistanceAttachableAgent

Parameters:

meanDistance - mean distance between all agents (by default only computed at initialisation of network service)

Returns:

the distance weight for the given distance

See Also:

MoreAgentAnalyseNetworkComp.getNetworkDistanceWeight(double, double)

getBlacklistSize

public int getBlacklistSize()

Specified by:

getBlacklistSize in interface MoreAgentAnalyseNetworkComp<A extends MoreNetworkAgent<A,E> & MoreMilieuAgent,E extends MoreEdge<? super A>>

Returns:

number of agents in blacklist (with respect to DofN)

See Also:

MoreAgentAnalyseNetworkComp.getBlacklistSize()