Field Definition structure. More...

#include <Register.hpp>

Public Member Functions
	Definition ()=delete
	Allow default constructor.

	Definition (const char _name, const char _desc, size_type _low_bit, size_type _high_bit)
	Limited constructor for backward compatibility.

	Definition (const char _name, const char _desc, size_type _low_bit, size_type _high_bit, bool _read_only)

Public Attributes
const char *	name
	Name - Must ahere to TreeNode::validateName. Must not be NULL.

const char *	desc
	Description. Must NOT be NULL.

size_type	low_bit
	Low bit (inclusive)

size_type	high_bit
	High bit (inclusive). Must be >= low_bit. (high_bit-low_bit) must be < MAX_FIELD_BITS. Larger fields are not supported.

bool	read_only
	Is this a read-only field.

Detailed Description

Field Definition structure.

Todo: Add reserved field (or other missing attributes)

Definition at line 168 of file Register.hpp.

Constructor & Destructor Documentation

◆ Definition() [1/2]

sparta::RegisterBase::Field::Definition::Definition	(	const char *	_name,
		const char *	_desc,
		size_type	_low_bit,
		size_type	_high_bit )

inline

Limited constructor for backward compatibility.

Note: read_only is initialized to false

Definition at line 179 of file Register.hpp.

◆ Definition() [2/2]

sparta::RegisterBase::Field::Definition::Definition	(	const char *	_name,
		const char *	_desc,
		size_type	_low_bit,
		size_type	_high_bit,
		bool	_read_only )

inline

Definition at line 190 of file Register.hpp.

Member Data Documentation

◆ desc

const char* sparta::RegisterBase::Field::Definition::desc

Description. Must NOT be NULL.

Definition at line 203 of file Register.hpp.

◆ high_bit

size_type sparta::RegisterBase::Field::Definition::high_bit

High bit (inclusive). Must be >= low_bit. (high_bit-low_bit) must be < MAX_FIELD_BITS. Larger fields are not supported.

Definition at line 205 of file Register.hpp.

◆ low_bit

size_type sparta::RegisterBase::Field::Definition::low_bit

Low bit (inclusive)

Definition at line 204 of file Register.hpp.

◆ name

const char* sparta::RegisterBase::Field::Definition::name

Name - Must ahere to TreeNode::validateName. Must not be NULL.

Definition at line 202 of file Register.hpp.

◆ read_only

bool sparta::RegisterBase::Field::Definition::read_only

Is this a read-only field.

Definition at line 206 of file Register.hpp.

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

/github/workspace/sparta/sparta/functional/Register.hpp

Public Member Functions

Public Attributes