• Home
• org.coosproject
• actorframe-j2se
• 1.2.2
• source code
• RoleCS.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.coos.javaframe.RoleCS Maven / Gradle / Ivy

/**
 * COOS - Connected Objects Operating System (www.connectedobjects.org).
 *
 * Copyright (C) 2009 Telenor ASA and Tellu AS. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 *
 * You may also contact one of the following for additional information:
 * Telenor ASA, Snaroyveien 30, N-1331 Fornebu, Norway (www.telenor.no)
 * Tellu AS, Hagalokkveien 13, N-1383 Asker, Norway (www.tellu.no)
 */
package org.coos.javaframe;

import org.coos.actorframe.messages.AFConstants;
import org.coos.javaframe.messages.AFPropertyMsg;
import org.coos.javaframe.messages.ActorMsg;

import java.util.Vector;

/**
 * @author Geir Melby, Tellu AS
 */
public class RoleCS extends CompositeState implements AFConstants {

	protected State idle = new State("idle", this);

	ActorAddress parentAddress;

	public RoleCS(String s) {
		super(s);
	}

	/**
	 * The constructor
	 * 
	 * @param sn
	 *            The name of the state
	 * @param cs
	 *            The enclosing state
	 */
	public RoleCS(String sn, CompositeState cs) {
		super(sn, cs);
	}

	/**
	 * Makes the current statemachine enter idle
	 * 
	 * @param curfsm
	 *            The current statemachine
	 */
	public void enterState(StateMachine curfsm) {
		curfsm.setInitialState(idle);
		idle.enterState(curfsm);
	}

	public ActorAddress getParentAddress() {
		return parentAddress;
	}

	public void setParentAddress(ActorAddress parentAddress) {
		this.parentAddress = parentAddress;
	}

	public void nextState(State st) {
		nextState(st, curfsm);
	}

	/**
	 * Sets the next state, where the new state is a composiste state. The entry
	 * point is defined
	 * 
	 * @param st
	 *            is the new state
	 * @param entryNo
	 *            is the entry number of the composiste state
	 */
	public void nextState(State st, int entryNo) {
		nextState(st, entryNo, curfsm);
	}

	/**
	 * Remain in the same State of the StateMachine. The method is to be used
	 * within the method execTrans(). Notice that entry() of this State will not
	 * be executed. That means performExit() should neither have been called.
	 */
	public void sameState() {
		sameState(curfsm);
	}

	/**
	 * Exit current state. The extit method is run.
	 */
	public void performExit() {
		performExit(curfsm);
	}

	/**
	 * Execute exit() from currentState up to (but not including) this
	 * CompositeState. The method is to be used within the method execTrans() of
	 * RoleCS type. An performExit flag in StateMachine is set to enable check
	 * of inkonsistent use of nextstate and performExit in the transistion. If
	 * this method has been called before during the same transition, the call
	 * should be ignored
	 */
	public void performExit(CompositeState cs) {
		performExit(curfsm, cs);
	}

	/**
	 * Saves the sig into current state machine
	 * 
	 * @param sig
	 *            is the signal to be saved
	 */
	public void save(ActorMsg sig) {
		save(sig, curfsm);
	}

	/**
	 * Start a timer with length as milliseconds and the name of the timer
	 * 
	 * @param duration
	 *            is the length of the timer in milliseconds
	 * @param timerId
	 *            is the timer id, used to identify the timer at the receiving
	 *            time.
	 */
	public void startTimer(long duration, String timerId) {
		curfsm.startTimer(duration, timerId);
	}

	/**
	 * Sends a actor message with signal name and the receiver of the message.
	 * An AFProperty message will be created with no properties. a simple
	 * message with no properties.
	 * 
	 * @param sigName
	 *            is the name of the signal
	 * @param receiver
	 *            is the receiver addres specified as a string on format
	 *            :@:@:@