Vector

java.lang.Object
- com.madara.MadaraJNI
- - com.madara.containers.BaseContainer
  - - com.madara.containers.Vector

```
public class Vector
extends BaseContainer
```
A facade for a dynamically typed vector within a knowledge base.

Constructor Summary

Constructors
Constructor and Description

Vector()
Default constructor

Vector(Vector input)
Copy constructor

Constructors
Constructor and Description
`Vector()` Default constructor
`Vector(Vector input)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`finalize()` Cleans up underlying C resources
`void`	`free()` Deletes the C instantiation.
`static Vector`	`fromPointer(long cptr)` Creates a java object instance from a C/C++ pointer
`static Vector`	`fromPointer(long cptr, boolean shouldManage)` Creates a java object instance from a C/C++ pointer
`KnowledgeRecord`	`get(int index)` Gets the value
`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(double value)` Pushes a value to the end of the vector
`void`	`pushback(double[] value)` Pushes a value to the end of the vector
`void`	`pushback(KnowledgeRecord value)` Pushes a value to the end of the vector
`void`	`pushback(long value)` Pushes a value to the end of the vector
`void`	`pushback(long[] value)` Pushes a value to the end of the vector
`void`	`pushback(java.lang.String value)` Pushes a value to the end of the vector
`void`	`resize(long length)` Resizes the vector.
`void`	`set(int index, double value)` Sets the value
`void`	`set(int index, KnowledgeRecord value)` Sets the value
`void`	`set(int index, long value)` Sets the value
`void`	`set(int index, java.lang.String value)` Sets the value
`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(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
  - Vector
```
public Vector()
```
    Default constructor
  - Vector
```
public Vector(Vector input)
```
    Copy constructor
    
    Parameters:
    
    input - instance to copy
- Method Detail
  - fromPointer
```
public static Vector 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 Vector 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 KnowledgeRecord get(int index)
```
    Gets the value
    
    Parameters:
    
    index - index for the new value
    
    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,
                java.lang.String value)
```
    Sets the value
    
    Parameters:
    
    index - index for the new value
    
    value - new value
  - set
```
public void set(int index,
                double value)
```
    Sets the value
    
    Parameters:
    
    index - index for the new value
    
    value - new value
  - set
```
public void set(int index,
                long value)
```
    Sets the value
    
    Parameters:
    
    index - index for the new value
    
    value - new value
  - set
```
public void set(int index,
                KnowledgeRecord value)
```
    Sets the value
    
    Parameters:
    
    index - index for the new value
    
    value - new value
  - pushback
```
public void pushback(KnowledgeRecord value)
```
    Pushes a value to the end of the vector
    
    Parameters:
    
    value - new value to add to vector
  - pushback
```
public void pushback(java.lang.String value)
```
    Pushes a value to the end of the vector
    
    Parameters:
    
    value - new value to add to vector
  - pushback
```
public void pushback(long value)
```
    Pushes a value to the end of the vector
    
    Parameters:
    
    value - new value to add to vector
  - pushback
```
public void pushback(long[] value)
```
    Pushes a value to the end of the vector
    
    Parameters:
    
    value - new value to add to vector
  - pushback
```
public void pushback(double value)
```
    Pushes a value to the end of the vector
    
    Parameters:
    
    value - new value to add to vector
  - pushback
```
public void pushback(double[] 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
  - 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

Class Vector

Constructor Summary

Method Summary

Methods inherited from class com.madara.containers.BaseContainer

Methods inherited from class com.madara.MadaraJNI

Methods inherited from class java.lang.Object

Constructor Detail

Vector

Vector

Method Detail

fromPointer

fromPointer

get

getName

resize

set

set

set

set

pushback

pushback

pushback

pushback

pushback

pushback

modify

isTrue

isFalse

modify

setName

setName

setSettings

size

toRecord

toArray

free

finalize