at.lcm.x2c.scilab.xcos

Class XcosBlockNameMigration

java.lang.Object

at.lcm.x2c.scilab.xcos.XcosBlockNameMigration

public class XcosBlockNameMigration
extends java.lang.Object

Migration of the X2C blocks of an Xcos diagram file to the current Xcos block names.
Older X2C versions truncated the Xcos block name (interface function "x2c_<Block>" and simulation function "x2c_<Block>_<Implementation>_C") to the 24 character limit of Scilab 5. Since this limit no longer applies, the full block name is used now. Diagrams created with an older X2C version still refer to the truncated names and have to be migrated.
The X2C block is identified by the block name stored in its Xcos expressions, therefore the migration is unambiguous and can be applied to an already migrated diagram again.
The diagram is modified via the Xcos controller (only the properties interface function, simulation function and style of the X2C blocks are changed). Modifying the diagram via the Scilab structure scs_m is not used because in Scilab 6.1 replacing a block in scs_m disconnects its links.

Author:

Markus Aigner

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BACKUP_EXTENSION Extension of backup file
static java.lang.String	XCOS_NAME_PREFIX Prefix of X2C Xcos block names

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBackupFileName() Returns the backup file name.
java.lang.String[]	getChanges() Returns the migrated blocks.
java.lang.String[]	getWarnings() Returns the warnings of the migration (blocks which couldn't be migrated completely).
static XcosBlockNameMigration	migrate(java.lang.String fileName) Migrates the X2C blocks of an Xcos diagram file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XCOS_NAME_PREFIX

public static final java.lang.String XCOS_NAME_PREFIX

Prefix of X2C Xcos block names

See Also:

Constant Field Values

BACKUP_EXTENSION

public static final java.lang.String BACKUP_EXTENSION

Extension of backup file

See Also:

Constant Field Values

Method Detail

migrate

public static XcosBlockNameMigration migrate(java.lang.String fileName)
                                      throws java.lang.Exception

Migrates the X2C blocks of an Xcos diagram file.
If blocks have to be migrated, a backup "<file>.bak" is created and the diagram is saved to the original file. Otherwise the file is not changed.

Parameters:

fileName - Xcos diagram file name (*.zcos or *.xcos)

Returns:

Migration result

Throws:

java.lang.Exception - if the file is not an Xcos diagram, is write protected, the backup file already exists or the diagram couldn't be loaded or saved

getChanges

public java.lang.String[] getChanges()

Returns the migrated blocks.

Returns:

Migrated blocks ("<path>/<block>: <old name> -> <new name>")

getWarnings

public java.lang.String[] getWarnings()

Returns the warnings of the migration (blocks which couldn't be migrated completely).

Returns:

Warnings

getBackupFileName

public java.lang.String getBackupFileName()

Returns the backup file name.

Returns:

Backup file name or empty string if no backup was created (file not changed)