ddl::DDDataType Class Reference

A DataType class holding the DD for a Datatype with dependencies. (i.e. Units!) More...

#include <dddatatype.h>

Public Member Functions
	DDDataType ()=delete
	no default CTOR
	DDDataType (const DDDataType &)
	copy CTOR
	DDDataType (DDDataType &&)
	move CTOR
DDDataType &	operator= (const DDDataType &)
	copy assignment operator
DDDataType &	operator= (DDDataType &&)
	move assignment operator
	DDDataType (const std::string &name, size_t bit_size, const std::string &description={}, dd::OptionalSize array_size={}, const std::string &minimum_value={}, const std::string &maximum_value={}, dd::OptionalSize default_type_alignment={})
	CTOR.
	DDDataType (const std::string &name, size_t bit_size, const std::string &description, dd::OptionalSize array_size, const std::string &minimum_value, const std::string &maximum_value, dd::OptionalSize default_type_alignment, const DDUnit &unit)
	CTOR.
	DDDataType (const std::string &name, size_t bit_size, const std::string &description, dd::OptionalSize array_size, const std::string &minimum_value, const std::string &maximum_value, dd::OptionalSize default_type_alignment, const dd::BaseUnit &base_unit)
	CTOR.
const dd::DataType &	getDataType () const
	Get the Data Type object.
const dd::DataDefinition &	getDD () const
	Get the DataDefinition.

Detailed Description

A DataType class holding the DD for a Datatype with dependencies. (i.e. Units!)

Constructor & Destructor Documentation

DDDataType() [1/3]

ddl::DDDataType::DDDataType	(	const std::string &	name,
		size_t	bit_size,
		const std::string &	description = {},
		dd::OptionalSize	array_size = {},
		const std::string &	minimum_value = {},
		const std::string &	maximum_value = {},
		dd::OptionalSize	default_type_alignment = {} )

CTOR.

Parameters

name	the name of the POD Type
bit_size	the bit size of the type
description	the description of the type
array_size	the array size of the type (please use only 1! codec API does not support greater than 1 here!)
minimum_value	the minimum value (for information only)
maximum_value	the maximum value (for information only)
default_type_alignment	Type alignment (this is optional, because it is not part of the DD, but important for automatic calculation of member positions).

DDDataType() [2/3]

ddl::DDDataType::DDDataType	(	const std::string &	name,
		size_t	bit_size,
		const std::string &	description,
		dd::OptionalSize	array_size,
		const std::string &	minimum_value,
		const std::string &	maximum_value,
		dd::OptionalSize	default_type_alignment,
		const DDUnit &	unit )

CTOR.

Parameters

name	the name of the POD Type
bit_size	the bit size of the type
description	the description of the type
array_size	the array size of the type (please use only 1! codec API does not support greater than 1 here!)
minimum_value	the minimum value (for information only)
maximum_value	the maximum value (for information only)
unit	the unit to use for this type
default_type_alignment	Type alignment (this is optional, because it is not part of the DD, but important for automatic calculation of member positions)

DDDataType() [3/3]

ddl::DDDataType::DDDataType	(	const std::string &	name,
		size_t	bit_size,
		const std::string &	description,
		dd::OptionalSize	array_size,
		const std::string &	minimum_value,
		const std::string &	maximum_value,
		dd::OptionalSize	default_type_alignment,
		const dd::BaseUnit &	base_unit )

CTOR.

Parameters

name	the name of the POD Type
bit_size	the bit size of the type
description	the description of the type
array_size	the array size of the type (please use only 1! codec API does not support greater than 1 here!)
minimum_value	the minimum value (for information only)
maximum_value	the maximum value (for information only)
base_unit	the base_unit to use for this type
default_type_alignment	Type alignment (this is optional, because it is not part of the DD, but important for automatic calculation of member positions)

Member Function Documentation

getDataType()

const dd::DataType & ddl::DDDataType::getDataType

(

)

const

Get the Data Type object.

Returns

const dd::DataType&

getDD()

const dd::DataDefinition & ddl::DDDataType::getDD

(

)

const

Get the DataDefinition.

Returns

const dd::DataDefinition&

operator=() [1/2]

DDDataType & ddl::DDDataType::operator=

(

const DDDataType &

)

copy assignment operator

Returns

DDDataType&

operator=() [2/2]

DDDataType & ddl::DDDataType::operator=

(

DDDataType &&

)

move assignment operator

Returns

DDDataType&

---

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

• /workspace/conan/dev_essential/1.6.3/dw/stable/package/65324bff46e457721a7ba250afe9d61dc2b0e57a/include/ddl/dd/dddatatype.h