motoman::trajectory_job::TrajectoryJob Class Reference

The job class encapsulates a trajectory as defined by a motoman job file (*.JBI). This class makes certain assumptions about the job file structure and is not meant to be a generic implementation of a job class (but could be extended if the need arises) More...

#include <trajectory_job.h>

List of all members.

Public Member Functions
char *	getName ()
	Returns job name.
bool	init (const char *name)
	Class initializer.
bool	toJobString (industrial::joint_traj::JointTraj &trajectory, char *str_buffer, size_t buffer_size)
	Generates a job string that can be written to a file.
	TrajectoryJob ()
	Constructor.
	~TrajectoryJob ()
	Destructor.
Private Attributes
char	line_buffer_ [LINE_BUFFER_SIZE_+1]
	Temporary line buffer used when generating a job file test string.
char	name_ [NAME_BUFFER_SIZE_+1]
	Name of the job file.

---

Detailed Description

The job class encapsulates a trajectory as defined by a motoman job file (*.JBI). This class makes certain assumptions about the job file structure and is not meant to be a generic implementation of a job class (but could be extended if the need arises)

THIS CLASS IS NOT THREAD-SAFE

Definition at line 76 of file trajectory_job.h.

---

Constructor & Destructor Documentation

motoman::trajectory_job::TrajectoryJob::TrajectoryJob

(

void

)

Constructor.

Definition at line 105 of file trajectory_job.cpp.

motoman::trajectory_job::TrajectoryJob::~TrajectoryJob

(

void

)

Destructor.

Definition at line 108 of file trajectory_job.cpp.

---

Member Function Documentation

char* motoman::trajectory_job::TrajectoryJob::getName

(

void

)

[inline]

Returns job name.

Returns:

job name (string is empty if it has not been initialized)

Definition at line 119 of file trajectory_job.h.

bool motoman::trajectory_job::TrajectoryJob::init

(

const char *

name

)

Class initializer.

Parameters:

job	name
joint	trajectory

Returns:

true on success, false otherwise (invalid name or trajectory)

Definition at line 112 of file trajectory_job.cpp.

bool motoman::trajectory_job::TrajectoryJob::toJobString	(	industrial::joint_traj::JointTraj &	trajectory,
		char *	str_buffer,
		size_t	buffer_size
	)

Generates a job string that can be written to a file.

Parameters:

str_buffer
buffer_size

Returns:

true on success, otherwise false

Definition at line 132 of file trajectory_job.cpp.

---

Member Data Documentation

char motoman::trajectory_job::TrajectoryJob::line_buffer_[LINE_BUFFER_SIZE_+1] [private]

Temporary line buffer used when generating a job file test string.

Definition at line 119 of file trajectory_job.h.

char motoman::trajectory_job::TrajectoryJob::name_[NAME_BUFFER_SIZE_+1] [private]

Name of the job file.

Definition at line 135 of file trajectory_job.h.

---

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

• trajectory_job.h
• trajectory_job.cpp