openjaus::model::fields::ScaledInteger Class Reference

This is a brief description. More...

#include <ScaledInteger.h>

Inherits openjaus::model::fields::ComplexField, openjaus::model::fields::Field, openjaus::model::fields::Unitized, and openjaus::system::Transportable.

Inherited by openjaus::core::PeriodicRateScaledInteger, openjaus::mobility::AngularAccelerationRmsScaledInteger, openjaus::mobility::AngularAccelerationScaledInteger, openjaus::mobility::AngularVelocityRmsScaledInteger, openjaus::mobility::AngularVelocityScaledInteger, openjaus::mobility::JausAltitudeScaledInteger, openjaus::mobility::JausLatitudeScaledInteger, openjaus::mobility::JausLongitudeScaledInteger, openjaus::mobility::LinearAccelerationRmsScaledInteger, openjaus::mobility::LinearAccelerationScaledInteger, openjaus::mobility::LinearSpeedScaledInteger, openjaus::mobility::LinearVelocityRmsScaledInteger, openjaus::mobility::LinearVelocityScaledInteger, openjaus::mobility::LocalPositionRmsScaledInteger, openjaus::mobility::LocalPositionScaledInteger, openjaus::mobility::MagneticVariationRefScaledInteger, openjaus::mobility::OrientationRmsScaledInteger, openjaus::mobility::OrientationScaledInteger, openjaus::mobility::PathToleranceRefScaledInteger, openjaus::mobility::PropulsiveEffortScaledInteger, openjaus::mobility::ResistiveEffortScaledInteger, openjaus::mobility::WaypointToleranceRefScaledInteger, and openjaus::mobility::WeightingFactorRefScaledInteger.

List of all members.

Public Member Functions
	ScaledInteger ()
virtual	~ScaledInteger ()
double	getValue () const
	Accessor to get the value of value.
bool	setValue (double value)
	Accessor to set value of value.
TypesUnsigned	getIntegerType () const
	Accessor to get the value of integerType.
bool	setIntegerType (TypesUnsigned integerType)
	Accessor to set value of integerType.
RoundingType	getRoundingType () const
	Accessor to get the value of roundingType.
bool	setRoundingType (RoundingType roundingType)
	Accessor to set value of roundingType.
double	getDefaultValue () const
	Accessor to get the value of defaultValue.
bool	setDefaultValue (double defaultValue)
	Accessor to set value of defaultValue.
const ScaledIntegerLimit &	getUpperLimit () const
	Accessor to get the value of upperLimit.
bool	setUpperLimit (const ScaledIntegerLimit &upperLimit)
	Accessor to set value of upperLimit.
const ScaledIntegerLimit &	getLowerLimit () const
	Accessor to get the value of lowerLimit.
bool	setLowerLimit (const ScaledIntegerLimit &lowerLimit)
	Accessor to set value of lowerLimit.
virtual int	to (system::Buffer *dst)
	Operation to.
virtual int	from (system::Buffer *src)
	Operation from.
virtual int	length ()
	Serializes object to internal transport buffer.
std::string	toString () const
Protected Attributes
double	value
TypesUnsigned	integerType
RoundingType	roundingType
double	defaultValue
ScaledIntegerLimit	upperLimit
ScaledIntegerLimit	lowerLimit
Friends
std::ostream &	operator<< (std::ostream &output, const ScaledInteger &object)

---

Detailed Description

Detailed description.

Author:

Name (name@email.com)

---

Constructor & Destructor Documentation

openjaus::model::fields::ScaledInteger::ScaledInteger

(

)

openjaus::model::fields::ScaledInteger::~ScaledInteger

(

)

[virtual]

---

Member Function Documentation

int openjaus::model::fields::ScaledInteger::from

(

system::Buffer *

src

)

[virtual]

Parameters:

src

Implements openjaus::system::Transportable.

Reimplemented in openjaus::core::PeriodicRateScaledInteger, openjaus::mobility::AngularAccelerationRmsScaledInteger, openjaus::mobility::AngularAccelerationScaledInteger, openjaus::mobility::AngularVelocityRmsScaledInteger, openjaus::mobility::AngularVelocityScaledInteger, openjaus::mobility::JausAltitudeScaledInteger, openjaus::mobility::JausLatitudeScaledInteger, openjaus::mobility::JausLongitudeScaledInteger, openjaus::mobility::LinearAccelerationRmsScaledInteger, openjaus::mobility::LinearAccelerationScaledInteger, openjaus::mobility::LinearSpeedScaledInteger, openjaus::mobility::LinearVelocityRmsScaledInteger, openjaus::mobility::LinearVelocityScaledInteger, openjaus::mobility::LocalPositionRmsScaledInteger, openjaus::mobility::LocalPositionScaledInteger, openjaus::mobility::MagneticVariationRefScaledInteger, openjaus::mobility::OrientationRmsScaledInteger, openjaus::mobility::OrientationScaledInteger, openjaus::mobility::PathToleranceRefScaledInteger, openjaus::mobility::PropulsiveEffortScaledInteger, openjaus::mobility::ResistiveEffortScaledInteger, openjaus::mobility::WaypointToleranceRefScaledInteger, and openjaus::mobility::WeightingFactorRefScaledInteger.

double openjaus::model::fields::ScaledInteger::getDefaultValue

(

)

const

TypesUnsigned openjaus::model::fields::ScaledInteger::getIntegerType

(

)

const

const ScaledIntegerLimit & openjaus::model::fields::ScaledInteger::getLowerLimit

(

)

const

RoundingType openjaus::model::fields::ScaledInteger::getRoundingType

(

)

const

const ScaledIntegerLimit & openjaus::model::fields::ScaledInteger::getUpperLimit

(

)

const

double openjaus::model::fields::ScaledInteger::getValue

(

)

const

int openjaus::model::fields::ScaledInteger::length

(

)

[virtual]

Implements openjaus::system::Transportable.

Reimplemented in openjaus::core::PeriodicRateScaledInteger, openjaus::mobility::AngularAccelerationRmsScaledInteger, openjaus::mobility::AngularAccelerationScaledInteger, openjaus::mobility::AngularVelocityRmsScaledInteger, openjaus::mobility::AngularVelocityScaledInteger, openjaus::mobility::JausAltitudeScaledInteger, openjaus::mobility::JausLatitudeScaledInteger, openjaus::mobility::JausLongitudeScaledInteger, openjaus::mobility::LinearAccelerationRmsScaledInteger, openjaus::mobility::LinearAccelerationScaledInteger, openjaus::mobility::LinearSpeedScaledInteger, openjaus::mobility::LinearVelocityRmsScaledInteger, openjaus::mobility::LinearVelocityScaledInteger, openjaus::mobility::LocalPositionRmsScaledInteger, openjaus::mobility::LocalPositionScaledInteger, openjaus::mobility::MagneticVariationRefScaledInteger, openjaus::mobility::OrientationRmsScaledInteger, openjaus::mobility::OrientationScaledInteger, openjaus::mobility::PathToleranceRefScaledInteger, openjaus::mobility::PropulsiveEffortScaledInteger, openjaus::mobility::ResistiveEffortScaledInteger, openjaus::mobility::WaypointToleranceRefScaledInteger, and openjaus::mobility::WeightingFactorRefScaledInteger.

bool openjaus::model::fields::ScaledInteger::setDefaultValue

(

double

defaultValue

)

Parameters:

defaultValue

The value of the new defaultValue.

bool openjaus::model::fields::ScaledInteger::setIntegerType

(

TypesUnsigned

integerType

)

Parameters:

integerType

The value of the new integerType.

bool openjaus::model::fields::ScaledInteger::setLowerLimit

(

const ScaledIntegerLimit &

lowerLimit

)

Parameters:

lowerLimit

The value of the new lowerLimit.

bool openjaus::model::fields::ScaledInteger::setRoundingType

(

RoundingType

roundingType

)

Parameters:

roundingType

The value of the new roundingType.

bool openjaus::model::fields::ScaledInteger::setUpperLimit

(

const ScaledIntegerLimit &

upperLimit

)

Parameters:

upperLimit

The value of the new upperLimit.

bool openjaus::model::fields::ScaledInteger::setValue

(

double

value

)

Parameters:

value

The value of the new value.

Reimplemented in openjaus::core::PeriodicRateScaledInteger, openjaus::mobility::AngularAccelerationRmsScaledInteger, openjaus::mobility::AngularAccelerationScaledInteger, openjaus::mobility::AngularVelocityRmsScaledInteger, openjaus::mobility::AngularVelocityScaledInteger, openjaus::mobility::JausAltitudeScaledInteger, openjaus::mobility::JausLatitudeScaledInteger, openjaus::mobility::JausLongitudeScaledInteger, openjaus::mobility::LinearAccelerationRmsScaledInteger, openjaus::mobility::LinearAccelerationScaledInteger, openjaus::mobility::LinearSpeedScaledInteger, openjaus::mobility::LinearVelocityRmsScaledInteger, openjaus::mobility::LinearVelocityScaledInteger, openjaus::mobility::LocalPositionRmsScaledInteger, openjaus::mobility::LocalPositionScaledInteger, openjaus::mobility::MagneticVariationRefScaledInteger, openjaus::mobility::OrientationRmsScaledInteger, openjaus::mobility::OrientationScaledInteger, openjaus::mobility::PathToleranceRefScaledInteger, openjaus::mobility::PropulsiveEffortScaledInteger, openjaus::mobility::ResistiveEffortScaledInteger, openjaus::mobility::WaypointToleranceRefScaledInteger, and openjaus::mobility::WeightingFactorRefScaledInteger.

int openjaus::model::fields::ScaledInteger::to

(

system::Buffer *

dst

)

[virtual]

Parameters:

dst

Implements openjaus::system::Transportable.

Reimplemented in openjaus::core::PeriodicRateScaledInteger, openjaus::mobility::AngularAccelerationRmsScaledInteger, openjaus::mobility::AngularAccelerationScaledInteger, openjaus::mobility::AngularVelocityRmsScaledInteger, openjaus::mobility::AngularVelocityScaledInteger, openjaus::mobility::JausAltitudeScaledInteger, openjaus::mobility::JausLatitudeScaledInteger, openjaus::mobility::JausLongitudeScaledInteger, openjaus::mobility::LinearAccelerationRmsScaledInteger, openjaus::mobility::LinearAccelerationScaledInteger, openjaus::mobility::LinearSpeedScaledInteger, openjaus::mobility::LinearVelocityRmsScaledInteger, openjaus::mobility::LinearVelocityScaledInteger, openjaus::mobility::LocalPositionRmsScaledInteger, openjaus::mobility::LocalPositionScaledInteger, openjaus::mobility::MagneticVariationRefScaledInteger, openjaus::mobility::OrientationRmsScaledInteger, openjaus::mobility::OrientationScaledInteger, openjaus::mobility::PathToleranceRefScaledInteger, openjaus::mobility::PropulsiveEffortScaledInteger, openjaus::mobility::ResistiveEffortScaledInteger, openjaus::mobility::WaypointToleranceRefScaledInteger, and openjaus::mobility::WeightingFactorRefScaledInteger.

std::string openjaus::model::fields::ScaledInteger::toString

(

)

const

Reimplemented from openjaus::system::Transportable.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	output,
		const ScaledInteger &	object
	)			[friend]

---

Member Data Documentation

double openjaus::model::fields::ScaledInteger::defaultValue [protected]

TypesUnsigned openjaus::model::fields::ScaledInteger::integerType [protected]

ScaledIntegerLimit openjaus::model::fields::ScaledInteger::lowerLimit [protected]

RoundingType openjaus::model::fields::ScaledInteger::roundingType [protected]

ScaledIntegerLimit openjaus::model::fields::ScaledInteger::upperLimit [protected]

double openjaus::model::fields::ScaledInteger::value [protected]

---

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

• include/openjaus/model/fields/ScaledInteger.h
• src/openjaus/model/fields/ScaledInteger.cpp