Project: bml_lib License: BSD Dependencies: bml_msgs bml_srvs rosjava Used by: bml_realizer All Packages

bml_lib/src/edu/wpi/hri/bml/behavior/Behavior.java Go to the documentation of this file. /* * Software License Agreement (BSD License) * * Copyright (c) 2010, Worcester Polytechnic Institute * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following * disclaimer in the documentation and/or other materials provided * with the distribution. * * Neither the name of Worcester Polytechnic Institute. nor the names * of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ package edu.wpi.hri.bml.behavior; import org.w3c.dom.Document; import org.w3c.dom.Element; import edu.wpi.hri.log.Logger; import edu.wpi.hri.log.Logger.Colors; import edu.wpi.hri.log.Logger.LoggerLevel; public abstract class Behavior { private static final String ID_ATTR = "id"; private static final String START_ATTR = "start"; private static final String END_ATTR = "end"; private static final String REQUIRED_ELEM = "required"; protected final Logger logger; protected final String id; protected final boolean required; protected SyncRef start; protected SyncRef end; protected Behavior(Logger logger, Element elem) { // check if this behavior is required this.required = ((Element) elem.getParentNode()).getNodeName().equals( REQUIRED_ELEM); // get the id as it is required String s = elem.getAttribute(ID_ATTR); if (s == null || s.isEmpty()) throw new IllegalArgumentException("Invalid id attribute"); this.id = s; // now create the logger from the id this.logger = logger.sub(Colors.BEHAVIOR, this.id); // then the start attribute if (elem.hasAttribute(START_ATTR)) this.start = new SyncRef(elem.getAttribute(START_ATTR)); else this.start = null; // and the end attribute if (elem.hasAttribute(END_ATTR)) this.end = new SyncRef(elem.getAttribute(END_ATTR)); else this.end = null; } protected Behavior(Logger logger, String id, boolean required) { this.id = id; this.logger = logger.sub(Colors.BEHAVIOR, this.id); this.required = required; } public String getID() { return this.id; } public boolean isRequired() { return required; } public void setStart(SyncRef start) { this.start = start; } public void setEnd(SyncRef end) { this.end = end; } public SyncRef getStart() { return start; } public SyncRef getEnd() { return end; } protected abstract String getElementName(); protected abstract void appendAttributes(Document doc, Element elem); public final Element toBML(Document doc) { this.logger.debug(LoggerLevel.BEHAVIOR, "Converting to BML"); Element elem = doc.createElement(this.getElementName()); // always add the id to the element elem.setAttribute(ID_ATTR, this.id); // possibly add the start attribute if (this.start != null) elem.setAttribute(START_ATTR, this.start.toString()); // and possibly add the end to the element if (this.end != null) elem.setAttribute(END_ATTR, this.end.toString()); // then append the behavior attributes this.appendAttributes(doc, elem); if (this.required) { Element base = doc.createElement(REQUIRED_ELEM); base.appendChild(elem); return base; } else return elem; } }

---

bml_lib
Author(s): Aaron Holroyd (aholroyd (at) wpi (dot) edu)
autogenerated on Fri Sep 9 10:44:05 2011