SNetworkContext Class Reference

This class provide interface to send and receive objects through network interface when using TcpScript module. More...

Public Member Functions
Array	RetrieveInputArray (string key)
	Retrieve a array from the network context.
SCircle	RetrieveInputCircle (string key)
	Retrieve a circle from the network context.
SCloud	RetrieveInputCloud (string key)
	Retrieve a cloud from the network context.
SCylinder	RetrieveInputCylinder (string key)
	Retrieve a cylinder from the network context.
number	RetrieveInputDouble (string key)
	Retrieve a double from the network context.
number	RetrieveInputInteger (string key)
	Retrieve a integer from the network context.
Object	RetrieveInputMap (string key)
	Retrieve a map from the network context.
SMatrix	RetrieveInputMatrix (string key)
	Retrieve a matrix from the network context.
SMultiline	RetrieveInputMultiline (string key)
	Retrieve a multiline from the network context.
SPoint	RetrieveInputPoint (string key)
	Retrieve a point from the network context.
SPoly	RetrieveInputPoly (string key)
	Retrieve a poly from the network context.
SVector	RetrieveInputVector (string key)
	Retrieve a vector from the network context.
	Return (number retVal)
	Set the return value of the current execution.
	SendOutputArray (string key, Array array)
	Send a array through the network context.
	SendOutputCircle (string key, SCircle circle)
	Send a circle through the network context.
	SendOutputCloud (string key, SCloud cloud)
	Send a cloud through the network context.
	SendOutputCylinder (string key, SCylinder cylinder)
	Send a cylinder through the network context.
	SendOutputDouble (string key, number double)
	Send a double through the network context.
	SendOutputInteger (string key, number integer)
	Send a integer through the network context.
	SendOutputMap (string key, Object map)
	Send a map through the network context.
	SendOutputMatrix (string key, SMatrix matrix)
	Send a matrix through the network context.
	SendOutputMultiline (string key, SMultiline multiline)
	Send a multiline through the network context.
	SendOutputPoint (string key, SPoint point)
	Send a point through the network context.
	SendOutputPoly (string key, SPoly poly)
	Send a poly through the network context.
	SendOutputVector (string key, SVector vector)
	Send a vector through the network context.

Static Public Member Functions
static SNetworkContext	GetContext ()
	Get the network context related to the current execution.

Detailed Description

This class provide interface to send and receive objects through network interface when using TcpScript module.

Member Function Documentation

GetContext()

static SNetworkContext SNetworkContext::GetContext ( )

static

Get the network context related to the current execution.

Returns

(SNetworkContext) The network context

RetrieveInputArray()

Array SNetworkContext::RetrieveInputArray

(

string

key

)

Retrieve a array from the network context.

Parameters

key	(string) The string key referencing the array

Returns

(Array) The array requested.

RetrieveInputCircle()

SCircle SNetworkContext::RetrieveInputCircle

(

string

key

)

Retrieve a circle from the network context.

Parameters

key	(string) The string key referencing the circle

Returns

(SCircle) The circle requested.

RetrieveInputCloud()

SCloud SNetworkContext::RetrieveInputCloud

(

string

key

)

Retrieve a cloud from the network context.

Parameters

key	(string) The string key referencing the cloud

Returns

(SCloud) The cloud requested.

RetrieveInputCylinder()

SCylinder SNetworkContext::RetrieveInputCylinder

(

string

key

)

Retrieve a cylinder from the network context.

Parameters

key	(string) The string key referencing the cylinder

Returns

(SCylinder) The cylinder requested.

RetrieveInputDouble()

number SNetworkContext::RetrieveInputDouble

(

string

key

)

Retrieve a double from the network context.

Parameters

key	(string) The string key referencing the double

Returns

(number) The double requested.

RetrieveInputInteger()

number SNetworkContext::RetrieveInputInteger

(

string

key

)

Retrieve a integer from the network context.

Parameters

key	(string) The string key referencing the integer

Returns

(number) The integer requested.

RetrieveInputMap()

Object SNetworkContext::RetrieveInputMap

(

string

key

)

Retrieve a map from the network context.

Parameters

key	(string) The string key referencing the map

Returns

(Object) The map requested.

RetrieveInputMatrix()

SMatrix SNetworkContext::RetrieveInputMatrix

(

string

key

)

Retrieve a matrix from the network context.

Parameters

key	(string) The string key referencing the matrix

Returns

(SMatrix) The matrix requested.

RetrieveInputMultiline()

SMultiline SNetworkContext::RetrieveInputMultiline

(

string

key

)

Retrieve a multiline from the network context.

Parameters

key	(string) The string key referencing the multiline

Returns

(SMultiline) The multiline requested.

RetrieveInputPoint()

SPoint SNetworkContext::RetrieveInputPoint

(

string

key

)

Retrieve a point from the network context.

Parameters

key	(string) The string key referencing the point

Returns

(SPoint) The point requested.

RetrieveInputPoly()

SPoly SNetworkContext::RetrieveInputPoly

(

string

key

)

Retrieve a poly from the network context.

Parameters

key	(string) The string key referencing the poly

Returns

(SPoly) The poly requested.

RetrieveInputVector()

SVector SNetworkContext::RetrieveInputVector

(

string

key

)

Retrieve a vector from the network context.

Parameters

key	(string) The string key referencing the vector

Returns

(SVector) The vector requested.

Return()

SNetworkContext::Return

(

number

retVal

)

Set the return value of the current execution.

Parameters

retVal

(number) The return value to send

SendOutputArray()

SNetworkContext::SendOutputArray	(	string	key,
		Array	array )

Send a array through the network context.

Parameters

key	(string) The string key referencing the array
array	(Array) The array to send

SendOutputCircle()

SNetworkContext::SendOutputCircle	(	string	key,
		SCircle	circle )

Send a circle through the network context.

Parameters

key	(string) The string key referencing the circle
circle	(SCircle) The circle to send

SendOutputCloud()

SNetworkContext::SendOutputCloud	(	string	key,
		SCloud	cloud )

Send a cloud through the network context.

Parameters

key	(string) The string key referencing the cloud
cloud	(SCloud) The cloud to send

SendOutputCylinder()

SNetworkContext::SendOutputCylinder	(	string	key,
		SCylinder	cylinder )

Send a cylinder through the network context.

Parameters

key	(string) The string key referencing the cylinder
cylinder	(SCylinder) The cylinder to send

SendOutputDouble()

SNetworkContext::SendOutputDouble	(	string	key,
		number double	)

Send a double through the network context.

Parameters

key	(string) The string key referencing the double
double	(number) The double to send

SendOutputInteger()

SNetworkContext::SendOutputInteger	(	string	key,
		number	integer )

Send a integer through the network context.

Parameters

key	(string) The string key referencing the integer
integer	(number) The integer to send

SendOutputMap()

SNetworkContext::SendOutputMap	(	string	key,
		Object	map )

Send a map through the network context.

Parameters

key	(string) The string key referencing the map
map	(Object) The map to send

SendOutputMatrix()

SNetworkContext::SendOutputMatrix	(	string	key,
		SMatrix	matrix )

Send a matrix through the network context.

Parameters

key	(string) The string key referencing the matrix
matrix	(SMatrix) The matrix to send

SendOutputMultiline()

SNetworkContext::SendOutputMultiline	(	string	key,
		SMultiline	multiline )

Send a multiline through the network context.

Parameters

key	(string) The string key referencing the multiline
multiline	(SMultiline) The multiline to send

SendOutputPoint()

SNetworkContext::SendOutputPoint	(	string	key,
		SPoint	point )

Send a point through the network context.

Parameters

key	(string) The string key referencing the point
point	(SPoint) The point to send

SendOutputPoly()

SNetworkContext::SendOutputPoly	(	string	key,
		SPoly	poly )

Send a poly through the network context.

Parameters

key	(string) The string key referencing the poly
poly	(SPoly) The poly to send

SendOutputVector()

SNetworkContext::SendOutputVector	(	string	key,
		SVector	vector )

Send a vector through the network context.

Parameters

key	(string) The string key referencing the vector
vector	(SVector) The vector to send