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.
char *	getName ()
	Returns job name.
bool	init (const char *name, industrial::joint_traj::JointTraj joint_traj)
	Class initializer.
bool	init (const char *name, industrial::joint_traj::JointTraj joint_traj)
	Class initializer.
bool	toJobString (char *str_buffer, size_t buffer_size)
	Generates a job string that can be written to a file.
bool	toJobString (char *str_buffer, size_t buffer_size)
	Generates a job string that can be written to a file.
	TrajectoryJob ()
	Constructor.
	TrajectoryJob ()
	Constructor.
	~TrajectoryJob ()
	Destructor.
	~TrajectoryJob ()
	Destructor.
Private Member Functions
bool	appendLine (char *job_buffer, size_t job_buffer_size, char *line_buffer)
	Appends a line to the job buffer. The function checks that the job buffer is large enough before this is done.
bool	appendLine (char *job_buffer, size_t job_buffer_size, char *line_buffer)
	Appends a line to the job buffer. The function checks that the job buffer is large enough before this is done.
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.
industrial::joint_traj::JointTraj	trajectory_
	Joint trajectory.

---

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 include/trajectory_job.h.

---

Constructor & Destructor Documentation

motoman::trajectory_job::TrajectoryJob::TrajectoryJob

(

void

)

Constructor.

Definition at line 103 of file trajectory_job.cpp.

motoman::trajectory_job::TrajectoryJob::~TrajectoryJob

(

void

)

Destructor.

Definition at line 106 of file trajectory_job.cpp.

motoman::trajectory_job::TrajectoryJob::TrajectoryJob

(

)

Constructor.

motoman::trajectory_job::TrajectoryJob::~TrajectoryJob

(

)

Destructor.

---

Member Function Documentation

bool motoman::trajectory_job::TrajectoryJob::appendLine	(	char *	job_buffer,
		size_t	job_buffer_size,
		char *	line_buffer
	)			[private]

Appends a line to the job buffer. The function checks that the job buffer is large enough before this is done.

Parameters:

	job	buffer
	job	buffer size
	line	buffer

Returns:

true on success, false if te job buffer is not big enough

bool motoman::trajectory_job::TrajectoryJob::appendLine	(	char *	job_buffer,
		size_t	job_buffer_size,
		char *	line_buffer
	)			[private]

Appends a line to the job buffer. The function checks that the job buffer is large enough before this is done.

Parameters:

	job	buffer
	job	buffer size
	line	buffer

Returns:

true on success, false if te job buffer is not big enough

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 motoplus/motoros_lib/output/trajectory_job.h.

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 include/trajectory_job.h.

bool motoman::trajectory_job::TrajectoryJob::init	(	const char *	name,
		industrial::joint_traj::JointTraj	joint_traj
	)

Class initializer.

Parameters:

	job	name
	joint	trajectory

Returns:

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

bool motoman::trajectory_job::TrajectoryJob::init	(	const char *	name,
		industrial::joint_traj::JointTraj	joint_traj
	)

Class initializer.

Parameters:

	job	name
	joint	trajectory

Returns:

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

Definition at line 110 of file trajectory_job.cpp.

bool motoman::trajectory_job::TrajectoryJob::toJobString	(	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

bool motoman::trajectory_job::TrajectoryJob::toJobString	(	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 129 of file trajectory_job.cpp.

---

Member Data Documentation

char motoman::trajectory_job::TrajectoryJob::line_buffer_ [private]

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

Definition at line 119 of file include/trajectory_job.h.

char motoman::trajectory_job::TrajectoryJob::name_ [private]

Name of the job file.

Definition at line 135 of file include/trajectory_job.h.

industrial::joint_traj::JointTraj motoman::trajectory_job::TrajectoryJob::trajectory_ [private]

Joint trajectory.

Definition at line 142 of file include/trajectory_job.h.

---

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

• include/trajectory_job.h
• motoplus/motoros_lib/output/trajectory_job.h
• trajectory_job.cpp