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::ConfigurationComponentList, openjaus::core::ConfigurationNodeList, openjaus::core::EventList, openjaus::core::QSComponentList, openjaus::core::QSLComponentList, openjaus::core::QSLNodeList, openjaus::core::QSLSubsystemList, openjaus::core::QSNodeList, openjaus::core::RSLSubsystemList, openjaus::core::RSubsystemList, openjaus::core::ServiceList, openjaus::core::ServicesComponentList, openjaus::core::ServicesNodeList, openjaus::core::ServicesServiceList, openjaus::environment::AnalogVideoSensorCapabilitiesList, openjaus::environment::AnalogVideoSensorConfigurationListRefArray, openjaus::environment::ConfirmSensorListRefArray, openjaus::environment::DigitalVideoSensorCapabilitesList, openjaus::environment::DigitalVideoSensorConfigurationListRefArray, openjaus::environment::GeometricPropertiesListRefArray, openjaus::environment::QueryDigitalVideoConfigurationList, openjaus::environment::QueryDigitalVideoSensorCapabilitiesList, openjaus::environment::QueryRangeSensorCapabilitiesList, openjaus::environment::QueryRangeSensorCompressedDataList, openjaus::environment::QueryRangeSensorConfigurationList, openjaus::environment::QueryRangeSensorDataList, openjaus::environment::QueryStillImageDataList, openjaus::environment::QueryStillImageSensorCapabilitiesList, openjaus::environment::QueryStillImageSensorConfigurationList, openjaus::environment::QueryVisualSensorCapabilitiesList, openjaus::environment::QueryVisualSensorConfigurationList, openjaus::environment::RangeSensorCapabilitiesList, openjaus::environment::RangeSensorCompressedDataList, openjaus::environment::RangeSensorConfigurationListRefArray, openjaus::environment::RangeSensorDataList, openjaus::environment::RangeSensorDataPointList, openjaus::environment::SensorIdListRefArray, openjaus::environment::SensorPositionRefArray, openjaus::environment::StillImageDataList, openjaus::environment::StillImageSensorConfigurationListRefArray, openjaus::environment::StillImageSensorList, openjaus::environment::UnitQuaternionRefArray, openjaus::environment::VisualSensorCapabilitiesList, openjaus::environment::VisualSensorConfigurationListRefArray, openjaus::hmi::ByteList, openjaus::hmi::CharList, openjaus::hmi::DataList, openjaus::hmi::FilledPolygonList, openjaus::hmi::FloatList, openjaus::hmi::GraphicsCommandList, openjaus::hmi::IntegerList, openjaus::hmi::LongFloatList, openjaus::hmi::LongIntList, openjaus::hmi::PolygonList, openjaus::hmi::PolylineList, openjaus::hmi::PrimitiveDataDefinitionList, openjaus::hmi::ReportAnalogDevicesList, openjaus::hmi::ShortIntList, openjaus::hmi::UIntegerList, openjaus::hmi::ULongIntList, openjaus::hmi::UShortIntList, openjaus::manipulator::ActuatorForceTorqueList, openjaus::manipulator::JointEffortList, openjaus::manipulator::JointMotionProfileList, openjaus::manipulator::JointPositionList, openjaus::manipulator::JointSpecificationList, openjaus::manipulator::JointVelocityList, openjaus::mobility::DeleteElementList, openjaus::mobility::ElementIdList, openjaus::mobility::ElementListRefArray, openjaus::ugv::BatteryCapabilitiesList, openjaus::ugv::BatteryStatusArray, openjaus::ugv::PowerPlantCapabilitiesList, openjaus::ugv::PowerPlantCfgList, openjaus::ugv::PowerPlantIdList, openjaus::ugv::PowerPlantStatusList, openjaus::ugv::ReportStabilizerEffortList, openjaus::ugv::ReportStabilizerPositionList, openjaus::ugv::SetStabilizerPositionList, openjaus::ugv::StabilizerCapabilitiesList, openjaus::ugv::StabilizerDimensionsList, openjaus::ugv::StabilizerEffortList, and openjaus::ugv::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 int	to (system::Buffer *dst)
	Operation to. More...
virtual int	from (system::Buffer *src)
	Operation from. More...
virtual int	length ()
	Serializes object to internal transport buffer. 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
virtual	~Transportable ()
	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()

int openjaus::model::fields::Array::from ( system::Buffer *  src )

virtual

Parameters

src

Implements openjaus::system::Transportable.

Reimplemented in openjaus::core::ConfigurationComponentList, openjaus::core::ConfigurationNodeList, openjaus::core::EventList, openjaus::core::QSLComponentList, openjaus::core::QSLNodeList, openjaus::core::QSLSubsystemList, openjaus::core::QSNodeList, openjaus::core::RSLSubsystemList, openjaus::core::RSubsystemList, openjaus::core::ServiceList, openjaus::core::ServicesComponentList, openjaus::core::ServicesNodeList, openjaus::core::ServicesServiceList, openjaus::environment::AnalogVideoSensorCapabilitiesList, openjaus::environment::AnalogVideoSensorConfigurationListRefArray, openjaus::environment::ConfirmSensorListRefArray, openjaus::environment::DigitalVideoSensorCapabilitesList, openjaus::environment::DigitalVideoSensorConfigurationListRefArray, openjaus::environment::GeometricPropertiesListRefArray, openjaus::environment::QueryDigitalVideoConfigurationList, openjaus::environment::QueryDigitalVideoSensorCapabilitiesList, openjaus::environment::QueryRangeSensorCapabilitiesList, openjaus::environment::QueryRangeSensorCompressedDataList, openjaus::environment::QueryRangeSensorConfigurationList, openjaus::environment::QueryRangeSensorDataList, openjaus::environment::QueryStillImageDataList, openjaus::environment::QueryStillImageSensorCapabilitiesList, openjaus::environment::QueryStillImageSensorConfigurationList, openjaus::environment::QueryVisualSensorCapabilitiesList, openjaus::environment::QueryVisualSensorConfigurationList, openjaus::environment::RangeSensorCapabilitiesList, openjaus::environment::RangeSensorCompressedDataList, openjaus::environment::RangeSensorConfigurationListRefArray, openjaus::environment::RangeSensorDataList, openjaus::environment::RangeSensorDataPointList, openjaus::environment::SensorIdListRefArray, openjaus::environment::SensorPositionRefArray, openjaus::environment::StillImageDataList, openjaus::environment::StillImageSensorConfigurationListRefArray, openjaus::environment::StillImageSensorList, openjaus::environment::UnitQuaternionRefArray, openjaus::environment::VisualSensorCapabilitiesList, openjaus::environment::VisualSensorConfigurationListRefArray, openjaus::hmi::ByteList, openjaus::hmi::CharList, openjaus::hmi::DataList, openjaus::hmi::FilledPolygonList, openjaus::hmi::FloatList, openjaus::hmi::GraphicsCommandList, openjaus::hmi::IntegerList, openjaus::hmi::LongFloatList, openjaus::hmi::LongIntList, openjaus::hmi::PolygonList, openjaus::hmi::PolylineList, openjaus::hmi::PrimitiveDataDefinitionList, openjaus::hmi::ReportAnalogDevicesList, openjaus::hmi::ShortIntList, openjaus::hmi::UIntegerList, openjaus::hmi::ULongIntList, openjaus::hmi::UShortIntList, openjaus::manipulator::ActuatorForceTorqueList, openjaus::manipulator::JointEffortList, openjaus::manipulator::JointMotionProfileList, openjaus::manipulator::JointPositionList, openjaus::manipulator::JointSpecificationList, openjaus::manipulator::JointVelocityList, openjaus::mobility::ElementListRefArray, openjaus::ugv::BatteryCapabilitiesList, openjaus::ugv::BatteryStatusArray, openjaus::ugv::PowerPlantCapabilitiesList, openjaus::ugv::PowerPlantCfgList, openjaus::ugv::PowerPlantStatusList, openjaus::ugv::ReportStabilizerEffortList, openjaus::ugv::ReportStabilizerPositionList, openjaus::ugv::SetStabilizerPositionList, openjaus::ugv::StabilizerCapabilitiesList, openjaus::ugv::StabilizerDimensionsList, openjaus::ugv::StabilizerEffortList, openjaus::core::QSComponentList, openjaus::mobility::DeleteElementList, openjaus::mobility::ElementIdList, openjaus::ugv::PowerPlantIdList, and openjaus::ugv::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()

int openjaus::model::fields::Array::length ( )

virtual

Implements openjaus::system::Transportable.

Reimplemented in openjaus::core::ConfigurationComponentList, openjaus::core::ConfigurationNodeList, openjaus::core::EventList, openjaus::core::QSLComponentList, openjaus::core::QSLNodeList, openjaus::core::QSLSubsystemList, openjaus::core::QSNodeList, openjaus::core::RSLSubsystemList, openjaus::core::RSubsystemList, openjaus::core::ServiceList, openjaus::core::ServicesComponentList, openjaus::core::ServicesNodeList, openjaus::core::ServicesServiceList, openjaus::environment::AnalogVideoSensorCapabilitiesList, openjaus::environment::AnalogVideoSensorConfigurationListRefArray, openjaus::environment::ConfirmSensorListRefArray, openjaus::environment::DigitalVideoSensorCapabilitesList, openjaus::environment::DigitalVideoSensorConfigurationListRefArray, openjaus::environment::GeometricPropertiesListRefArray, openjaus::environment::QueryDigitalVideoConfigurationList, openjaus::environment::QueryDigitalVideoSensorCapabilitiesList, openjaus::environment::QueryRangeSensorCapabilitiesList, openjaus::environment::QueryRangeSensorCompressedDataList, openjaus::environment::QueryRangeSensorConfigurationList, openjaus::environment::QueryRangeSensorDataList, openjaus::environment::QueryStillImageDataList, openjaus::environment::QueryStillImageSensorCapabilitiesList, openjaus::environment::QueryStillImageSensorConfigurationList, openjaus::environment::QueryVisualSensorCapabilitiesList, openjaus::environment::QueryVisualSensorConfigurationList, openjaus::environment::RangeSensorCapabilitiesList, openjaus::environment::RangeSensorCompressedDataList, openjaus::environment::RangeSensorConfigurationListRefArray, openjaus::environment::RangeSensorDataList, openjaus::environment::RangeSensorDataPointList, openjaus::environment::SensorIdListRefArray, openjaus::environment::SensorPositionRefArray, openjaus::environment::StillImageDataList, openjaus::environment::StillImageSensorConfigurationListRefArray, openjaus::environment::StillImageSensorList, openjaus::environment::UnitQuaternionRefArray, openjaus::environment::VisualSensorCapabilitiesList, openjaus::environment::VisualSensorConfigurationListRefArray, openjaus::hmi::ByteList, openjaus::hmi::CharList, openjaus::hmi::DataList, openjaus::hmi::FilledPolygonList, openjaus::hmi::FloatList, openjaus::hmi::GraphicsCommandList, openjaus::hmi::IntegerList, openjaus::hmi::LongFloatList, openjaus::hmi::LongIntList, openjaus::hmi::PolygonList, openjaus::hmi::PolylineList, openjaus::hmi::PrimitiveDataDefinitionList, openjaus::hmi::ReportAnalogDevicesList, openjaus::hmi::ShortIntList, openjaus::hmi::UIntegerList, openjaus::hmi::ULongIntList, openjaus::hmi::UShortIntList, openjaus::manipulator::ActuatorForceTorqueList, openjaus::manipulator::JointEffortList, openjaus::manipulator::JointMotionProfileList, openjaus::manipulator::JointPositionList, openjaus::manipulator::JointSpecificationList, openjaus::manipulator::JointVelocityList, openjaus::mobility::ElementListRefArray, openjaus::ugv::BatteryCapabilitiesList, openjaus::ugv::BatteryStatusArray, openjaus::ugv::PowerPlantCapabilitiesList, openjaus::ugv::PowerPlantCfgList, openjaus::ugv::PowerPlantStatusList, openjaus::ugv::ReportStabilizerEffortList, openjaus::ugv::ReportStabilizerPositionList, openjaus::ugv::SetStabilizerPositionList, openjaus::ugv::StabilizerCapabilitiesList, openjaus::ugv::StabilizerDimensionsList, openjaus::ugv::StabilizerEffortList, openjaus::core::QSComponentList, openjaus::mobility::DeleteElementList, openjaus::mobility::ElementIdList, openjaus::ugv::PowerPlantIdList, and openjaus::ugv::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()

int openjaus::model::fields::Array::to ( system::Buffer *  dst )

virtual

Parameters

dst

Implements openjaus::system::Transportable.

Reimplemented in openjaus::core::ConfigurationComponentList, openjaus::core::ConfigurationNodeList, openjaus::core::EventList, openjaus::core::QSLComponentList, openjaus::core::QSLNodeList, openjaus::core::QSLSubsystemList, openjaus::core::QSNodeList, openjaus::core::RSLSubsystemList, openjaus::core::RSubsystemList, openjaus::core::ServiceList, openjaus::core::ServicesComponentList, openjaus::core::ServicesNodeList, openjaus::core::ServicesServiceList, openjaus::environment::AnalogVideoSensorCapabilitiesList, openjaus::environment::AnalogVideoSensorConfigurationListRefArray, openjaus::environment::ConfirmSensorListRefArray, openjaus::environment::DigitalVideoSensorCapabilitesList, openjaus::environment::DigitalVideoSensorConfigurationListRefArray, openjaus::environment::GeometricPropertiesListRefArray, openjaus::environment::QueryDigitalVideoConfigurationList, openjaus::environment::QueryDigitalVideoSensorCapabilitiesList, openjaus::environment::QueryRangeSensorCapabilitiesList, openjaus::environment::QueryRangeSensorCompressedDataList, openjaus::environment::QueryRangeSensorConfigurationList, openjaus::environment::QueryRangeSensorDataList, openjaus::environment::QueryStillImageDataList, openjaus::environment::QueryStillImageSensorCapabilitiesList, openjaus::environment::QueryStillImageSensorConfigurationList, openjaus::environment::QueryVisualSensorCapabilitiesList, openjaus::environment::QueryVisualSensorConfigurationList, openjaus::environment::RangeSensorCapabilitiesList, openjaus::environment::RangeSensorCompressedDataList, openjaus::environment::RangeSensorConfigurationListRefArray, openjaus::environment::RangeSensorDataList, openjaus::environment::RangeSensorDataPointList, openjaus::environment::SensorIdListRefArray, openjaus::environment::SensorPositionRefArray, openjaus::environment::StillImageDataList, openjaus::environment::StillImageSensorConfigurationListRefArray, openjaus::environment::StillImageSensorList, openjaus::environment::UnitQuaternionRefArray, openjaus::environment::VisualSensorCapabilitiesList, openjaus::environment::VisualSensorConfigurationListRefArray, openjaus::hmi::ByteList, openjaus::hmi::CharList, openjaus::hmi::DataList, openjaus::hmi::FilledPolygonList, openjaus::hmi::FloatList, openjaus::hmi::GraphicsCommandList, openjaus::hmi::IntegerList, openjaus::hmi::LongFloatList, openjaus::hmi::LongIntList, openjaus::hmi::PolygonList, openjaus::hmi::PolylineList, openjaus::hmi::PrimitiveDataDefinitionList, openjaus::hmi::ReportAnalogDevicesList, openjaus::hmi::ShortIntList, openjaus::hmi::UIntegerList, openjaus::hmi::ULongIntList, openjaus::hmi::UShortIntList, openjaus::manipulator::ActuatorForceTorqueList, openjaus::manipulator::JointEffortList, openjaus::manipulator::JointMotionProfileList, openjaus::manipulator::JointPositionList, openjaus::manipulator::JointSpecificationList, openjaus::manipulator::JointVelocityList, openjaus::mobility::ElementListRefArray, openjaus::ugv::BatteryCapabilitiesList, openjaus::ugv::BatteryStatusArray, openjaus::ugv::PowerPlantCapabilitiesList, openjaus::ugv::PowerPlantCfgList, openjaus::ugv::PowerPlantStatusList, openjaus::ugv::ReportStabilizerEffortList, openjaus::ugv::ReportStabilizerPositionList, openjaus::ugv::SetStabilizerPositionList, openjaus::ugv::StabilizerCapabilitiesList, openjaus::ugv::StabilizerDimensionsList, openjaus::ugv::StabilizerEffortList, openjaus::core::QSComponentList, openjaus::mobility::DeleteElementList, openjaus::mobility::ElementIdList, openjaus::ugv::PowerPlantIdList, and openjaus::ugv::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