burlap.domain.singleagent.cartpole.states

Class CartPoleState

java.lang.Object

burlap.domain.singleagent.cartpole.states.InvertedPendulumState

burlap.domain.singleagent.cartpole.states.CartPoleState

All Implemented Interfaces:

MutableState, State

Direct Known Subclasses:

CartPoleFullState

public class CartPoleState
extends InvertedPendulumState

Author:

James MacGlashan.

Field Summary

Fields

Modifier and Type	Field and Description
double	v
double	x

Fields inherited from class burlap.domain.singleagent.cartpole.states.InvertedPendulumState

angle, angleV

Constructor Summary

Constructors

Constructor and Description
CartPoleState()
CartPoleState(double x, double v, double angle, double angleV)

Method Summary

Modifier and Type	Method and Description
State	copy() Returns a copy of this state suitable for creating state transitions.
java.lang.Object	get(java.lang.Object variableKey) Returns the value for the given variable key.
MutableState	set(java.lang.Object variableKey, java.lang.Object value) Sets the value for the given variable key.
java.lang.String	toString()
java.util.List<java.lang.Object>	variableKeys() Returns the list of state variable keys.

Methods inherited from class java.lang.Object

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

Field Detail

x

public double x

v

public double v

Constructor Detail

CartPoleState

public CartPoleState()

CartPoleState

public CartPoleState(double x,
                     double v,
                     double angle,
                     double angleV)

Method Detail

set

public MutableState set(java.lang.Object variableKey,
                        java.lang.Object value)

Description copied from interface: MutableState

Sets the value for the given variable key.

Specified by:

set in interface MutableState

Overrides:

set in class InvertedPendulumState

Parameters:

variableKey - the key identifier for the variable value to change

value - the variable value to which the variable should be set.

Returns:

this object to support method chaining

variableKeys

public java.util.List<java.lang.Object> variableKeys()

Description copied from interface: State

Returns the list of state variable keys.

Specified by:

variableKeys in interface State

Overrides:

variableKeys in class InvertedPendulumState

Returns:

the list of state variable keys.

get

public java.lang.Object get(java.lang.Object variableKey)

Description copied from interface: State

Returns the value for the given variable key. Changes to the returned value are not guaranteed to modify the state.

Specified by:

get in interface State

Overrides:

get in class InvertedPendulumState

Parameters:

variableKey - the variable key

Returns:

the value for the given variable key

copy

public State copy()

Description copied from interface: State

Returns a copy of this state suitable for creating state transitions. This copy may be a shallow copy or deep copy and is domain specific. The State implementation may indicate its copy level with the DeepCopyState or ShallowCopyState annotations. If it is a shallow copy, you should not *directly* modify any fields of a copied state without copying the fields first, or it could contaminate the state from which the copy was made. Alternatively, use the MutableState.set(Object, Object) method to modify ShallowCopyState copied states, which for ShallowCopyState instances should perform a safe copy-on-write operation.

Specified by:

copy in interface State

Overrides:

copy in class InvertedPendulumState

Returns:

a copy of this state.

toString

public java.lang.String toString()

Overrides:

toString in class InvertedPendulumState