inspect

Overview
Syntax
Examples
Argument Types
AIS Component Systems

Overview

The inspect function returns status and statistical information concerning the AIS context, object repositories, Lambda objects, and other objects within AIS.

The inspect accepts many arguments as follows.

If (inspect) is passed, the amount of free memory will be returned.
If (inspect true) is passed, basic workspace statistics will be returned in a vector of strings.
If (inspect object) is passed, the Index for the specified object will be returned.
If (inspect integer) is passed, the object with the specified index will be returned.
If (inspect stack:) is passed, the TopOfStack Index will be returned.
If (inspect stack: n) is passed, the *n value will be returned.
If (inspect objectList:) is passed, a vector of all active objects will be returned in an object vector.
If (inspect symbolList: sort showCFunc showLocked) - are passed, a vector of all symbol objects will be returned in an object vector.
If (inspect lambdas:) is passed, a vector of all active Lambda objects will be returned in an object vector.
If (inspect ObjectRepository) is passed then the size of the ObjectRepository on disk is returned.
If (inspect ObjectRepository open:) is passed then true is returned if the ObjectRepository is open.
If (inspect ObjectRepository length:) key is passed then length of the item on disk is returned (or immediate: if the item is immediate).
If (inspect ObjectRepository check:) is passed then a systems check of the ObjectRepository is performed.
If (inspect ObjectRepository free:) is passed then the number of free bytes remaining in the database is returned.
If (inspect ObjectRepository directory:) is passed then a copy of the index directory for the database is returned.
If (inspect ObjectRepository index:) is passed then the index allocation statistics for the database are displayed.
If (inspect ObjectRepository pages:) is passed then the page statistics for the database are displayed.
If (inspect ObjectRepository show:) is passed then the full statistics for the database are displayed.
If (inspect ObjectRepository stats:) is passed then a Structure of ObjectRepository statistics for the database is returned.
If (inspect UsedBlockCount:) is passed then Smartbase engine FMemory_UsedBlockCount will be returned.
If (inspect UsedMemoryBytes:) is passed then Smartbase engine FMemory_UsedMemoryBytes will be returned.
If (inspect BlockedBlockCount:) is passed then Smartbase engine FMemory_BlockedBlockCount will be returned.
If (inspect BlockedBlockBytes:) is passed then Smartbase engine FMemory_BlockedBlockBytes will be returned.
If (inspect FreeBlockCount:) is passed then Smartbase engine FMemory_FreeBlockCount will be returned.
If (inspect FreeBlockBytes:) is passed then Smartbase engine FMemory_FreeBlockBytes will be returned.
If (inspect SystemCheckCount:) is passed then Smartbase engine FMemory_SystemCheckCount will be returned.
If (inspect JoinCount:) is passed then Smartbase engine FMemory_JoinCount will be returned.
If (inspect SplitCount:) is passed then Smartbase engine FMemory_SplitCount will be returned.
If (inspect CopyCount:) is passed then Smartbase engine FMemory_CopyCount will be returned.

Usage

Invoke the inspect function when statistical and status information concerning the specified AIS context is required.

Syntax

Expression:	(inspect) ;; Get the amount of free space in the Smartbase engine context heap

Arguments

Name

Type

Description

Returns:	The amount of free space in the Smartbase engine context heap

Expression:	(inspect true) ;; Get the basic workspace statistics in a vector of strings

Arguments	Name	Type	Description
Argument:	true	Boolean	Request basic workspace statistics

Returns:	Basic workspace statistics will be returned in a vector of strings

Expression:	(inspect anInteger) ;; Return the Object for the specified index

Arguments	Name	Type	Description
Argument:	anInteger	Object	The AIS object whose index is to be returned

Returns:	The Integer index of the specified object

Expression:	(inspect anObject) ;; Return the Index for the specified object

Arguments	Name	Type	Description
Argument:	anObject	Integer	The AIS index whose object is to be returned

Returns:	The Object of the specified Integer index

Expression:	(inpect stack:) ;; Return the top of the current stack index

Arguments	Name	Type	Description
Argument:	stack:	Symbol	The command to return the top of the stack index

Returns:	The Integer index for the top of the current stack

Expression:	(inspect stack: anIndex) ;; Return the value of the current stack at the specified index

Arguments	Name	Type	Description
Argument:	stack:	Symbol	The command to return the stack indexed value
Argument:	anIndex	Integer	The Integer stack index whose stack value is to be returned

Returns:	The word value of the current stack at the specified index

Expression:	(inspect objectList:) ;; Return a vector of all active objects

Arguments	Name	Type	Description
Argument:	objectList:	Symbol	The command to return a vector of all active objects

Returns:	The vector of all active objects

Expression:	(inspect symbolList: sort showCFunc showLocked) ;; Return a vector of all active Symbol objects

Arguments	Name	Type	Description
Argument:	symbolList:	Symbol	The command to return a vector of all active Symbol objects
Argument:	sort	Integer	The Integer code to sort the Vector (1 \| 0)
Argument:	showCFunc	Integer	The Integer code to include Symbols for builtin Functions (1 \| 0)
Argument:	showLocked	Integer	The Integer code to include locked Symbols (1 \| 0)

Returns:	The vector of all active Symbol objects

Expression:	(inspect lambdas:) ;; Return a vector of all active Lambda objects

Arguments	Name	Type	Description
Argument:	lambdas:	Symbol	The command to return a vector of all active Lambda objects

Returns:	The vector of all active Lambda objects

Expression:	(inspect anObjRepo) ;; Return the size of the ObjectRepository on disk

Arguments	Name	Type	Description
Argument:	anObjRepo	ObjectRepository	The ObjectRepository object whose size on disk is to be returned

Returns:	The size of the ObjectRepository on disk

Expression:	(inspect anObjRepo open:) ;; Return true if the ObjectRepository is open

Arguments	Name	Type	Description
Argument:	anObjRepo	ObjectRepository	The ObjectRepository object upon which to act
Argument:	open:	Symbol	The command to check whether or not the ObjectRepository is open

Returns:	True if the ObjectRepository is open

Examples

Here are a number of links to Lambda coding examples which contain this instruction in various use cases.

Argument Types

Here are the links to the data types of the function arguments.

Lambda	Boolean	Integer	Symbol
ObjectRepository	String

Here are also a number of links to functions having arguments with any of these data types.

++	+=	+	/=
/	*=	*	--
-=	-	abortTransaction	addMethod
addi	appendWriteln	append	apply
argCount	argFetch	attachLibrarian	avg
badd	balance	bcompareEQ	bcompareGE
bcompareGT	bcompareLE	bcompareLT	bcompareNE
bdiv	beginTransaction	binaryInsert	binaryNand
binaryNor	binaryNot	binaryNxor	binarySearch
bitwiseAnd	bitwiseNand	bitwiseNor	bitwiseNot
bitwiseNxor	bitwiseOr	bitwiseShiftLeft	bitwiseShiftRight
bitwiseXor	bmod	bmul	boolean
cadd	callcc	ccompareEQ	ccompareGE
ccompareGT	ccompareLE	ccompareLT	ccompareNE
cdiv	cdr	char	character
checkPointTransaction	class	clean	clear
closeLog	cmod	cmul	code
commitTransaction	compareEQ	compareGE	compareGT
compareLE	compareLT	compareNE	compare
comparison	compile	compress	cons
copy	count	csub	date
day	days360	debugBrowsableProcs	debugDetective
debugEval	debug	defchild	defclass
define(macro)	define	defmacro	defmethod
deforphan	defriend	defun	deleteRows
delete	detachLibrarian	dimension	disassemble
display	divi	downcase	encode
evalInSyncLocalContext	eval	exit	exportCsv
exportSbf	exportTab	fact	fdisplay
fileClose	fileCopy	fileDir	fileDisplay
fileEraseDir	fileErase	fileExists	fileMakeDir
fileOpen	fileReadAll	fileReadRecord	fileRead
fileResize	fileSeek	fileSizeOf	fileWriteAll
fileWrite	filewriteln	findBlock	find
floor	fraction	freeBlock	gc
gcd	getGlobalValue	getRecursionCount	getSymbolTable
globalBinding	hashString	hour	iadd
icompareEQ	icompareGE	icompareGT	icompareLE
icompareLT	icompareNE	idiv	imod
importCsv	importSbf	importTab	imul
insertRows	insert	inside	inspect
integer	isAtom	isBitVector	isBoolean
isBound	isByteVector	isCharAlphabetic	isCharAlphanumeric
isCharLowercase	isCharName	isCharNumeric	isCharUppercase
isCharWhitespace	isChar	isCharacter	isClass
isComplex	isDate	isDictionary	isDirectory
isEqual	isError	isEven	isExact
isFloatVector	isIdentical	isImmediate	isInexact
isInside	isIntegerVector	isInteger	isLambda
isMatrix	isMember	isMoney	isNegative
isNull	isNumberMatrix	isNumberVector	isNumber
isObjectVector	isObject	isOdd	isPair
isPcodeVector	isPositive	isString	isStructure
isSymbol	isText	isTransaction	isType
isVector	isZero	isub	julian
kurtosis	lambda	lcm	left
length	lisp	list	loadModule
loadRepository	loadWorkspace	lock	logConsole
macroReplace	makeLambda	makeQuotedList	makeQuotedSymbol
max	median	member	methodsOf
mid	min	minute	mod
modi	money	month	morph
muli	myself	ncompareEQ	ncompareGE
ncompareGT	ncompareLE	ncompareLT	ncompareNE
new	number	objectToMatrix	objectToNumMatrix
objectToNumVector	offset	onError	openLog
pair	parent	parse	pointer
preAllocateFixedMemoryBlocks	product	proplist	proprecord
putprop	qt	quit	random
randomize	range	rank	refAttributes
refLibrarian	refValues	ref	remProp
remove	rename	replace	rept
reset	resize	right	round
run	saveImmediate	saveModule	saveObject
saveRepository	saveWorkspace	second	send
setAttributes	setBlock	setCar	setCdr
setLastCdr	set	setf	setq
sizeof	skew	sort	sql
sqrt	srandom	stdev	stdevp
stringCiEQ	stringCiGE	stringCiGT	stringCiLE
stringCiLT	stringCiNE	stringFill	stringToBVector
stringToVector	string	subi	submit
substitute	substringCiEQ	substringCiGE	substringCiGT
substringCiLE	substringCiLT	substringCiNE	substringEQ
substringFill	substringGE	substringGT	substringLE
substringLT	substringNE	substring	sum
sumsqr	super	svmRegression	symbolToTypeCode
symbol	systemCheck	system	text
time	trim	type	uniqueInsert
unlock	upcase	var	varp
vectorBinaryInnerProduct	vectorBipolarInnerProduct	vectorCosineInnerProduct	vectorCubeInnerProduct
vectorDelete	vectorExpInnerProduct	vectorFill	vectorInnerProduct
vectorLogInnerProduct	vectorQuartInnerProduct	vectorQuintInnerProduct	vectorSigmoidInnerProduct
vectorSineInnerProduct	vectorSquareInnerProduct	vectorTanInnerProduct	vectorTanhInnerProduct
version	writelg	writeln	year

Analytic Information Server (AIS)

AIS Component Systems

Smartbase Engine

QT C++ Libraries

MySQL Relational Database

AIS Lisp Libraries

Rapid Analytic Demo IDE