VinciObject Class Reference

This class represents an Vinci object within Matlab. More...

Inheritance diagram for VinciObject:

List of all members.

Public Member Functions
function	VinciObject (in connection, in target)
	Constructs a proxy for an object within Vinci.
function	sendMessageToMe (in obj, in xmlStr)
	Sends a message to Vinci's counterpart of the VinciObject and receives an answer.
function	sendMessageToTarget (in obj, in target, in xmlStr)
	Sends a message to some target and receives an answer.
function	sendMessageToMeNoAnswer (in obj, in xmlStr)
	Sends a message to the VinciObject and tells Vinci to don't send an answer.
function	sendMessageToTargetNoAnswer (in obj, in target, in xmlStr)
	Sends a message to some target and tells Vinci to don't send an answer.
function	getTargetPartNumber (in obj, in partName)
	Returns the number specified in a part of a target name.
Static Public Member Functions
static function	getIdFromTarget (in connect, in target)
static function	getTargetNameQuery (in id)
static function	getTargetFromId (in connect, in id)
Public Attributes
Property< ReadOnly >	id
Property< ReadOnly >	connection
	The Vinci.Connect object used to communicate with Vinci.
Property< ReadOnly >	target
	The target name of the Vinci.VinciObject.

---

Detailed Description

This class represents an Vinci object within Matlab.

The object does not store any values except for a Vinci.Connect object and a target name. Target names are strings of the form '::' or '::Project_0::Image_3' and are used to identify objects within Vinci. The connection object is used to communicate with an instance of Vinci.

---

Constructor & Destructor Documentation

function VinciObject	(	in	connection,
		in	target
	)

Constructs a proxy for an object within Vinci.

Usage:

• obj = Vinci.VinciObject(connection, target)

Parameters:

connection	A Vinci.Connect object.
target	A string. The name of the target.

Return values:

obj	A Vinci.VinciObject

---

Member Function Documentation

static function getIdFromTarget	(	in	connect,
		in	target
	)		[static]

static function getTargetFromId	(	in	connect,
		in	id
	)		[static]

static function getTargetNameQuery

(

in

id

)

[static]

function getTargetPartNumber	(	in	obj,
		in	partName
	)

Returns the number specified in a part of a target name.

Target names consist of a hierarchy of numbered objects, e.g. '::Project_0::Image_3'. This function returns the number to a given object.

Usage:

• number = obj.getTargetPartNumber(partNumber)

Parameters:

obj	The Vinci.VinciObject instance. The target property of this object is used as target name.
partName	A substring of the target name for which the number should be returned. Examples are 'Project_' or 'Image'. The trailing _ can be left out.

Return values:

number

The number extracted from the target name of the object.

Examples:

  >> obj = Vinci.VinciObject(connection, '::Project_0::Image_3');
  >> imageNumber = obj.getTargetPartNumber('Image')
  % imageNumber is 3 (as an float)

function sendMessageToMe	(	in	obj,
		in	xmlStr
	)

Sends a message to Vinci's counterpart of the VinciObject and receives an answer.

Usage:

• answer = obj.sendMessageToMe(xmlStr)

Parameters:

obj	The Vinci.VinciObject instance.
xmlStr	A string. The message Matlab sends to Vinci.

Return values:

answer

A string. The answer returned by Vinci.

function sendMessageToMeNoAnswer	(	in	obj,
		in	xmlStr
	)

Sends a message to the VinciObject and tells Vinci to don't send an answer.

Usage:

• obj.sendMessageToMeNoAnswer(xmlStr)

Parameters:

obj	The Vinci.VinciObject instance.
xmlStr	A string. The message Matlab sends to Vinci.

function sendMessageToTarget	(	in	obj,
		in	target,
		in	xmlStr
	)

Sends a message to some target and receives an answer.

Usage:

• answer = obj.sendMessageToTarget(target, xmlStr)

Parameters:

obj	The Vinci.VinciObject instance.
target	A string. The name of the target.
xmlStr	A string. The message Matlab sends to Vinci.

Return values:

answer

A string. The answer returned by Vinci.

function sendMessageToTargetNoAnswer	(	in	obj,
		in	target,
		in	xmlStr
	)

Sends a message to some target and tells Vinci to don't send an answer.

Usage:

• obj.sendMessageToTarget(target, xmlStr)

Parameters:

obj	The Vinci.VinciObject instance.
target	A string. The name of the target.
xmlStr	A string. The message Matlab sends to Vinci.

---

Member Data Documentation

Property<ReadOnly> connection

The Vinci.Connect object used to communicate with Vinci.

This object determines, with which instance of Vinci the object will talk.

Property<ReadOnly> id

Property<ReadOnly> target

The target name of the Vinci.VinciObject.

Target names are strings in the form '::', '::Project_0' or '::Project_0::Image_0'.

---

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

• VinciObject.m