pycram.orm.model

Classes

PyCRAMQuaternionMapping
PlanNodeMapping
DesignatorNodeMapping
ActionNodeMapping
MotionNodeMapping
ResolvedActionNodeMapping
TryInOrderMapping
ParallelNodeMapping
TryAllNodeMapping
CodeNodeMapping
MonitorNodeMapping
PlanEdge
PlanMapping
NumpyType	Type that casts field which are of numpy nd array type

Module Contents

class pycram.orm.model.PyCRAMQuaternionMapping

Bases: krrood.ormatic.dao.AlternativeMapping[pycram.datastructures.pose.Quaternion]

x: float = 0

y: float = 0

z: float = 0

w: float = 1

classmethod create_instance(obj: krrood.ormatic.dao.T)

create_from_dao() → krrood.ormatic.dao.T

class pycram.orm.model.PlanNodeMapping

Bases: krrood.ormatic.dao.AlternativeMapping[pycram.plan.PlanNode]

status: pycram.datastructures.enums.TaskStatus

start_time: typing_extensions.Optional[datetime.datetime] = None

end_time: typing_extensions.Optional[datetime.datetime] = None

reason: typing_extensions.Optional[pycram.failures.PlanFailure] = None

classmethod create_instance(obj: pycram.plan.PlanNode)

Convert a PlanNode to a PlanNodeDAO.

abstract create_from_dao() → krrood.ormatic.dao.T

class pycram.orm.model.DesignatorNodeMapping

Bases: PlanNodeMapping, krrood.ormatic.dao.AlternativeMapping[pycram.plan.DesignatorNode]

classmethod create_instance(obj: pycram.plan.DesignatorNode)

Convert a DesignatorNode to a DesignatorNodeDAO.

abstract create_from_dao() → krrood.ormatic.dao.T

class pycram.orm.model.ActionNodeMapping

Bases: DesignatorNodeMapping, krrood.ormatic.dao.AlternativeMapping[pycram.plan.ActionNode]

action: pycram.robot_plans.ActionDescription = None

classmethod create_instance(obj: pycram.plan.ActionNode)

Convert an ActionNode to an ActionNodeDAO.

abstract create_from_dao() → krrood.ormatic.dao.T

class pycram.orm.model.MotionNodeMapping

Bases: DesignatorNodeMapping, krrood.ormatic.dao.AlternativeMapping[pycram.plan.MotionNode]

abstract create_from_dao() → krrood.ormatic.dao.T

class pycram.orm.model.ResolvedActionNodeMapping

Bases: DesignatorNodeMapping, krrood.ormatic.dao.AlternativeMapping[pycram.plan.ResolvedActionNode]

abstract create_from_dao() → krrood.ormatic.dao.T

class pycram.orm.model.TryInOrderMapping

Bases: krrood.ormatic.dao.AlternativeMapping[pycram.language.TryInOrderNode]

classmethod create_instance(obj: pycram.language.TryInOrderNode)

Convert a TryInOrderNode to a TryInOrderNodeDAO.

abstract create_from_dao() → krrood.ormatic.dao.T

class pycram.orm.model.ParallelNodeMapping

Bases: krrood.ormatic.dao.AlternativeMapping[pycram.language.ParallelNode]

classmethod create_instance(obj: pycram.language.ParallelNode)

Convert a ParallelNode to a ParallelNodeDAO.

abstract create_from_dao() → krrood.ormatic.dao.T

class pycram.orm.model.TryAllNodeMapping

Bases: krrood.ormatic.dao.AlternativeMapping[pycram.language.TryAllNode]

classmethod create_instance(obj: pycram.language.TryAllNode)

Convert a TryAllNode to a TryAllNodeDAO.

abstract create_from_dao() → krrood.ormatic.dao.T

class pycram.orm.model.CodeNodeMapping

Bases: krrood.ormatic.dao.AlternativeMapping[pycram.language.CodeNode]

classmethod create_instance(obj: pycram.language.CodeNode)

Convert a CodeNode to a CodeNodeDAO.

abstract create_from_dao() → krrood.ormatic.dao.T

class pycram.orm.model.MonitorNodeMapping

Bases: krrood.ormatic.dao.AlternativeMapping[pycram.language.MonitorNode]

classmethod create_instance(obj: pycram.language.MonitorNode)

Convert a MonitorNode to a MonitorNodeDAO.

abstract create_from_dao() → krrood.ormatic.dao.T

class pycram.orm.model.PlanEdge

parent: pycram.plan.PlanNode

child: pycram.plan.PlanNode

class pycram.orm.model.PlanMapping

Bases: krrood.ormatic.dao.AlternativeMapping[pycram.plan.Plan]

nodes: List[pycram.plan.PlanNode]

edges: List[PlanEdge]

classmethod create_instance(obj: pycram.plan.Plan)

Convert a MonitorNode to a MonitorNodeDAO.

abstract create_from_dao() → krrood.ormatic.dao.T

class pycram.orm.model.NumpyType(*args: Any, **kwargs: Any)

Bases: sqlalchemy.TypeDecorator

Type that casts field which are of numpy nd array type

impl

process_bind_param(value: numpy.ndarray, dialect)

Receive a bound parameter value to be converted.

Custom subclasses of _types.TypeDecorator should override this method to provide custom behaviors for incoming data values. This method is called at statement execution time and is passed the literal Python data value which is to be associated with a bound parameter in the statement.

The operation could be anything desired to perform custom behavior, such as transforming or serializing data. This could also be used as a hook for validating logic.

Parameters:

• value – Data to operate upon, of any type expected by this method in the subclass. Can be None.

• dialect – the Dialect in use.

See also

types_typedecorator

_types.TypeDecorator.process_result_value()

process_result_value(value: impl, dialect) → typing_extensions.Optional[numpy.ndarray]

Receive a result-row column value to be converted.

Custom subclasses of _types.TypeDecorator should override this method to provide custom behaviors for data values being received in result rows coming from the database. This method is called at result fetching time and is passed the literal Python data value that’s extracted from a database result row.

The operation could be anything desired to perform custom behavior, such as transforming or deserializing data.

Parameters:

• value – Data to operate upon, of any type expected by this method in the subclass. Can be None.

• dialect – the Dialect in use.

See also

types_typedecorator

_types.TypeDecorator.process_bind_param()