com.madara.containers

Class Counter

java.lang.Object

com.madara.MadaraJNI

com.madara.containers.BaseContainer

com.madara.containers.Counter

public class Counter
extends BaseContainer

A facade for distributed adder within a knowledge base

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	dec() Decrements the container
void	dec(long value) Decrements by a value
protected void	finalize() Cleans up underlying C resources
void	free() Deletes the C instantiation.
static Counter	fromPointer(long cptr) Creates a java object instance from a C/C++ pointer
static Counter	fromPointer(long cptr, boolean shouldManage) Creates a java object instance from a C/C++ pointer
long	get() Gets the value
java.lang.String	getName() Gets the name of the variable
void	inc() Increments the container
void	inc(long value) Increments by a value
boolean	isFalse() Returns true if the container evaluates to false
boolean	isTrue() Returns true if the container evaluates to true
void	modify() Mark the value as modified.
void	resize(int id, int counters) Resizes the counter, usually when number of counters change
void	set(long 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
double	toDouble() Converts the value to a double
long	toLong() Converts the value to a long
java.lang.String	toString() Converts the value to a string

Methods inherited from class com.madara.containers.BaseContainer

modifyIfFalse, modifyIfTrue

Methods inherited from class com.madara.MadaraJNI

getCPtr, setCPtr

Methods inherited from class java.lang.Object

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

Constructor Detail

Counter

public Counter()

Default constructor

Counter

public Counter(Counter input)

Copy constructor

Parameters:

input - instance to copy

Method Detail

fromPointer

public static Counter 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 Counter 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()

Gets the value

Returns:

current value

getName

public java.lang.String getName()

Gets the name of the variable

Returns:

name of the variable within the context

inc

public void inc()

Increments the container

inc

public void inc(long value)

Increments by a value

Parameters:

value - value to increment by

dec

public void dec()

Decrements the container

dec

public void dec(long value)

Decrements by a value

Parameters:

value - value to increment by

set

public void set(long value)

Sets the value

Parameters:

value - new value

modify

public void modify()

Mark the value as modified. The Counter retains the same value but will resend its value as if it 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

resize

public void resize(int id,
                   int counters)

Resizes the counter, usually when number of counters change

Parameters:

id - the id of this counter in the counter ring

counters - the number of counters in counter ring

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

toDouble

public double toDouble()

Converts the value to a double

Returns:

current double value

toLong

public long toLong()

Converts the value to a long

Returns:

current long value

toString

public java.lang.String toString()

Converts the value to a string

Overrides:

toString in class MadaraJNI

Returns:

current string value

See Also:

()

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