FRODO Version 2.19.1
An open-source framework for Distributed Constraint Optimization (DCOP)
Loading...
Searching...
No Matches
frodo2.communication.MessageType Class Reference

The (hierarchical) type of a message. More...

Inheritance diagram for frodo2.communication.MessageType:
Inheritance graph
[legend]

Public Member Functions

 MessageType (String... path)
 Constructor.
boolean equals (Object o)
int hashCode ()
MessageType getParent ()
String toString ()
String getLeafType ()
Element toXML ()
MessageType newChild (String... subpath)
 Extends a message type with the input suffix, skipping ROOT if present.
MessageType newChild (MessageType subType)
 Extends this message type with the input one, skipping the ROOT.
boolean isParent (MessageType child)
 Checks whether this message type is a parent of the input.
int compareTo (MessageType o)

Static Public Member Functions

static MessageType fromXML (Element typeElmt)
 Parses a message type from XML.

Static Public Attributes

static final transient MessageType ROOT = new MessageType ()
 The root of the type hierarchy.
static final transient MessageType SYSTEM = new MessageType ("SYSTEM")
 The type of system messages.

Private Attributes

final String[] path
 The path in the type hierarchy.

Static Private Attributes

static final long serialVersionUID = 5665743800545692648L
 serialVersionUID for serialization
static final transient String ROOT_TYPE = "ALL"
 The type of the root of the type hierarchy.

Detailed Description

The (hierarchical) type of a message.

Author
Thomas Leaute

Constructor & Destructor Documentation

◆ MessageType()

frodo2.communication.MessageType.MessageType ( String... path)

Constructor.

Parameters
paththe type(s) of the message
Warning
Assumes the input path does not already start with the ROOT

References path, and ROOT_TYPE.

Referenced by compareTo(), equals(), fromXML(), getParent(), isParent(), newChild(), and newChild().

Member Function Documentation

◆ compareTo()

int frodo2.communication.MessageType.compareTo ( MessageType o)
See also
java.lang.Comparable#compareTo(java.lang.Object)

References compareTo(), MessageType(), and path.

Referenced by compareTo().

Here is the call graph for this function:

◆ equals()

boolean frodo2.communication.MessageType.equals ( Object o)
See also
java.lang.Object#equals(java.lang.Object)

References MessageType(), and path.

Referenced by frodo2.communication.mailer.CentralMailer.execute(), frodo2.gui.VisualizerControls.MsgTypeRenderer.getTreeCellEditorComponent(), frodo2.gui.VisualizerControls.MsgTypeRenderer.getTreeCellRendererComponent(), frodo2.gui.VisualizerControls.getTreeNode(), isParent(), frodo2.gui.VisualizerControls.MsgTypeSetting.MsgTypeSetting(), frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.notify(), frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.afb.AFB< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.AgentFactory< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.asodpop.ASODPOPBinaryDomains< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.count.CountSolutionsVALUE< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.memory.LabelingPhase< V extends Addable< V > >.notifyIn(), frodo2.algorithms.dpop.memory.MemoryBoundedUTIL< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.param.ParamUTIL< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.param.ParamVALUE< Val extends Addable< Val > >.notifyIn(), frodo2.algorithms.dpop.param.test.ParamVALUEtest< U extends Addable< U > >.Listener.notifyIn(), frodo2.algorithms.dpop.privacy.CollaborativeDecryption< C extends Addable< C >, E extends AddableLimited< C, E, K extends PublicKeyShare >.notifyIn(), frodo2.algorithms.dpop.privacy.EncryptedUTIL< V extends Addable< V >, U extends Addable< U >, E extends AddableLimited< U, E >.notifyIn(), frodo2.algorithms.dpop.privacy.RerootRequester< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.privacy.SecureCircularRouting.notifyIn(), frodo2.algorithms.dpop.privacy.test.SecureCircularRoutingTest.Forwarder.notifyIn(), frodo2.algorithms.dpop.privacy.test.SecureRerootingTest.notifyIn(), frodo2.algorithms.dpop.privacy.test.VariableObfuscationTest< V extends Addable< V > >.notifyIn(), frodo2.algorithms.dpop.privacy.VariableObfuscation< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.restart.UTILreuse.notifyIn(), frodo2.algorithms.dpop.stochastic.CompleteUTIL< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.stochastic.ExpectedUTIL< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.stochastic.LowestCommonAncestors.notifyIn(), frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable< U > >.AtLCAs< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable< U > >.AtLeaves< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable< U > >.AtRoots< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.stochastic.test.ExpectedUTILtest.Listener.notifyIn(), frodo2.algorithms.dpop.stochastic.test.LowestCommonAncestorsTest.notifyIn(), frodo2.algorithms.dpop.stochastic.test.SamplingPhaseTest.notifyIn(), frodo2.algorithms.dpop.test.UTILpropagationTest< U extends Addable< U > >.Listener.notifyIn(), frodo2.algorithms.dpop.test.VALUEpropagationTest< U extends Addable< U > >.Listener.notifyIn(), frodo2.algorithms.dpop.UTILpropagation< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.dpop.VALUEpropagation< Val extends Addable< Val > >.notifyIn(), frodo2.algorithms.duct.Normalize< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.NormalizeInf< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.Sampling< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingChild< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingChildSearch< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingPruning< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingPruningSearch< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.tests.NormalizeInfTest.notifyIn(), frodo2.algorithms.duct.tests.NormalizeTest.notifyIn(), frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.localSearch.dsa.tests.DSAagentTest< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.localSearch.mgm.mgm2.tests.MGM2agentTest< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.localSearch.mgm.tests.MGMagentTest< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.maxsum.MaxSum< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.mpc_discsp.MPC_DisCSP4< V extends Addable< V > >.notifyIn(), frodo2.algorithms.mpc_discsp.MPC_DisWCSP4< V extends Addable< V > >.notifyIn(), frodo2.algorithms.odpop.UTILpropagation< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.notifyIn(), frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.SingleQueueAgent< Val extends Addable< Val > >.notifyIn(), frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.synchbb.SynchBB< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.varOrdering.dfs.DFSgeneration< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.varOrdering.dfs.DFSgeneration< V extends Addable< V >, U extends Addable< U > >.ScoreBroadcastingHeuristic< S extends Comparable< S > &Serializable >.notifyIn(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.notifyIn(), frodo2.algorithms.varOrdering.dfs.DFSgenerationWithOrder< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.varOrdering.dfs.LocalRandVarsDFS< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.varOrdering.dfs.tests.DFSgenerationTest.notifyIn(), frodo2.algorithms.varOrdering.dfs.tests.DFSgenerationWithOrderTest.notifyIn(), frodo2.algorithms.varOrdering.election.LeaderElectionMaxID< T extends Comparable< T > &Serializable >.notifyIn(), frodo2.algorithms.varOrdering.election.tests.VariableElectionTest< S extends Comparable< S > &Serializable >.notifyIn(), frodo2.algorithms.varOrdering.election.VariableElection< S extends Comparable< S > &Serializable >.notifyIn(), frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.algorithms.varOrdering.linear.LinearOrdering< V extends Addable< V >, U extends Addable< U > >.notifyIn(), frodo2.communication.mailer.tests.testCentralMailer.notifyIn(), frodo2.controller.ConfigurationManager.notifyIn(), frodo2.controller.TestConfigurationManager.SimpleDaemonListener.notifyIn(), frodo2.controller.WhitePages.notifyIn(), frodo2.daemon.Constructor.notifyIn(), frodo2.daemon.LocalConfigManager.notifyIn(), frodo2.daemon.LocalWhitePages.notifyIn(), frodo2.daemon.TestLocalWhitePages.SimpleAgent.notifyIn(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.notifyInListeners(), frodo2.algorithms.dpop.privacy.VariableObfuscation< V extends Addable< V >, U extends Addable< U > >.notifyOut(), frodo2.algorithms.dpop.restart.UTILreuse.notifyOut(), frodo2.algorithms.varOrdering.dfs.DFSgenerationWithOrder< V extends Addable< V >, U extends Addable< U > >.processAdditionalMsgInformation(), frodo2.algorithms.dpop.privacy.VariableObfuscation< V extends Addable< V >, U extends Addable< U > >.sendDelayedMsg(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.sendMessage(), and frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.sendMessageToSelf().

Here is the call graph for this function:

◆ fromXML()

MessageType frodo2.communication.MessageType.fromXML ( Element typeElmt)
static

Parses a message type from XML.

Parameters
typeElmta "type" tag
Returns
the parsed message type

References MessageType().

Referenced by frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.DFSgenerationParallel(), frodo2.algorithms.AbstractDCOPsolver< V extends Addable< V >, U extends Addable< U >, S extends Solution< V, U >.overrideMsgTypes(), and frodo2.algorithms.afb.test.AFBagentTest< V extends Addable< V >, U extends Addable< U > >.setUp().

Here is the call graph for this function:

◆ getLeafType()

String frodo2.communication.MessageType.getLeafType ( )
Returns
the leaf type

Referenced by frodo2.gui.VisualizerControls.MsgTypeRenderer.getTreeCellEditorComponent(), and frodo2.gui.VisualizerControls.MsgTypeRenderer.getTreeCellRendererComponent().

◆ getParent()

MessageType frodo2.communication.MessageType.getParent ( )
Returns
the parent of this message type in the hierarchy

References MessageType(), and path.

Referenced by frodo2.communication.mailer.CentralMailer.execute(), frodo2.gui.Visualizer.getMsgViz(), frodo2.gui.VisualizerControls.getTreeNode(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.notifyInListeners(), frodo2.communication.mailer.CentralMailer.FakeQueue.notifyInListeners(), frodo2.communication.Queue.notifyInListeners(), frodo2.communication.mailer.CentralMailer.FakeQueue.notifyOutListeners(), frodo2.communication.Queue.notifyOutListeners(), and frodo2.communication.mailer.CentralMailer.run().

Here is the call graph for this function:

◆ hashCode()

int frodo2.communication.MessageType.hashCode ( )
See also
java.lang.Object#hashCode()

◆ isParent()

boolean frodo2.communication.MessageType.isParent ( MessageType child)

Checks whether this message type is a parent of the input.

Parameters
childpotential child message type
Returns
whether this is a parent of the input

References equals(), MessageType(), and path.

Referenced by frodo2.algorithms.dpop.privacy.SecureRerooting< C extends Addable< C >, E extends AddableLimited< C, E >.notifyIn(), frodo2.algorithms.test.MessageDebugger.notifyIn(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.notifyIn(), frodo2.algorithms.dpop.privacy.EncryptedUTIL< V extends Addable< V >, U extends Addable< U >, E extends AddableLimited< U, E >.notifyOut(), frodo2.algorithms.dpop.privacy.SecureRerooting< C extends Addable< C >, E extends AddableLimited< C, E >.notifyOut(), and frodo2.algorithms.test.MessageDebugger.notifyOut().

Here is the call graph for this function:

◆ newChild() [1/2]

MessageType frodo2.communication.MessageType.newChild ( MessageType subType)

Extends this message type with the input one, skipping the ROOT.

Parameters
subTypeinput message subtype
Returns
a concatenation of this message type and the input one

References MessageType(), newChild(), and path.

Here is the call graph for this function:

◆ newChild() [2/2]

MessageType frodo2.communication.MessageType.newChild ( String... subpath)

Extends a message type with the input suffix, skipping ROOT if present.

Parameters
subpaththe suffix
Returns
a new message type rooted at this

References MessageType(), path, and ROOT_TYPE.

Referenced by frodo2.algorithms.dpop.privacy.DeliveryMsg< M extends Message >.DeliveryMsg(), newChild(), frodo2.algorithms.varOrdering.dfs.ParallelDFSmsg< S extends Comparable< S > &Serializable >.ParallelDFSmsg(), and frodo2.algorithms.dpop.privacy.ToLastLeafMsg.ToLastLeafMsg().

Here is the call graph for this function:

◆ toString()

String frodo2.communication.MessageType.toString ( )
See also
java.lang.Object#toString()

Referenced by frodo2.algorithms.dpop.VALUEmsg< Val extends Addable< Val > >.toString().

◆ toXML()

Element frodo2.communication.MessageType.toXML ( )
  • Returns
    an XML representation of this message type

Member Data Documentation

◆ path

final String [] frodo2.communication.MessageType.path
private

The path in the type hierarchy.

Referenced by compareTo(), equals(), getParent(), isParent(), MessageType(), newChild(), and newChild().

◆ ROOT

final transient MessageType frodo2.communication.MessageType.ROOT = new MessageType ()
static

The root of the type hierarchy.

Referenced by frodo2.communication.mailer.CentralMailer.CentralMailer(), frodo2.communication.mailer.CentralMailer.CentralMailer(), frodo2.communication.QueueTest.ConstantMsgPolicy.ConstantMsgPolicy(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.FakeQueue(), frodo2.communication.mailer.CentralMailer.FakeQueue.FakeQueue(), frodo2.algorithms.test.MessageDebugger.getMsgTypes(), frodo2.communication.sharedMemory.QueueIOPipeTest.Collector.getMsgTypes(), frodo2.gui.VisualizerControls.MsgTypeRenderer.getTreeCellEditorComponent(), frodo2.gui.VisualizerControls.MsgTypeRenderer.getTreeCellRendererComponent(), frodo2.gui.VisualizerControls.getTreeNode(), frodo2.communication.Queue.init(), frodo2.gui.VisualizerControls.MsgTypeSetting.MsgTypeSetting(), and frodo2.gui.VisualizerControls.VisualizerControls().

◆ ROOT_TYPE

final transient String frodo2.communication.MessageType.ROOT_TYPE = "ALL"
staticprivate

The type of the root of the type hierarchy.

Referenced by MessageType(), and newChild().

◆ serialVersionUID

final long frodo2.communication.MessageType.serialVersionUID = 5665743800545692648L
staticprivate

serialVersionUID for serialization

◆ SYSTEM

final transient MessageType frodo2.communication.MessageType.SYSTEM = new MessageType ("SYSTEM")
static

The type of system messages.

Referenced by frodo2.algorithms.test.MessageDebugger.notifyIn(), and frodo2.algorithms.test.MessageDebugger.notifyOut().

The documentation for this class was generated from the following file: