clearpath.horizon.payloads.SafetyStatus Class Reference

Horizon Message Payload - Safety System. More...

Inheritance diagram for clearpath.horizon.payloads.SafetyStatus:

List of all members.

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Safety System.
def	get_flags
	Get Flags.
def	has_emergency_stop
	Has Emergency Stop Set?
def	print_format
	Human Readable Payload String.
Static Public Attributes
int	EMERGENCY_STOP = 0x0001
	Emergency Stop flag mask.
Properties
	flags = property(fget=get_flags, doc="Platform Safety System Flags")
	Platform Safety System Flags.
Private Attributes
	_flags
	Platform Safety System Flags.

---

Detailed Description

Horizon Message Payload - Safety System.

Represents the payload of the command and data messages 'safety system'

Warning:

Data should not be modified once created

Since:

0.4

Horizon Message Payload - Safety System

Definition at line 1159 of file payloads.py.

---

Constructor & Destructor Documentation

def clearpath.horizon.payloads.SafetyStatus.__init__	(		self,
			flags = 0x0000,
			raw = None,
			timestamp = 0
	)

Create A Horizon Message Payload - Safety System.

Constructor for the Horizon Message Payload - Safety System Class.
The constructor can be called two different ways:

• SafetySystem(flags, raw=None, version, timestamp)
  Create a command message payload to send.
  
• SafetySystem(raw, version, timestamp)
  Parse raw data (most likely received) into payload variables.
  

Parameters:

flags	Platform Safety System Flags
raw	Raw Payload data byte list to parse
timestamp	Payload Send / Create Time (milliseconds)
version	Horizon Protocol Version, (-1,*) represents the newest version, (0,0) auto-detect the version (if supported)

Exceptions:

LookupError	If auto-detect version fails
ValueError	If values are out of range or if raw is invalid

Create A Horizon Message Payload - Platform Name

Definition at line 1186 of file payloads.py.

---

Member Function Documentation

def clearpath.horizon.payloads.SafetyStatus.get_flags

(

self

)

Get Flags.

Returns:

the platform safety system flags

Get Flags

Definition at line 1247 of file payloads.py.

def clearpath.horizon.payloads.SafetyStatus.has_emergency_stop

(

self

)

Has Emergency Stop Set?

Returns:

is the emergency stop platform safety system flag set

Has Emergency Stop Set?

Definition at line 1236 of file payloads.py.

def clearpath.horizon.payloads.SafetyStatus.print_format

(

self

)

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 1225 of file payloads.py.

---

Member Data Documentation

clearpath::horizon::payloads.SafetyStatus::_flags [private]

Platform Safety System Flags.

Definition at line 1187 of file payloads.py.

int clearpath::horizon::payloads.SafetyStatus::EMERGENCY_STOP = 0x0001 [static]

Emergency Stop flag mask.

Definition at line 1164 of file payloads.py.

---

Property Documentation

clearpath::horizon::payloads.SafetyStatus::flags = property(fget=get_flags, doc="Platform Safety System Flags") [static]

Platform Safety System Flags.

Definition at line 1255 of file payloads.py.

---

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

• payloads.py