Commit bcc4d62a authored by Thibaut Démare's avatar Thibaut Démare

Some javadoc

parent 353a676a
...@@ -19,6 +19,16 @@ import msi.gaml.types.IType; ...@@ -19,6 +19,16 @@ import msi.gaml.types.IType;
import org.graphstream.gama.extension.GSManager; import org.graphstream.gama.extension.GSManager;
import org.graphstream.gama.extension.IKeywordGSAdditional; import org.graphstream.gama.extension.IKeywordGSAdditional;
/**
* Implements the {@code gs_add_receiver} command.
*
* <pre>
* gs_add_receiver gs_receiver_id:receiverId gs_host:host gs_port:port;
* (gs_add_receiver gs_receiver_id:receiverId gs_host:host gs_port:port gs_attributes_filtered:listAttributes;)
* </pre>
* @author Thibaut Dmare
*
*/
@symbol(name = IKeywordGSAdditional.ADD_RECEIVER, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false) @symbol(name = IKeywordGSAdditional.ADD_RECEIVER, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
@inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER }) @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
@facets(value = { @facet(name = IKeywordGSAdditional.RECEIVERID, type = IType.STRING, optional = false), @facets(value = { @facet(name = IKeywordGSAdditional.RECEIVERID, type = IType.STRING, optional = false),
......
...@@ -12,6 +12,15 @@ import msi.gaml.statements.IStatement; ...@@ -12,6 +12,15 @@ import msi.gaml.statements.IStatement;
import org.graphstream.gama.extension.GSManager; import org.graphstream.gama.extension.GSManager;
import org.graphstream.gama.extension.IKeywordGSAdditional; import org.graphstream.gama.extension.IKeywordGSAdditional;
/**
* Implements the {@code gs_clear_receivers} command.
*
* <pre>
* gs_clear_receivers;
* </pre>
* @author Thibaut Dmare
*
*/
@symbol(name = IKeywordGSAdditional.CLEAR_RECEIVERS, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false) @symbol(name = IKeywordGSAdditional.CLEAR_RECEIVERS, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
@inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER }) @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
public class ClearReceiversStatement extends AbstractStatement implements IStatement{ public class ClearReceiversStatement extends AbstractStatement implements IStatement{
......
...@@ -17,7 +17,15 @@ import msi.gaml.types.IType; ...@@ -17,7 +17,15 @@ import msi.gaml.types.IType;
import org.graphstream.gama.extension.GSManager; import org.graphstream.gama.extension.GSManager;
import org.graphstream.gama.extension.IKeywordGSAdditional; import org.graphstream.gama.extension.IKeywordGSAdditional;
/**
* Implements the {@code gs_flush} command.
*
* <pre>
* gs_flush gs_receiver_id:receiverId;
* </pre>
* @author Thibaut Dmare
*
*/
@symbol(name = IKeywordGSAdditional.FLUSH, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false) @symbol(name = IKeywordGSAdditional.FLUSH, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
@inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER }) @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
@facets(value = { @facet(name = IKeywordGSAdditional.RECEIVERID, type = IType.STRING, optional = false)}) @facets(value = { @facet(name = IKeywordGSAdditional.RECEIVERID, type = IType.STRING, optional = false)})
......
...@@ -17,7 +17,15 @@ import msi.gaml.types.IType; ...@@ -17,7 +17,15 @@ import msi.gaml.types.IType;
import org.graphstream.gama.extension.GSManager; import org.graphstream.gama.extension.GSManager;
import org.graphstream.gama.extension.IKeywordGSAdditional; import org.graphstream.gama.extension.IKeywordGSAdditional;
/**
* Implements the {@code gs_get_edge_attribute} command.
*
* <pre>
* gs_get_edge_attribute gs_receiver_id:receiverId gs_edge_id:edgeId gs_attribute_name:name returns:list;
* </pre>
* @author Thibaut Dmare
*
*/
@symbol(name = IKeywordGSAdditional.GET_EDGE_ATTRIBUTE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false) @symbol(name = IKeywordGSAdditional.GET_EDGE_ATTRIBUTE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
@inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER }) @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
@facets(value = { @facet(name = IKeywordGSAdditional.RECEIVERID, type = IType.STRING, optional = false), @facets(value = { @facet(name = IKeywordGSAdditional.RECEIVERID, type = IType.STRING, optional = false),
......
...@@ -17,7 +17,15 @@ import msi.gaml.types.IType; ...@@ -17,7 +17,15 @@ import msi.gaml.types.IType;
import org.graphstream.gama.extension.GSManager; import org.graphstream.gama.extension.GSManager;
import org.graphstream.gama.extension.IKeywordGSAdditional; import org.graphstream.gama.extension.IKeywordGSAdditional;
/**
* Implements the {@code gs_get_graph_attribute} command.
*
* <pre>
* gs_get_graph_attribute gs_receiver_id:receiverId gs_attribute_name:name returns:list;
* </pre>
* @author Thibaut Dmare
*
*/
@symbol(name = IKeywordGSAdditional.GET_GRAPH_ATTRIBUTE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false) @symbol(name = IKeywordGSAdditional.GET_GRAPH_ATTRIBUTE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
@inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER }) @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
@facets(value = { @facet(name = IKeywordGSAdditional.RECEIVERID, type = IType.STRING, optional = false), @facets(value = { @facet(name = IKeywordGSAdditional.RECEIVERID, type = IType.STRING, optional = false),
......
...@@ -17,7 +17,15 @@ import msi.gaml.types.IType; ...@@ -17,7 +17,15 @@ import msi.gaml.types.IType;
import org.graphstream.gama.extension.GSManager; import org.graphstream.gama.extension.GSManager;
import org.graphstream.gama.extension.IKeywordGSAdditional; import org.graphstream.gama.extension.IKeywordGSAdditional;
/**
* Implements the {@code gs_get_node_attribute} command.
*
* <pre>
* gs_get_node_attribute gs_receiver_id:receiverId gs_node_id:nodeId gs_attribute_name:name returns:list;
* </pre>
* @author Thibaut Dmare
*
*/
@symbol(name = IKeywordGSAdditional.GET_NODE_ATTRIBUTE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false) @symbol(name = IKeywordGSAdditional.GET_NODE_ATTRIBUTE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
@inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER }) @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
@facets(value = { @facet(name = IKeywordGSAdditional.RECEIVERID, type = IType.STRING, optional = false), @facets(value = { @facet(name = IKeywordGSAdditional.RECEIVERID, type = IType.STRING, optional = false),
......
...@@ -17,7 +17,16 @@ import msi.gaml.types.IType; ...@@ -17,7 +17,16 @@ import msi.gaml.types.IType;
import org.graphstream.gama.extension.GSManager; import org.graphstream.gama.extension.GSManager;
import org.graphstream.gama.extension.IKeywordGSAdditional; import org.graphstream.gama.extension.IKeywordGSAdditional;
/**
* Implements the {@code gs_wait_step} command.
*
* <pre>
* gs_wait_step gs_receiver_id:receiverId;
* (gs_wait_step gs_receiver_id:receiverId gs_return:returnVar;)
* </pre>
* @author Thibaut Dmare
*
*/
@symbol(name = IKeywordGSAdditional.WAIT_STEP, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false) @symbol(name = IKeywordGSAdditional.WAIT_STEP, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
@inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER }) @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
@facets(value = { @facet(name = IKeywordGSAdditional.RECEIVERID, type = IType.STRING, optional = false), @facets(value = { @facet(name = IKeywordGSAdditional.RECEIVERID, type = IType.STRING, optional = false),
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment