rl.env.state.Jig Class Reference

Individual jig instance with type and status. More...

Public Member Functions
	__init__ (self, JigType jig_type, bool empty)
	Initialize a jig instance.
	__str__ (self)
	copy (self)
	Create a deep copy of this jig.

Public Attributes
	jig_type = jig_type
	empty = empty

Detailed Description

Individual jig instance with type and status.

A jig can be empty or loaded, which affects its size and determines valid operations that can be performed on it.

Constructor & Destructor Documentation

__init__()

rl.env.state.Jig.__init__	(		self,
		JigType	jig_type,
		bool	empty )

Initialize a jig instance.

Parameters

jig_type	Type of this jig (determines size properties)
empty	Whether the jig is currently empty or loaded

    def __init__(self, jig_type: JigType, empty: bool):
        """!
        @brief Initialize a jig instance
        @param jig_type Type of this jig (determines size properties)
        @param empty Whether the jig is currently empty or loaded
        """
        self.jig_type = jig_type
        self.empty = empty
 

Member Function Documentation

__str__()

rl.env.state.Jig.__str__

(

self

)

    def __str__(self):
        return str(self.jig_type) + " | " + str(self.empty)
    

copy()

rl.env.state.Jig.copy

(

self

)

Create a deep copy of this jig.

Returns

New Jig instance with same properties

    def copy(self):
        """!
        @brief Create a deep copy of this jig
        @return New Jig instance with same properties
        """
        return Jig(self.jig_type, self.empty)
 
 

Member Data Documentation

empty

rl.env.state.Jig.empty = empty

jig_type

rl.env.state.Jig.jig_type = jig_type

---

The documentation for this class was generated from the following file:

• rl/env/state.py