SMORES Robot Platform Simulation
Modlab at Penn, ASL at Cornell
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends
gazebo::CommandPro Class Reference

A data structure that stores normal command message. More...

#include <CommandManagement.hh>

Public Member Functions

 CommandPro ()
 Constructor.
 
 CommandPro (CommandPtr command)
 Constructor. More...
 
 CommandPro (CommandPtr command, unsigned int timer)
 Constructor. More...
 
 ~CommandPro ()
 Destructor.
 
void SetTimer (unsigned int timer)
 Set a timer for the current command. More...
 
void SetCondition (string condition)
 Set condition string of the current command. More...
 
void SetDependency (string dependency)
 Set dependency string of the current command. More...
 
void SetSpecialCommand (SpecialCommand specialcommand)
 Make current command a special command. More...
 

Public Attributes

CommandPtr ActualCommandMessage
 A pointer of the CommandMessage object.
 
bool TimeBased
 Flag indicates whether the current command is a time based command.
 
unsigned int TimeInterval
 Timer of the current command, unit: msec.
 
bool ConditionCommand
 Flag indicates whether this command has a condition.
 
string ConditionID
 The condition string.
 
bool ConditionOnOtherCommand
 Flag indicates whether this command has a dependency.
 
string Dependency
 The dependency string.
 
bool SpecialCommandFlag
 Flag indicates whether this command is a special command.
 
SpecialCommand Command
 Special command object.
 

Detailed Description

A data structure that stores normal command message.

Constructor & Destructor Documentation

gazebo::CommandPro::CommandPro ( CommandPtr  command)

Constructor.

Parameters
commandA smart pointer of the CommandMessage object
gazebo::CommandPro::CommandPro ( CommandPtr  command,
unsigned int  timer 
)

Constructor.

Parameters
commandA smart pointer of the CommandMessage object
timerTimer of the time-based command, unit: msec

Member Function Documentation

void gazebo::CommandPro::SetCondition ( string  condition)

Set condition string of the current command.

Parameters
conditionCondition string
void gazebo::CommandPro::SetDependency ( string  dependency)

Set dependency string of the current command.

Parameters
dependencyDependency string
void gazebo::CommandPro::SetSpecialCommand ( SpecialCommand  specialcommand)

Make current command a special command.

Parameters
specialcommandA specialcommand object
void gazebo::CommandPro::SetTimer ( unsigned int  timer)

Set a timer for the current command.

Parameters
timerA timer, unit: msec

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