OpenJAUS SAE SDK  6.0.0
Public Member Functions | Protected Attributes | Friends | List of all members
openjaus::model::fields::Field Class Reference

This is a brief description. More...

#include <Field.h>

Inherited by openjaus::model::fields::Array, openjaus::model::fields::BitField, openjaus::model::fields::Blob, openjaus::model::fields::Boolean, openjaus::model::fields::Byte, openjaus::model::fields::DateStamp, openjaus::model::fields::Double, openjaus::model::fields::Enumeration, openjaus::model::fields::FieldReference, openjaus::model::fields::FixedLengthString, openjaus::model::fields::Float, openjaus::model::fields::Integer, openjaus::model::fields::Long, openjaus::model::fields::MessageField, openjaus::model::fields::Record, openjaus::model::fields::ScaledInteger, openjaus::model::fields::Short, openjaus::model::fields::TimeStamp, openjaus::model::fields::UnsignedByte, openjaus::model::fields::UnsignedInteger, openjaus::model::fields::UnsignedLong, openjaus::model::fields::UnsignedShort, openjaus::model::fields::VariableLengthString, and openjaus::model::fields::Variant.

Public Member Functions

 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...
 
virtual std::string toString () const
 

Protected Attributes

std::string name
 

Friends

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

Detailed Description

Detailed description.

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

Constructor & Destructor Documentation

◆ Field()

openjaus::model::fields::Field::Field ( )

◆ ~Field()

openjaus::model::fields::Field::~Field ( )
virtual

Member Function Documentation

◆ getName()

std::string openjaus::model::fields::Field::getName ( ) const

◆ setName()

bool openjaus::model::fields::Field::setName ( std::string  name)
Parameters
nameThe value of the new name.

◆ toString()

std::string openjaus::model::fields::Field::toString ( ) const
virtual

Reimplemented in openjaus::model::fields::TimeStamp, openjaus::model::fields::DateStamp, openjaus::model::fields::BitField, openjaus::model::fields::Array, openjaus::model::fields::Blob, openjaus::model::fields::VariableLengthString, openjaus::model::fields::FixedLengthString, openjaus::model::fields::ScaledInteger, openjaus::model::fields::MessageField, openjaus::model::fields::Enumeration, openjaus::model::fields::Double, openjaus::model::fields::Float, openjaus::model::fields::Record, openjaus::model::fields::Byte, openjaus::model::fields::Integer, openjaus::model::fields::Long, openjaus::model::fields::Short, openjaus::model::fields::UnsignedByte, openjaus::model::fields::UnsignedInteger, openjaus::model::fields::UnsignedLong, openjaus::model::fields::UnsignedShort, openjaus::model::fields::Boolean, openjaus::model::fields::Variant, openjaus::model::fields::FieldReference, openjaus::core_v1_1::CommandResultEnumeration, openjaus::core_v1_1::ConfirmResponseCodeEnumeration, openjaus::core_v1_1::EmergencyCodeEnumeration, openjaus::core_v1_1::EventTypeEnumeration, openjaus::core_v1_1::PreferenceTCPEnumeration, openjaus::core_v1_1::RejectResponseCodeEnumeration, openjaus::core_v1_1::ResponseCodeEnumeration, openjaus::core_v1_1::StatusEnumeration, openjaus::core_v1_1::SystemLevelEnumeration, openjaus::environment_v1_0::AnalogFormatEnumeration, openjaus::environment_v1_0::AnalogVideoErrorCodeEnumeration, openjaus::environment_v1_0::BearingValidityEnumeration, openjaus::environment_v1_0::CoordinateTransformationSupportedEnumeration, openjaus::environment_v1_0::DataCompressionRefEnumeration, openjaus::environment_v1_0::DataErrorCodeEnumeration, openjaus::environment_v1_0::DigitalFormatEnumeration, openjaus::environment_v1_0::DigitalVideoErrorCodeEnumeration, openjaus::environment_v1_0::ExposureModeEnumeration, openjaus::environment_v1_0::FocusModeEnumeration, openjaus::environment_v1_0::FrameSizeRefEnumeration, openjaus::environment_v1_0::ImageStabilizationEnumeration, openjaus::environment_v1_0::ImageStablizationEnumeration, openjaus::environment_v1_0::ImagingModeEnumeration, openjaus::environment_v1_0::InclinationValidityEnumeration, openjaus::environment_v1_0::LightSensitivityEnumeration, openjaus::environment_v1_0::MeteringModeEnumeration, openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration, openjaus::environment_v1_0::RangeValidityEnumeration, openjaus::environment_v1_0::ReportCoordinateSystemRefEnumeration, openjaus::environment_v1_0::SensorStateEnumeration, openjaus::environment_v1_0::StillImageErrorCodeEnumeration, openjaus::environment_v1_0::StillImageFormatEnumeration, openjaus::environment_v1_0::StreamStateEnumeration, openjaus::environment_v1_0::VisualSensorErrorCodeEnumeration, openjaus::environment_v1_0::WhiteBalanceEnumeration, openjaus::environment_v1_0::ZoomModeEnumeration, openjaus::mobility_v1_0::AccelerationCommandTypeEnumeration, openjaus::mobility_v1_0::RejectElementResponseCodeEnumeration, openjaus::mobility_v1_0::VelocityCommandTypeEnumeration, openjaus::ugv_v1_0::OdometryTypeEnumeration, openjaus::ugv_v1_0::PlugStateEnumeration, openjaus::ugv_v1_0::PowerStateEnumeration, openjaus::ugv_v1_0::TransferCaseStatesEnumeration, openjaus::ugv_v1_0::TransmissionStatesEnumeration, and openjaus::ugv_v1_0::TripTypeEnumeration.

Friends And Related Function Documentation

◆ operator<< [1/2]

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

◆ operator<< [2/2]

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

Member Data Documentation

◆ name

std::string openjaus::model::fields::Field::name
protected

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