desmoj.extensions.visualization2d.engine.command

Class Command

java.lang.Object

desmoj.extensions.visualization2d.engine.command.Command

All Implemented Interfaces:

CommandSyntax, java.lang.Cloneable

public class Command
extends java.lang.Object

Command extends CommandFrame and implements execute(). Command is the connection to animation.model.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

christian.mueller@th-wildau.de For information about subproject: desmoj.extensions.visualization2d please have a look at: http://www.th-wildau.de/cmueller/Desmo-J/Visualization2d/ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields inherited from interface desmoj.extensions.visualization2d.engine.command.CommandSyntax

CMD_SYNTAX

Constructor Summary

Constructors

Constructor and Description
Command(java.lang.String cmd, java.lang.String remark, Parameter[] parameter) Constructor for CommandFrame, used for template generation used by CommandFactory.createCommand(cmd, remark, parameter).

Method Summary

Modifier and Type	Method and Description
void	addParameter(java.lang.String key, java.lang.String value) Add a parameter in commands parameter-array
void	addParameterCat(java.lang.String key, java.lang.String[] value) Add a parameter with value-compnents (e.g. coordinates) in commands parameter-array
desmoj.extensions.visualization2d.engine.command.CommandFrame	clone() creates a clone of a command
void	execute(Model model) This method describes for every command-type, how it's modeled in animation.model.Model.
static boolean	existCommand(java.lang.String cmd) checks if a command with name cmd in cmdTemplate exist.
java.lang.String	getCmd() Geter of command-name (command-type)
static Command	getCommandInit(java.lang.String cmd, long initTime) Get a clone of command-template with name cmd for init-phase
static Command	getCommandTime(java.lang.String cmd, long time) Get a clone of command-template with name cmd for run-phase time-value
Parameter	getParameter(int i) Get's i.th parameter from command's parameter-array
java.lang.String[]	getParameterSplit(java.lang.String key, int i) Get the i.th parameter-value of type key.
Parameter	getParameterType(java.lang.String type) Get's the parameter of type from command's parameter-array The parameter-type is unique in parameter-array
java.lang.String	getRemark() Geter of command-remark
long	getTime() get's time-value of command, makes sense only in run-phase
static void	init_cmdTemplate() Reads CommandSyntax, creates for each a templeate and store them in cmdTemplate
boolean	isInit() check if command belongs to init-phase
boolean	isTempleate() check if command is a template
static void	main(java.lang.String[] args) only for testing
static desmoj.extensions.visualization2d.engine.command.CommandFrame	parseCommand(java.lang.String cmd) Makes a syntax-check for cmd-string and create a CommandFrame of parsed cmd-string
void	setInit(long startTime) when set this, command belongs to init-phase
void	setNoTemplate() when set this, this command is no template
void	setRemark(java.lang.String remark) Setter of command-remark
void	setTime(long time) when set this, command belongs to run-phase with time-value time
boolean	syntaxCheck() Makes a syntax-check of command
java.lang.String	toString() Creates an information-string of command, used for log-file
static java.lang.String	writeTemplates() Write a information-string with all existing command-templates

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Command

public Command(java.lang.String cmd,
               java.lang.String remark,
               Parameter[] parameter)

Constructor for CommandFrame, used for template generation used by CommandFactory.createCommand(cmd, remark, parameter).

Parameters:

cmd - command-name

remark - remark about template

parameter - Array of Parameter's where each parameter must have a different type

Method Detail

getCommandInit

public static Command getCommandInit(java.lang.String cmd,
                                     long initTime)
                              throws CommandException

Get a clone of command-template with name cmd for init-phase

Parameters:

cmd -

Returns:

clone of command-template with name

Throws:

CommandException

getCommandTime

public static Command getCommandTime(java.lang.String cmd,
                                     long time)
                              throws CommandException

Get a clone of command-template with name cmd for run-phase time-value

Parameters:

cmd -

time -

Returns:

clone of command-template

Throws:

CommandException

execute

public void execute(Model model)
             throws CommandException,
                    ModelException

This method describes for every command-type, how it's modeled in animation.model.Model. this method must include a case for every command-type.

Throws:

CommandException

ModelException

main

public static void main(java.lang.String[] args)

only for testing

Parameters:

args - no args

init_cmdTemplate

public static void init_cmdTemplate()
                             throws CommandException

Reads CommandSyntax, creates for each a templeate and store them in cmdTemplate

Throws:

CommandException

existCommand

public static boolean existCommand(java.lang.String cmd)

checks if a command with name cmd in cmdTemplate exist.

Parameters:

cmd -

Returns:

true, if one exist

parseCommand

public static desmoj.extensions.visualization2d.engine.command.CommandFrame parseCommand(java.lang.String cmd)
                                                                                  throws CommandException

Makes a syntax-check for cmd-string and create a CommandFrame of parsed cmd-string

Parameters:

cmd -

Returns:

created CommandFrame

Throws:

CommandException

writeTemplates

public static java.lang.String writeTemplates()
                                       throws CommandException

Write a information-string with all existing command-templates

Returns:

information-string

Throws:

CommandException

getCmd

public java.lang.String getCmd()

Geter of command-name (command-type)

Returns:

command-name

getRemark

public java.lang.String getRemark()

Geter of command-remark

Returns:

remark-string

setRemark

public void setRemark(java.lang.String remark)

Setter of command-remark

Parameters:

remark -

getParameter

public Parameter getParameter(int i)

Get's i.th parameter from command's parameter-array

Parameters:

i -

Returns:

i.th parameter, null if no exist

getParameterType

public Parameter getParameterType(java.lang.String type)

Get's the parameter of type from command's parameter-array The parameter-type is unique in parameter-array

Parameters:

type -

Returns:

parameter if one found, null otherwise

addParameter

public void addParameter(java.lang.String key,
                         java.lang.String value)
                  throws CommandException

Add a parameter in commands parameter-array

Parameters:

key - parameter-type

value - parameter-value

Throws:

CommandException, - when parameter-type is not valid (why no quantifier check????)

CommandException

addParameterCat

public void addParameterCat(java.lang.String key,
                            java.lang.String[] value)
                     throws CommandException

Add a parameter with value-compnents (e.g. coordinates) in commands parameter-array

Parameters:

key - parameter-type

value - parameter-components

Throws:

CommandException, - when parameter-type is not valid

CommandException

getParameterSplit

public java.lang.String[] getParameterSplit(java.lang.String key,
                                            int i)
                                     throws CommandException

Get the i.th parameter-value of type key. The component of the value are splited in an array

Parameters:

key -

i -

Returns:

Array of value-components

Throws:

CommandException

setInit

public void setInit(long startTime)

when set this, command belongs to init-phase

setTime

public void setTime(long time)

when set this, command belongs to run-phase with time-value time

Parameters:

time -

setNoTemplate

public void setNoTemplate()

when set this, this command is no template

isInit

public boolean isInit()

check if command belongs to init-phase

Returns:

true when command in init-phase

isTempleate

public boolean isTempleate()

check if command is a template

Returns:

true when template

getTime

public long getTime()

get's time-value of command, makes sense only in run-phase

Returns:

time-value, stored in CommandFrame

syntaxCheck

public boolean syntaxCheck()
                    throws CommandException

Makes a syntax-check of command

Returns:

result of check

Throws:

CommandException

toString

public java.lang.String toString()

Creates an information-string of command, used for log-file

Overrides:

toString in class java.lang.Object

clone

public desmoj.extensions.visualization2d.engine.command.CommandFrame clone()
                                                                    throws java.lang.CloneNotSupportedException

creates a clone of a command

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException