Commands Class Reference

This class provides some higher level functionality to communicate with a Vinci instance. More...

List of all members.

Public Member Functions
function	Commands (in connection)
	Creates a new Vinci.Commands object.
function	echo (in obj, in message, in excludeNewLine)
	Writes a message to Vinci's log view.
function	logViewToFront (in obj)
	Brings Vinci's log view to the front.
function	newProject (in obj)
	Creates a new empty project in Vinci.
function	newEmptyProject (in obj)
	Opens a new empty project in Vinci.
function	newDefaultProject (in obj)
	Opens a new default project.
function	openProject (in obj, in projectFile)
	Opens an existing project file in Vinci.
function	getVersionInfo (in obj)
	Returns a structure containing version information about the version and build date of Vinci used.
function	getVinciBinDir (in obj)
	Returns the directory, which contains the binary of the running Vinci instance.
function	executeProgramFile (in obj, in filename)
	Executes one Vinci program file.
function	getVinciObjects (in obj, in filter)
	Returns a list of target names to Vinci objects.

---

Detailed Description

This class provides some higher level functionality to communicate with a Vinci instance.

You can use Vinci.Commands instances to write messages to Vinci's logview, query version information about the version of Vinci, you use, create new projects or open existing ones and execute a Vinci program file.

---

Constructor & Destructor Documentation

function Commands

(

in

connection

)

Creates a new Vinci.Commands object.

Vinci.Commands objects do not have any state except for a Vinci.Connect object to communicate with an instance of Vinci.

Usage:

• obj = Vinci.Commands(connection)

Parameters:

connection

A Vinci.Connect object. This object is used by the Vinci.Commands object to communicate with a Vinci instance.

Return values:

obj	A Vinci.Commands object.

---

Member Function Documentation

function echo	(	in	obj,
		in	message,
		in	excludeNewLine
	)

Writes a message to Vinci's log view.

Usage:

• obj.echo(message, [excludeNewLine])

Parameters:

obj	A Vinci.Commands object.
message	A string. The text send to Vinci.
excludeNewLine	optional. A logical. If true, no newline character will be appended to the end of the line.

Note:

Lines will not be printed without a trailing newline character. Therefore, make sure that you always append a newline when you want a line to be visible.

function executeProgramFile	(	in	obj,
		in	filename
	)

Executes one Vinci program file.

A Vinci program file records all steps performed within one Vinci session and is useful for automating some steps in Vinci. You can generate a Vinci program file from within Vinci with the menu entry "Export Vinci Program File..." in the "Edit" menu inside Vinci.

Usage:

• obj.executeProgramFile(filename)

Parameters:

obj	A Vinci.Commands object.
filename	A string. The name of the Vinci program file.

function getVersionInfo

(

in

obj

)

Returns a structure containing version information about the version and build date of Vinci used.

Usage:

• versionInfo = obj.getVersionInfo()

Parameters:

obj	A Vinci.Commands object.

Return values:

versionInfo

A struct with the fields Version, Title, BuildDate. All fields are strings.

function getVinciBinDir

(

in

obj

)

Returns the directory, which contains the binary of the running Vinci instance.

Usage:

• binDir = obj.getVinciBinDir()

Parameters:

obj	A Vinci.Commands object.

Return values:

binDir

A string. The path to the directory, which contains the binary of the running Vinci instance.

function getVinciObjects	(	in	obj,
		in	filter
	)

Returns a list of target names to Vinci objects.

The list can be filtered for objects of specific types.

Usage:

• targets = obj.getVinciObjects([filter])

Parameters:

obj	A Vinci.Commands object.
filter	optional. A string. The last part of a target name, without the trailing number. The list will be filtered for objects of this type. For example, if you want to query all image objects, specify 'Image' as a filter. If no filter is specified, the object list is returned unfiltered.

Return values:

targets

A list of strings. The target names for all objects in Vinci.

Examples:

  >> targets = obj.VinciObjects('Image')
  % returns all '::Project_0::Image_x' objects in Vinci.

  >> targets = obj.VinciObjects('Orthoview')
  % returns all ortho views (::Project_0::OrthoView_0)
  % but no ortho display (::Project_0::OrthoView_0::OrthoDisplay_2)

function logViewToFront

(

in

obj

)

Brings Vinci's log view to the front.

Usage:

• obj.logViewToFront()

Parameters:

obj	A Vinci.Commands object.

function newDefaultProject

(

in

obj

)

Opens a new default project.

The default project is the project, which is opened every time Vinci is started. Usually, this is equivalent to an empty project, however, the user can select another project within Vinci as the default project.

Usage:

• obj.newDefaultProject()

Parameters:

obj	A Vinci.Commands object.

function newEmptyProject

(

in

obj

)

Opens a new empty project in Vinci.

The same as Vinci.Commands.newProject(obj). If another project is already open, Vinci closes the existing project.

Usage:

• obj.newEmptyProject()

Parameters:

obj	A Vinci.Commands object.

See also:

Vinci.Commands.newProject()

function newProject

(

in

obj

)

Creates a new empty project in Vinci.

The same as Vinci.Commands.newEmptyProject.

Usage:

• obj.newProject()

Parameters:

obj	A Vinci.Commands object.

See also:

Vinci.Commands.newEmptyProject()

function openProject	(	in	obj,
		in	projectFile
	)

Opens an existing project file in Vinci.

Usage:

• obj.openProject(projectFile)

Parameters:

obj	A Vinci.Commands object.
projectFile	A string. The path to the project file, which should be opened.

---

The documentation for this class was generated from the following file:

• Commands.m