OpenJAUS SAE SDK  6.0.0
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord Class Reference

#include <PrismaticJoint1AngleRecord.h>

Inherits openjaus::model::fields::Record.

Public Member Functions

 PrismaticJoint1AngleRecord ()
 
 PrismaticJoint1AngleRecord (const PrismaticJoint1AngleRecord &source)
 
 ~PrismaticJoint1AngleRecord ()
 
void copy (PrismaticJoint1AngleRecord &source)
 
virtual uint64 to (system::BufferWriter &dst) const
 Serializes the contents of this object into the Buffer connected to the provided BufferWriter. More...
 
virtual uint64 from (system::BufferReader &src)
 Deserializes the contents the Buffer connected to the provided BufferReader into this object. More...
 
virtual uint64 length (void) const
 Gets the serialized length of this object. More...
 
std::string toXml (unsigned char ojIndentLevel=0) const
 
void setPresenceVector (uint8_t value)
 
uint8_t getPresenceVector (void) const
 
bool isPrismaticJoint1MaxSpeedEnabled (void) const
 
void enablePrismaticJoint1MaxSpeed (void)
 
void disablePrismaticJoint1MaxSpeed (void)
 
bool isPrismaticJoint1MaxForceEnabled (void) const
 
void enablePrismaticJoint1MaxForce (void)
 
void disablePrismaticJoint1MaxForce (void)
 
double getPrismaticJoint1Angle_rad (void)
 
bool setPrismaticJoint1Angle_rad (double value)
 
double getPrismaticJoint1MinValue_m (void)
 
bool setPrismaticJoint1MinValue_m (double value)
 
double getPrismaticJoint1MaxValue_m (void)
 
bool setPrismaticJoint1MaxValue_m (double value)
 
double getPrismaticJoint1MaxSpeed_mps (void)
 
bool setPrismaticJoint1MaxSpeed_mps (double value)
 
double getPrismaticJoint1MaxForce_N (void)
 
bool setPrismaticJoint1MaxForce_N (double value)
 
- Public Member Functions inherited from openjaus::model::fields::Record
 Record ()
 
virtual ~Record ()
 
const std::vector< Field *> & getFields () const
 Accessor to get the value of fields. More...
 
bool setFields (const Field &fields)
 Accessor to set value of fields. More...
 
virtual std::string toString () const
 
- Public Member Functions inherited from openjaus::model::fields::ComplexField
virtual ~ComplexField ()
 
- Public Member Functions inherited from openjaus::model::fields::Field
 Field ()
 
virtual ~Field ()
 
std::string getName () const
 Accessor to get the value of name. More...
 
bool setName (std::string name)
 Accessor to set value of name. More...
 
- Public Member Functions inherited from openjaus::system::Transportable
 Transportable ()
 
virtual ~Transportable ()
 

Static Public Attributes

static const uint8_t PV_NO_FIELDS = 0x0
 
static const uint8_t PV_PRISMATICJOINT1MAXSPEED = 0x1
 
static const uint8_t PV_PRISMATICJOINT1MAXFORCE = 0x2
 
static const uint8_t PV_ALL_FIELDS = PV_NO_FIELDS | PV_PRISMATICJOINT1MAXSPEED | PV_PRISMATICJOINT1MAXFORCE
 

Protected Attributes

PrismaticJoint1AngleScaledInteger prismaticJoint1Angle_rad
 
PrismaticJoint1MinValueScaledInteger prismaticJoint1MinValue_m
 
PrismaticJoint1MaxValueScaledInteger prismaticJoint1MaxValue_m
 
PrismaticJoint1MaxSpeedScaledInteger prismaticJoint1MaxSpeed_mps
 
PrismaticJoint1MaxForceScaledInteger prismaticJoint1MaxForce_N
 
uint8_t presenceVector
 
- Protected Attributes inherited from openjaus::model::fields::Record
std::vector< Field *> fields
 
- Protected Attributes inherited from openjaus::model::fields::Field
std::string name
 

Constructor & Destructor Documentation

◆ PrismaticJoint1AngleRecord() [1/2]

openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::PrismaticJoint1AngleRecord ( )

◆ PrismaticJoint1AngleRecord() [2/2]

openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::PrismaticJoint1AngleRecord ( const PrismaticJoint1AngleRecord source)

◆ ~PrismaticJoint1AngleRecord()

openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::~PrismaticJoint1AngleRecord ( )

Member Function Documentation

◆ copy()

void openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::copy ( PrismaticJoint1AngleRecord source)

◆ disablePrismaticJoint1MaxForce()

void openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::disablePrismaticJoint1MaxForce ( void  )

◆ disablePrismaticJoint1MaxSpeed()

void openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::disablePrismaticJoint1MaxSpeed ( void  )

◆ enablePrismaticJoint1MaxForce()

void openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::enablePrismaticJoint1MaxForce ( void  )

◆ enablePrismaticJoint1MaxSpeed()

void openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::enablePrismaticJoint1MaxSpeed ( void  )

◆ from()

uint64 openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::from ( system::BufferReader src)
virtual

Deserializes the contents the Buffer connected to the provided BufferReader into this object. The BufferReader position will be advanced inside this method such that calling from() again will attempt to read the next Transportable object from the Buffer.

Parameters
src

Reimplemented from openjaus::model::fields::Record.

◆ getPresenceVector()

uint8_t openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::getPresenceVector ( void  ) const

◆ getPrismaticJoint1Angle_rad()

double openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::getPrismaticJoint1Angle_rad ( void  )

◆ getPrismaticJoint1MaxForce_N()

double openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::getPrismaticJoint1MaxForce_N ( void  )

◆ getPrismaticJoint1MaxSpeed_mps()

double openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::getPrismaticJoint1MaxSpeed_mps ( void  )

◆ getPrismaticJoint1MaxValue_m()

double openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::getPrismaticJoint1MaxValue_m ( void  )

◆ getPrismaticJoint1MinValue_m()

double openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::getPrismaticJoint1MinValue_m ( void  )

◆ isPrismaticJoint1MaxForceEnabled()

bool openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::isPrismaticJoint1MaxForceEnabled ( void  ) const

◆ isPrismaticJoint1MaxSpeedEnabled()

bool openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::isPrismaticJoint1MaxSpeedEnabled ( void  ) const

◆ length()

uint64 openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::length ( void  ) const
virtual

Reimplemented from openjaus::model::fields::Record.

◆ setPresenceVector()

void openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::setPresenceVector ( uint8_t  value)

◆ setPrismaticJoint1Angle_rad()

bool openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::setPrismaticJoint1Angle_rad ( double  value)

◆ setPrismaticJoint1MaxForce_N()

bool openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::setPrismaticJoint1MaxForce_N ( double  value)

◆ setPrismaticJoint1MaxSpeed_mps()

bool openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::setPrismaticJoint1MaxSpeed_mps ( double  value)

◆ setPrismaticJoint1MaxValue_m()

bool openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::setPrismaticJoint1MaxValue_m ( double  value)

◆ setPrismaticJoint1MinValue_m()

bool openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::setPrismaticJoint1MinValue_m ( double  value)

◆ to()

uint64 openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::to ( system::BufferWriter dst) const
virtual

Serializes the contents of this object into the Buffer connected to the provided BufferWriter. The BufferWriter position will be advanced inside this method such that calling to() again will write the Transportable object into the Buffer a second time.

Parameters
dst

Reimplemented from openjaus::model::fields::Record.

◆ toXml()

std::string openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

◆ presenceVector

uint8_t openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::presenceVector
protected

◆ prismaticJoint1Angle_rad

PrismaticJoint1AngleScaledInteger openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::prismaticJoint1Angle_rad
protected

◆ prismaticJoint1MaxForce_N

PrismaticJoint1MaxForceScaledInteger openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::prismaticJoint1MaxForce_N
protected

◆ prismaticJoint1MaxSpeed_mps

PrismaticJoint1MaxSpeedScaledInteger openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::prismaticJoint1MaxSpeed_mps
protected

◆ prismaticJoint1MaxValue_m

PrismaticJoint1MaxValueScaledInteger openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::prismaticJoint1MaxValue_m
protected

◆ prismaticJoint1MinValue_m

PrismaticJoint1MinValueScaledInteger openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::prismaticJoint1MinValue_m
protected

◆ PV_ALL_FIELDS

const uint8_t openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::PV_ALL_FIELDS = PV_NO_FIELDS | PV_PRISMATICJOINT1MAXSPEED | PV_PRISMATICJOINT1MAXFORCE
static

◆ PV_NO_FIELDS

const uint8_t openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::PV_NO_FIELDS = 0x0
static

◆ PV_PRISMATICJOINT1MAXFORCE

const uint8_t openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::PV_PRISMATICJOINT1MAXFORCE = 0x2
static

◆ PV_PRISMATICJOINT1MAXSPEED

const uint8_t openjaus::manipulator_v1_0::PrismaticJoint1AngleRecord::PV_PRISMATICJOINT1MAXSPEED = 0x1
static

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