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::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::Message, openjaus::model::fields::MessageField, openjaus::model::fields::Record, openjaus::model::fields::ScaledInteger, openjaus::model::fields::Short, 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.

List of all members.

Public Member Functions
	Field ()
virtual	~Field ()
std::string	getName () const
	Accessor to get the value of name.
bool	setName (std::string name)
	Accessor to set value of name.
bool	isOptional () const
	Accessor to get the value of optional.
bool	setOptional (bool optional)
	Accessor to set value of optional.
std::string	getInterpretation () const
	Accessor to get the value of interpretation.
bool	setInterpretation (std::string interpretation)
	Accessor to set value of interpretation.
std::string	toString () const
Protected Attributes
std::string	name
bool	optional
std::string	interpretation
Friends
std::ostream &	operator<< (std::ostream &output, const Field &object)

---

Detailed Description

Detailed description.

Author:

Name (name@email.com)

---

Constructor & Destructor Documentation

openjaus::model::fields::Field::Field

(

)

openjaus::model::fields::Field::~Field

(

)

[virtual]

---

Member Function Documentation

std::string openjaus::model::fields::Field::getInterpretation

(

)

const

std::string openjaus::model::fields::Field::getName

(

)

const

bool openjaus::model::fields::Field::isOptional

(

)

const

bool openjaus::model::fields::Field::setInterpretation

(

std::string

interpretation

)

Parameters:

interpretation

The value of the new interpretation.

bool openjaus::model::fields::Field::setName

(

std::string

name

)

Parameters:

name

The value of the new name.

bool openjaus::model::fields::Field::setOptional

(

bool

optional

)

Parameters:

optional

The value of the new optional.

std::string openjaus::model::fields::Field::toString

(

)

const

Reimplemented in openjaus::model::fields::FieldReference.

---

Friends And Related Function Documentation

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

---

Member Data Documentation

std::string openjaus::model::fields::Field::interpretation [protected]

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

bool openjaus::model::fields::Field::optional [protected]

---

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

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