com.madara.containers

Class IntegerVector

java.lang.Object

com.madara.MadaraJNI

com.madara.containers.BaseContainer

com.madara.containers.IntegerVector

public class IntegerVector
extends BaseContainer

A facade for a vector of integers within a knowledge base. Changing elements of a IntegerVector only sends updates on that subset of changed values, rather than the entire vector. If you are wanting all elements of a vector to be sent atomically, you are probably wanting to use NativeIntegerVector, which operates on a single knowledge record location within the knowledge base.

Constructor Summary

Constructors

Constructor and Description
IntegerVector() Default constructor
IntegerVector(IntegerVector input) Copy constructor

Method Summary

Modifier and Type	Method and Description
protected void	finalize() Cleans up underlying C resources
void	free() Deletes the C instantiation.
static IntegerVector	fromPointer(long cptr) Creates a java object instance from a C/C++ pointer
static IntegerVector	fromPointer(long cptr, boolean shouldManage) Creates a java object instance from a C/C++ pointer
long	get(int index) Gets the value at a specified index
java.lang.String	getName() Gets the name of the variable
boolean	isFalse() Returns true if the container evaluates to false
boolean	isTrue() Returns true if the container evaluates to true
void	modify() Mark the vector as modified.
void	modify(int index) Mark an element as modified.
void	pushback(long value) Pushes a value to the end of the vector
void	resize(long length) Resizes the vector.
void	set(int index, long value) Sets the value at an index
void	setName(KnowledgeBase kb, java.lang.String name) Sets the name and knowledge base being referred to
void	setName(Variables vars, java.lang.String name) Sets the name and knowledge base being referred to
void	setSettings(UpdateSettings settings) Sets the settings for updating variables in the Knowledge Base
long	size() Returns the size of the vector
KnowledgeRecord[]	toArray() Returns a value at the specified index
KnowledgeRecord	toRecord() Returns all of the values as a knowledge record
KnowledgeRecord	toRecord(int index) Returns a value at the specified index

Methods inherited from class com.madara.containers.BaseContainer

modifyIfFalse, modifyIfTrue

Methods inherited from class com.madara.MadaraJNI

getCPtr, setCPtr, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IntegerVector

public IntegerVector()

Default constructor

IntegerVector

public IntegerVector(IntegerVector input)

Copy constructor

Parameters:

input - instance to copy

Method Detail

fromPointer

public static IntegerVector fromPointer(long cptr)

Creates a java object instance from a C/C++ pointer

Parameters:

cptr - C pointer to the object

Returns:

a new java instance of the underlying pointer

fromPointer

public static IntegerVector fromPointer(long cptr,
                                        boolean shouldManage)

Creates a java object instance from a C/C++ pointer

Parameters:

cptr - C pointer to the object

shouldManage - if true, manage the pointer

Returns:

a new java instance of the underlying pointer

get

public long get(int index)

Gets the value at a specified index

Parameters:

index - location of the element to retrieve

Returns:

current value

getName

public java.lang.String getName()

Gets the name of the variable

Returns:

name of the variable within the context

resize

public void resize(long length)

Resizes the vector. A negative number (e.g. -1) can be provided to automatically resize the vector to whatever size is indicated in the knowledge base.

Parameters:

length - new number of elements of the vector

set

public void set(int index,
                long value)

Sets the value at an index

Parameters:

index - index to set a value at

value - new value

pushback

public void pushback(long value)

Pushes a value to the end of the vector

Parameters:

value - new value to add to vector

modify

public void modify()

Mark the vector as modified. The vector retains the same values but will resend all values as if they had been modified.

isTrue

public boolean isTrue()

Returns true if the container evaluates to true

Returns:

true if container has all true values

isFalse

public boolean isFalse()

Returns true if the container evaluates to false

Returns:

true if container has any false values or is uninitialized

modify

public void modify(int index)

Mark an element as modified. The element retains the same value but will resend the value as if it had been modified.

Parameters:

index - the element index

setName

public void setName(KnowledgeBase kb,
                    java.lang.String name)

Sets the name and knowledge base being referred to

Parameters:

kb - the knowledge base that contains the name

name - the variable name

setName

public void setName(Variables vars,
                    java.lang.String name)

Sets the name and knowledge base being referred to

Parameters:

vars - the variables facade that contains the name

name - the variable name

setSettings

public void setSettings(UpdateSettings settings)

Sets the settings for updating variables in the Knowledge Base

Parameters:

settings - the settings to use for updating the Knowledge Base

size

public long size()

Returns the size of the vector

Returns:

the number of elements in the vector

toRecord

public KnowledgeRecord toRecord(int index)

Returns a value at the specified index

Parameters:

index - the index

Returns:

the value at the index as a knowledge record

toArray

public KnowledgeRecord[] toArray()

Returns a value at the specified index

Returns:

the vector as an array of records

toRecord

public KnowledgeRecord toRecord()

Returns all of the values as a knowledge record

Returns:

knowledge record that contains all indices

free

public void free()

Deletes the C instantiation. To prevent memory leaks, this must be called before an instance gets garbage collected

finalize

protected void finalize()
                 throws java.lang.Throwable

Cleans up underlying C resources

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - necessary for override but unused