This class implements all 0D fields (fields holding a single value only). More...

#include <Field0D.h>

Inheritance diagram for Ocean::SceneDescription::Field0D< T >:

Public Member Functions
	Field0D ()=default
	Creates a new single value field with an undefined value.

	Field0D (const T &value)
	Creates a new single value field by a given initialization value.

	Field0D (const T &value, const Timestamp timestamp)
	Creates a new single value field by a given initialization value and an explicit timestamp.

Type	type () const override
	Returns the type of this field.

unsigned int	dimension () const override
	Returns the dimension of this field.

const T &	value () const
	Returns the value of this field.

void	setValue (const T &value)
	Sets the value of this field and changes the modification timestamp to the current time.

void	setValue (const T &value, const Timestamp timestamp)
	Sets the value of this field and defines an explicit modification timestamp.

bool	assign (const Field &field) override
	Assigns a field to this field if both field have the identical field type.

Public Member Functions inherited from Ocean::SceneDescription::Field
virtual	~Field ()
	Destructs a field object.

Timestamp	timestamp () const
	Returns the most recent field modification timestamp.

bool	is0D () const
	Returns whether this field is a 0D field.

bool	is1D () const
	Returns whether this field is a 1D field.

bool	isType (const Type type) const
	Returns whether this field has a given type.

bool	isType (const Type type, const unsigned int dimension) const
	Returns whether this field has a given type and dimension.

void	setTimestamp (const Timestamp timestamp)
	Sets the field timestamp explicitly.

Field &	operator= (const Field &field)
	Assigns a field to this field.

Static Public Attributes
static constexpr Type	fieldType = TypeMapper<T>::type()
	Scalar type of this single field.

static constexpr unsigned int	fieldDimension = 0u
	Dimension of this single field.

Protected Member Functions
Field *	copy () const override
	Returns a new instance of this field.

Protected Member Functions inherited from Ocean::SceneDescription::Field
	Field ()=default
	Creates a new field.

	Field (const Field &field)=delete
	Disabled copy constructor.

	Field (const Timestamp timestamp)
	Creates a new field with an explicit modification timestamp.

Protected Attributes
T	value_
	Field (single) value.

Protected Attributes inherited from Ocean::SceneDescription::Field
Timestamp	timestamp_
	Field timestamp.

Additional Inherited Members
Public Types inherited from Ocean::SceneDescription::Field
enum	Type : uint32_t { TYPE_INVALID = 0u , TYPE_BOOLEAN , TYPE_COLOR , TYPE_FLOAT , TYPE_INT , TYPE_MATRIX3 , TYPE_MATRIX4 , TYPE_NODE , TYPE_ROTATION , TYPE_STRING , TYPE_TIME , TYPE_VECTOR2 , TYPE_VECTOR3 , TYPE_VECTOR4 }
	Definition of scalar field types. More...

Static Public Member Functions inherited from Ocean::SceneDescription::Field
template<typename T >
static const T &	cast (const Field &field)
	Casts an unspecific field object to the real field object.

Detailed Description

template<typename T>
class Ocean::SceneDescription::Field0D< T >

This class implements all 0D fields (fields holding a single value only).

Constructor & Destructor Documentation

◆ Field0D() [1/3]

template<typename T >

Ocean::SceneDescription::Field0D< T >::Field0D ( )

default

Creates a new single value field with an undefined value.

◆ Field0D() [2/3]

template<typename T >

Ocean::SceneDescription::Field0D< T >::Field0D ( const T & value )

inline

Creates a new single value field by a given initialization value.

The modification timestamp will be set to zero.

Parameters

value Initialization value

◆ Field0D() [3/3]

template<typename T >

Ocean::SceneDescription::Field0D< T >::Field0D	(	const T &	value,
		const Timestamp	timestamp
	)

inline

Creates a new single value field by a given initialization value and an explicit timestamp.

Parameters

value	Initialization value
timestamp	Explicit field timestamp

Member Function Documentation

◆ assign()

template<typename T >

bool Ocean::SceneDescription::Field0D< T >::assign ( const Field & field )

overridevirtual

Assigns a field to this field if both field have the identical field type.

See also: Field::assignField().

Implements Ocean::SceneDescription::Field.

◆ copy()

template<typename T >

Field * Ocean::SceneDescription::Field0D< T >::copy ( ) const

overrideprotectedvirtual

Returns a new instance of this field.

See also: Field::copy().

Implements Ocean::SceneDescription::Field.

◆ dimension()

template<typename T >

unsigned int Ocean::SceneDescription::Field0D< T >::dimension ( ) const

overridevirtual

Returns the dimension of this field.

See also: Field::dimension().

Implements Ocean::SceneDescription::Field.

◆ setValue() [1/2]

template<typename T >

void Ocean::SceneDescription::Field0D< T >::setValue ( const T & value )

inline

Sets the value of this field and changes the modification timestamp to the current time.

Parameters

value Value to set

◆ setValue() [2/2]

template<typename T >

void Ocean::SceneDescription::Field0D< T >::setValue	(	const T &	value,
		const Timestamp	timestamp
	)

inline

Sets the value of this field and defines an explicit modification timestamp.

Parameters

value	Value to set
timestamp	Explicit modification timestamp

◆ type()

template<typename T >

Field::Type Ocean::SceneDescription::Field0D< T >::type ( ) const

overridevirtual

Returns the type of this field.

See also: Field::type().

Implements Ocean::SceneDescription::Field.

◆ value()

template<typename T >

const T & Ocean::SceneDescription::Field0D< T >::value ( ) const

inline

Returns the value of this field.

Returns: Field value

Field Documentation

◆ fieldDimension

template<typename T >

constexpr unsigned int Ocean::SceneDescription::Field0D< T >::fieldDimension = 0u

staticconstexpr

Dimension of this single field.

◆ fieldType

template<typename T >

constexpr Type Ocean::SceneDescription::Field0D< T >::fieldType = TypeMapper<T>::type()

staticconstexpr

Scalar type of this single field.

◆ value_

template<typename T >

T Ocean::SceneDescription::Field0D< T >::value_

protected

Field (single) value.

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

Field0D.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Field0D() [1/3]

◆ Field0D() [2/3]

◆ Field0D() [3/3]

Member Function Documentation

◆ assign()

◆ copy()

◆ dimension()

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ type()

◆ value()

Field Documentation

◆ fieldDimension

◆ fieldType

◆ value_