iv::model::diamar::Group Struct Reference

#include <Groups.hpp>

Collaboration diagram for iv::model::diamar::Group:

Classes
struct	DefaultValues
struct	Keys
struct	Sections

Public Member Functions
	Group ()
	Group (iv::types::groupId id_, iv::types::groupIdForLom idForLom_, iv::model::LocalizedText names_, iv::model::LocalizedText longNames_, iv::model::LocalizedText description_)
	Group (const Group &other)
	Group (Group &&other) noexcept
	~Group ()
Group &	operator= (const Group &other)
Group &	operator= (Group &&other) noexcept
bool	load (const iv::file::xml::node &nodeGroup)
	Loads the group from the XML node.
bool	save (iv::file::xml::node &nodeGroup) const
std::string_view	getName (iv::eLanguage language=iv::eLanguage::English) const
std::string_view	getLongName (iv::eLanguage language=iv::eLanguage::English) const
std::string_view	getDescription (iv::eLanguage language=iv::eLanguage::English) const

Public Attributes
iv::types::groupId	id {}
iv::model::LocalizedText	names
iv::model::LocalizedText	longNames
iv::model::LocalizedText	description
iv::types::groupIdForLom	idForLom {DefaultValues::groupIdForLom}

Constructor & Destructor Documentation

Group() [1/4]

iv::model::diamar::Group::Group ( )

default

Group() [2/4]

iv::model::diamar::Group::Group	(	iv::types::groupId	id_,
		iv::types::groupIdForLom	idForLom_,
		iv::model::LocalizedText	names_,
		iv::model::LocalizedText	longNames_,
		iv::model::LocalizedText	description_ )

Group() [3/4]

iv::model::diamar::Group::Group ( const Group & other )

default

Group() [4/4]

iv::model::diamar::Group::Group ( Group && other )

noexcept

~Group()

iv::model::diamar::Group::~Group ( )

default

Member Function Documentation

getDescription()

std::string_view iv::model::diamar::Group::getDescription ( iv::eLanguage language = iv::eLanguage::English ) const

nodiscard

getLongName()

std::string_view iv::model::diamar::Group::getLongName ( iv::eLanguage language = iv::eLanguage::English ) const

nodiscard

getName()

std::string_view iv::model::diamar::Group::getName ( iv::eLanguage language = iv::eLanguage::English ) const

nodiscard

load()

bool iv::model::diamar::Group::load

(

const iv::file::xml::node &

nodeGroup

)

Loads the group from the XML node.

Parameters

nodeGroup

XML node to load from.

Returns

True if the load was successful, false otherwise.

Note

This load function is pointer-free.

operator=() [1/2]

Group & iv::model::diamar::Group::operator=

(

const Group &

other

)

operator=() [2/2]

Group & iv::model::diamar::Group::operator= ( Group && other )

noexcept

save()

bool iv::model::diamar::Group::save

(

iv::file::xml::node &

nodeGroup

)

const

Member Data Documentation

description

iv::model::LocalizedText iv::model::diamar::Group::description

id

iv::types::groupId iv::model::diamar::Group::id {}

idForLom

iv::types::groupIdForLom iv::model::diamar::Group::idForLom {DefaultValues::groupIdForLom}

longNames

iv::model::LocalizedText iv::model::diamar::Group::longNames

names

iv::model::LocalizedText iv::model::diamar::Group::names

---

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

• src/model/diamar/Groups.hpp
• src/model/diamar/Groups.cpp