PlanesView Class Reference

Instances of this class represent a planes view in Vinci. More...

Inheritance diagram for PlanesView:

List of all members.

Public Member Functions
function	PlanesView (in connection, in target)
	Creates a new proxy object for an ortho display.
function	setSlotImage (in obj, in slotNumber, in image)
function	setSlotVisible (in obj, in slotNumber, in visible)
function	setDisplayObjects (in obj, in slot, in doBaseLayer)
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	createPlanesView (in connection, in image)
static function	getAllPlanesViews (in connection)
static function	getIdFromTarget (in connect, in target)
static function	getTargetNameQuery (in id)
static function	getTargetFromId (in connect, in id)
Public Attributes
Property	orthopart
	A string.
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

Instances of this class represent a planes view in Vinci.

---

Constructor & Destructor Documentation

function PlanesView	(	in	connection,
		in	target
	)

Creates a new proxy object for an ortho display.

Usage:

• obj = Vinci.PlanesView(connection, target)

Parameters:

connection	An object of type Vinci.Connect. This object is used to communicate with Vinci.
target	The target name of the planes view.

Return values:

obj	An object of type Vinci.PlanesView.

---

Member Function Documentation

static function createPlanesView	(	in	connection,
		in	image
	)		[static]

static function getAllPlanesViews

(

in

connection

)

[static]

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

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

static function getTargetNameQuery

(

in

id

)

[static, inherited]

function getTargetPartNumber	(	in	obj,
		in	partName
	)		[inherited]

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
	)		[inherited]

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
	)		[inherited]

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
	)		[inherited]

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
	)		[inherited]

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.

function setDisplayObjects	(	in	obj,
		in	slot,
		in	doBaseLayer
	)

function setSlotImage	(	in	obj,
		in	slotNumber,
		in	image
	)

function setSlotVisible	(	in	obj,
		in	slotNumber,
		in	visible
	)

---

Member Data Documentation

Property<ReadOnly> connection [inherited]

The Vinci.Connect object used to communicate with Vinci.

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

Property<ReadOnly> id [inherited]

Property orthopart

A string.

The view (transaxial, coronal and sagittal) displayed by the planes view in Vinci. Can be one of the values in Vinci.Constants.Orthoparts.

Property<ReadOnly> target [inherited]

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:

• PlanesView.m