openjaus::model::fields::Array Class Reference

This is a brief description. More...

#include <Array.h>

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

Inherited by openjaus::core_v1_1::ConfigurationComponentList, openjaus::core_v1_1::ConfigurationNodeList, openjaus::core_v1_1::EventList, openjaus::core_v1_1::QSComponentList, openjaus::core_v1_1::QSLComponentList, openjaus::core_v1_1::QSLNodeList, openjaus::core_v1_1::QSLSubsystemList, openjaus::core_v1_1::QSNodeList, openjaus::core_v1_1::RSLSubsystemList, openjaus::core_v1_1::RSubsystemList, openjaus::core_v1_1::ServiceList, openjaus::core_v1_1::ServicesComponentList, openjaus::core_v1_1::ServicesNodeList, openjaus::core_v1_1::ServicesServiceList, openjaus::environment_v1_0::AnalogVideoSensorCapabilitiesList, openjaus::environment_v1_0::AnalogVideoSensorConfigurationListRefArray, openjaus::environment_v1_0::ConfirmSensorListRefArray, openjaus::environment_v1_0::DigitalVideoSensorCapabilitesList, openjaus::environment_v1_0::DigitalVideoSensorConfigurationListRefArray, openjaus::environment_v1_0::GeometricPropertiesListRefArray, openjaus::environment_v1_0::QueryDigitalVideoConfigurationList, openjaus::environment_v1_0::QueryDigitalVideoSensorCapabilitiesList, openjaus::environment_v1_0::QueryRangeSensorCapabilitiesList, openjaus::environment_v1_0::QueryRangeSensorCompressedDataList, openjaus::environment_v1_0::QueryRangeSensorConfigurationList, openjaus::environment_v1_0::QueryRangeSensorDataList, openjaus::environment_v1_0::QueryStillImageDataList, openjaus::environment_v1_0::QueryStillImageSensorCapabilitiesList, openjaus::environment_v1_0::QueryStillImageSensorConfigurationList, openjaus::environment_v1_0::QueryVisualSensorCapabilitiesList, openjaus::environment_v1_0::QueryVisualSensorConfigurationList, openjaus::environment_v1_0::RangeSensorCapabilitiesList, openjaus::environment_v1_0::RangeSensorCompressedDataList, openjaus::environment_v1_0::RangeSensorConfigurationListRefArray, openjaus::environment_v1_0::RangeSensorDataList, openjaus::environment_v1_0::RangeSensorDataPointList, openjaus::environment_v1_0::SensorIdListRefArray, openjaus::environment_v1_0::SensorPositionRefArray, openjaus::environment_v1_0::StillImageDataList, openjaus::environment_v1_0::StillImageSensorConfigurationListRefArray, openjaus::environment_v1_0::StillImageSensorList, openjaus::environment_v1_0::UnitQuaternionRefArray, openjaus::environment_v1_0::VisualSensorCapabilitiesList, openjaus::environment_v1_0::VisualSensorConfigurationListRefArray, openjaus::manipulator_v1_0::ActuatorForceTorqueList, openjaus::manipulator_v1_0::JointEffortList, openjaus::manipulator_v1_0::JointMotionProfileList, openjaus::manipulator_v1_0::JointPositionList, openjaus::manipulator_v1_0::JointSpecificationList, openjaus::manipulator_v1_0::JointVelocityList, openjaus::mobility_v1_0::DeleteElementList, openjaus::mobility_v1_0::ElementIdList, openjaus::mobility_v1_0::ElementListRefArray, openjaus::ugv_v1_0::BatteryCapabilitiesList, openjaus::ugv_v1_0::BatteryStatusArray, openjaus::ugv_v1_0::PowerPlantCapabilitiesList, openjaus::ugv_v1_0::PowerPlantCfgList, openjaus::ugv_v1_0::PowerPlantIdList, openjaus::ugv_v1_0::PowerPlantStatusList, openjaus::ugv_v1_0::ReportStabilizerEffortList, openjaus::ugv_v1_0::ReportStabilizerPositionList, openjaus::ugv_v1_0::SetStabilizerPositionList, openjaus::ugv_v1_0::StabilizerCapabilitiesList, openjaus::ugv_v1_0::StabilizerDimensionsList, openjaus::ugv_v1_0::StabilizerEffortList, and openjaus::ugv_v1_0::StabilizerIDListRefArray.

Public Member Functions
	Array ()
virtual	~Array ()
TypesUnsigned	getSizeType () const
	Accessor to get the value of sizeType. More...
bool	setSizeType (TypesUnsigned sizeType)
	Accessor to set value of sizeType. More...
const ArrayType &	getType () const
	Accessor to get the value of type. More...
bool	setType (const ArrayType &type)
	Accessor to set value of type. More...
const std::vector< ArrayDimension *> &	getDimensions () const
	Accessor to get the value of dimensions. More...
bool	setDimensions (const ArrayDimension &dimensions)
	Accessor to set value of dimensions. More...
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 () const
	Gets the serialized length of this object. 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 ()

Protected Attributes
TypesUnsigned	sizeType
ArrayType	type
std::vector< ArrayDimension *>	dimensions
Protected Attributes inherited from openjaus::model::fields::Field
std::string	name

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const Array &object)
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const Array *object)

Detailed Description

Detailed description.

Author

Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

Array()

openjaus::model::fields::Array::Array

(

)

~Array()

openjaus::model::fields::Array::~Array ( )

virtual

Member Function Documentation

from()

uint64 openjaus::model::fields::Array::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

Implements openjaus::system::Transportable.

Reimplemented in openjaus::core_v1_1::ConfigurationComponentList, openjaus::core_v1_1::ConfigurationNodeList, openjaus::core_v1_1::EventList, openjaus::core_v1_1::QSLComponentList, openjaus::core_v1_1::QSLNodeList, openjaus::core_v1_1::QSLSubsystemList, openjaus::core_v1_1::QSNodeList, openjaus::core_v1_1::RSLSubsystemList, openjaus::core_v1_1::RSubsystemList, openjaus::core_v1_1::ServiceList, openjaus::core_v1_1::ServicesComponentList, openjaus::core_v1_1::ServicesNodeList, openjaus::core_v1_1::ServicesServiceList, openjaus::environment_v1_0::AnalogVideoSensorCapabilitiesList, openjaus::environment_v1_0::AnalogVideoSensorConfigurationListRefArray, openjaus::environment_v1_0::ConfirmSensorListRefArray, openjaus::environment_v1_0::DigitalVideoSensorCapabilitesList, openjaus::environment_v1_0::DigitalVideoSensorConfigurationListRefArray, openjaus::environment_v1_0::GeometricPropertiesListRefArray, openjaus::environment_v1_0::QueryDigitalVideoConfigurationList, openjaus::environment_v1_0::QueryDigitalVideoSensorCapabilitiesList, openjaus::environment_v1_0::QueryRangeSensorCapabilitiesList, openjaus::environment_v1_0::QueryRangeSensorCompressedDataList, openjaus::environment_v1_0::QueryRangeSensorConfigurationList, openjaus::environment_v1_0::QueryRangeSensorDataList, openjaus::environment_v1_0::QueryStillImageDataList, openjaus::environment_v1_0::QueryStillImageSensorCapabilitiesList, openjaus::environment_v1_0::QueryStillImageSensorConfigurationList, openjaus::environment_v1_0::QueryVisualSensorCapabilitiesList, openjaus::environment_v1_0::QueryVisualSensorConfigurationList, openjaus::environment_v1_0::RangeSensorCapabilitiesList, openjaus::environment_v1_0::RangeSensorCompressedDataList, openjaus::environment_v1_0::RangeSensorConfigurationListRefArray, openjaus::environment_v1_0::RangeSensorDataList, openjaus::environment_v1_0::RangeSensorDataPointList, openjaus::environment_v1_0::SensorIdListRefArray, openjaus::environment_v1_0::SensorPositionRefArray, openjaus::environment_v1_0::StillImageDataList, openjaus::environment_v1_0::StillImageSensorConfigurationListRefArray, openjaus::environment_v1_0::StillImageSensorList, openjaus::environment_v1_0::UnitQuaternionRefArray, openjaus::environment_v1_0::VisualSensorCapabilitiesList, openjaus::environment_v1_0::VisualSensorConfigurationListRefArray, openjaus::manipulator_v1_0::ActuatorForceTorqueList, openjaus::manipulator_v1_0::JointEffortList, openjaus::manipulator_v1_0::JointMotionProfileList, openjaus::manipulator_v1_0::JointPositionList, openjaus::manipulator_v1_0::JointSpecificationList, openjaus::manipulator_v1_0::JointVelocityList, openjaus::mobility_v1_0::ElementListRefArray, openjaus::ugv_v1_0::BatteryCapabilitiesList, openjaus::ugv_v1_0::BatteryStatusArray, openjaus::ugv_v1_0::PowerPlantCapabilitiesList, openjaus::ugv_v1_0::PowerPlantCfgList, openjaus::ugv_v1_0::PowerPlantStatusList, openjaus::ugv_v1_0::ReportStabilizerEffortList, openjaus::ugv_v1_0::ReportStabilizerPositionList, openjaus::ugv_v1_0::SetStabilizerPositionList, openjaus::ugv_v1_0::StabilizerCapabilitiesList, openjaus::ugv_v1_0::StabilizerDimensionsList, openjaus::ugv_v1_0::StabilizerEffortList, openjaus::core_v1_1::QSComponentList, openjaus::mobility_v1_0::DeleteElementList, openjaus::mobility_v1_0::ElementIdList, openjaus::ugv_v1_0::PowerPlantIdList, and openjaus::ugv_v1_0::StabilizerIDListRefArray.

getDimensions()

const std::vector< ArrayDimension *> & openjaus::model::fields::Array::getDimensions

(

)

const

getSizeType()

TypesUnsigned openjaus::model::fields::Array::getSizeType

(

)

const

getType()

const ArrayType & openjaus::model::fields::Array::getType

(

)

const

length()

uint64 openjaus::model::fields::Array::length ( ) const

virtual

Implements openjaus::system::Transportable.

Reimplemented in openjaus::core_v1_1::ConfigurationComponentList, openjaus::core_v1_1::ConfigurationNodeList, openjaus::core_v1_1::EventList, openjaus::core_v1_1::QSLComponentList, openjaus::core_v1_1::QSLNodeList, openjaus::core_v1_1::QSLSubsystemList, openjaus::core_v1_1::QSNodeList, openjaus::core_v1_1::RSLSubsystemList, openjaus::core_v1_1::RSubsystemList, openjaus::core_v1_1::ServiceList, openjaus::core_v1_1::ServicesComponentList, openjaus::core_v1_1::ServicesNodeList, openjaus::core_v1_1::ServicesServiceList, openjaus::environment_v1_0::AnalogVideoSensorCapabilitiesList, openjaus::environment_v1_0::AnalogVideoSensorConfigurationListRefArray, openjaus::environment_v1_0::ConfirmSensorListRefArray, openjaus::environment_v1_0::DigitalVideoSensorCapabilitesList, openjaus::environment_v1_0::DigitalVideoSensorConfigurationListRefArray, openjaus::environment_v1_0::GeometricPropertiesListRefArray, openjaus::environment_v1_0::QueryDigitalVideoConfigurationList, openjaus::environment_v1_0::QueryDigitalVideoSensorCapabilitiesList, openjaus::environment_v1_0::QueryRangeSensorCapabilitiesList, openjaus::environment_v1_0::QueryRangeSensorCompressedDataList, openjaus::environment_v1_0::QueryRangeSensorConfigurationList, openjaus::environment_v1_0::QueryRangeSensorDataList, openjaus::environment_v1_0::QueryStillImageDataList, openjaus::environment_v1_0::QueryStillImageSensorCapabilitiesList, openjaus::environment_v1_0::QueryStillImageSensorConfigurationList, openjaus::environment_v1_0::QueryVisualSensorCapabilitiesList, openjaus::environment_v1_0::QueryVisualSensorConfigurationList, openjaus::environment_v1_0::RangeSensorCapabilitiesList, openjaus::environment_v1_0::RangeSensorCompressedDataList, openjaus::environment_v1_0::RangeSensorConfigurationListRefArray, openjaus::environment_v1_0::RangeSensorDataList, openjaus::environment_v1_0::RangeSensorDataPointList, openjaus::environment_v1_0::SensorIdListRefArray, openjaus::environment_v1_0::SensorPositionRefArray, openjaus::environment_v1_0::StillImageDataList, openjaus::environment_v1_0::StillImageSensorConfigurationListRefArray, openjaus::environment_v1_0::StillImageSensorList, openjaus::environment_v1_0::UnitQuaternionRefArray, openjaus::environment_v1_0::VisualSensorCapabilitiesList, openjaus::environment_v1_0::VisualSensorConfigurationListRefArray, openjaus::manipulator_v1_0::ActuatorForceTorqueList, openjaus::manipulator_v1_0::JointEffortList, openjaus::manipulator_v1_0::JointMotionProfileList, openjaus::manipulator_v1_0::JointPositionList, openjaus::manipulator_v1_0::JointSpecificationList, openjaus::manipulator_v1_0::JointVelocityList, openjaus::mobility_v1_0::ElementListRefArray, openjaus::ugv_v1_0::BatteryCapabilitiesList, openjaus::ugv_v1_0::BatteryStatusArray, openjaus::ugv_v1_0::PowerPlantCapabilitiesList, openjaus::ugv_v1_0::PowerPlantCfgList, openjaus::ugv_v1_0::PowerPlantStatusList, openjaus::ugv_v1_0::ReportStabilizerEffortList, openjaus::ugv_v1_0::ReportStabilizerPositionList, openjaus::ugv_v1_0::SetStabilizerPositionList, openjaus::ugv_v1_0::StabilizerCapabilitiesList, openjaus::ugv_v1_0::StabilizerDimensionsList, openjaus::ugv_v1_0::StabilizerEffortList, openjaus::core_v1_1::QSComponentList, openjaus::mobility_v1_0::DeleteElementList, openjaus::mobility_v1_0::ElementIdList, openjaus::ugv_v1_0::PowerPlantIdList, and openjaus::ugv_v1_0::StabilizerIDListRefArray.

setDimensions()

bool openjaus::model::fields::Array::setDimensions

(

const ArrayDimension &

dimensions

)

Parameters

dimensions

The value of the new dimensions.

setSizeType()

bool openjaus::model::fields::Array::setSizeType

(

TypesUnsigned

sizeType

)

Parameters

sizeType

The value of the new sizeType.

setType()

bool openjaus::model::fields::Array::setType

(

const ArrayType &

type

)

Parameters

type	The value of the new type.

to()

uint64 openjaus::model::fields::Array::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

Implements openjaus::system::Transportable.

Reimplemented in openjaus::core_v1_1::ConfigurationComponentList, openjaus::core_v1_1::ConfigurationNodeList, openjaus::core_v1_1::EventList, openjaus::core_v1_1::QSLComponentList, openjaus::core_v1_1::QSLNodeList, openjaus::core_v1_1::QSLSubsystemList, openjaus::core_v1_1::QSNodeList, openjaus::core_v1_1::RSLSubsystemList, openjaus::core_v1_1::RSubsystemList, openjaus::core_v1_1::ServiceList, openjaus::core_v1_1::ServicesComponentList, openjaus::core_v1_1::ServicesNodeList, openjaus::core_v1_1::ServicesServiceList, openjaus::environment_v1_0::AnalogVideoSensorCapabilitiesList, openjaus::environment_v1_0::AnalogVideoSensorConfigurationListRefArray, openjaus::environment_v1_0::ConfirmSensorListRefArray, openjaus::environment_v1_0::DigitalVideoSensorCapabilitesList, openjaus::environment_v1_0::DigitalVideoSensorConfigurationListRefArray, openjaus::environment_v1_0::GeometricPropertiesListRefArray, openjaus::environment_v1_0::QueryDigitalVideoConfigurationList, openjaus::environment_v1_0::QueryDigitalVideoSensorCapabilitiesList, openjaus::environment_v1_0::QueryRangeSensorCapabilitiesList, openjaus::environment_v1_0::QueryRangeSensorCompressedDataList, openjaus::environment_v1_0::QueryRangeSensorConfigurationList, openjaus::environment_v1_0::QueryRangeSensorDataList, openjaus::environment_v1_0::QueryStillImageDataList, openjaus::environment_v1_0::QueryStillImageSensorCapabilitiesList, openjaus::environment_v1_0::QueryStillImageSensorConfigurationList, openjaus::environment_v1_0::QueryVisualSensorCapabilitiesList, openjaus::environment_v1_0::QueryVisualSensorConfigurationList, openjaus::environment_v1_0::RangeSensorCapabilitiesList, openjaus::environment_v1_0::RangeSensorCompressedDataList, openjaus::environment_v1_0::RangeSensorConfigurationListRefArray, openjaus::environment_v1_0::RangeSensorDataList, openjaus::environment_v1_0::RangeSensorDataPointList, openjaus::environment_v1_0::SensorIdListRefArray, openjaus::environment_v1_0::SensorPositionRefArray, openjaus::environment_v1_0::StillImageDataList, openjaus::environment_v1_0::StillImageSensorConfigurationListRefArray, openjaus::environment_v1_0::StillImageSensorList, openjaus::environment_v1_0::UnitQuaternionRefArray, openjaus::environment_v1_0::VisualSensorCapabilitiesList, openjaus::environment_v1_0::VisualSensorConfigurationListRefArray, openjaus::manipulator_v1_0::ActuatorForceTorqueList, openjaus::manipulator_v1_0::JointEffortList, openjaus::manipulator_v1_0::JointMotionProfileList, openjaus::manipulator_v1_0::JointPositionList, openjaus::manipulator_v1_0::JointSpecificationList, openjaus::manipulator_v1_0::JointVelocityList, openjaus::mobility_v1_0::ElementListRefArray, openjaus::ugv_v1_0::BatteryCapabilitiesList, openjaus::ugv_v1_0::BatteryStatusArray, openjaus::ugv_v1_0::PowerPlantCapabilitiesList, openjaus::ugv_v1_0::PowerPlantCfgList, openjaus::ugv_v1_0::PowerPlantStatusList, openjaus::ugv_v1_0::ReportStabilizerEffortList, openjaus::ugv_v1_0::ReportStabilizerPositionList, openjaus::ugv_v1_0::SetStabilizerPositionList, openjaus::ugv_v1_0::StabilizerCapabilitiesList, openjaus::ugv_v1_0::StabilizerDimensionsList, openjaus::ugv_v1_0::StabilizerEffortList, openjaus::core_v1_1::QSComponentList, openjaus::mobility_v1_0::DeleteElementList, openjaus::mobility_v1_0::ElementIdList, openjaus::ugv_v1_0::PowerPlantIdList, and openjaus::ugv_v1_0::StabilizerIDListRefArray.

toString()

std::string openjaus::model::fields::Array::toString ( ) const

virtual

Reimplemented from openjaus::model::fields::Field.

Friends And Related Function Documentation

operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const Array &  object  )

friend

operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const Array *  object  )

friend

Member Data Documentation

dimensions

std::vector< ArrayDimension* > openjaus::model::fields::Array::dimensions

protected

sizeType

TypesUnsigned openjaus::model::fields::Array::sizeType

protected

type

ArrayType openjaus::model::fields::Array::type

protected

---

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

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