Relationship Generator 1.2.2
Believable families around a person: parents, siblings, partners and children, with ages and names for C++23
Loading...
Searching...
No Matches
dasmig::anchor_spec Struct Reference

The person a family is built around, as plain values. More...

#include <relgen.hpp>

Public Attributes

std::optional< std::string > country_code {}
 ISO 3166-1 alpha-2 code, or drawn by population.
 
std::optional< sex > bio_sex {}
 Biological sex, or drawn.
 
std::optional< std::chrono::year_month_day > birth {}
 Date of birth, or drawn.
 
std::optional< int > age {}
 Age in completed years at the reference date, or drawn.
 
std::optional< person_name > name {}
 The anchor's name; the parents, siblings and children are named to match it. Drawn when omitted.
 
std::optional< known_person > father {}
 The anchor's father, if known. Needs up >= 1 to appear.
 
std::optional< known_person > mother {}
 The anchor's mother, if known. Needs up >= 1 to appear.
 
std::optional< std::vector< known_sibling > > siblings {}
 The anchor's siblings and half-siblings, if known; none are drawn when this is set. Needs up >= 1 and siblings.
 
std::optional< std::vector< known_union > > unions {}
 The anchor's unions, if known (oldest first); none are drawn when this is set, and the children are the ones listed.
 

Detailed Description

The person a family is built around, as plain values.

Whatever is not given is drawn. A fixed birth wins over age.

The relatives (father, mother, siblings, unions) are for building the family of a member of a family that exists (see relg::expand()): a relative that is given is used as it is, and when a list is given no one else is drawn for it, even if the list is empty.

Definition at line 105 of file relgen.hpp.

Member Data Documentation

◆ age

std::optional<int> dasmig::anchor_spec::age {}

Age in completed years at the reference date, or drawn.

Definition at line 114 of file relgen.hpp.

◆ bio_sex

std::optional<sex> dasmig::anchor_spec::bio_sex {}

Biological sex, or drawn.

Definition at line 110 of file relgen.hpp.

◆ birth

std::optional<std::chrono::year_month_day> dasmig::anchor_spec::birth {}

Date of birth, or drawn.

Definition at line 112 of file relgen.hpp.

◆ country_code

std::optional<std::string> dasmig::anchor_spec::country_code {}

ISO 3166-1 alpha-2 code, or drawn by population.

Definition at line 108 of file relgen.hpp.

◆ father

std::optional<known_person> dasmig::anchor_spec::father {}

The anchor's father, if known. Needs up >= 1 to appear.

Definition at line 119 of file relgen.hpp.

◆ mother

std::optional<known_person> dasmig::anchor_spec::mother {}

The anchor's mother, if known. Needs up >= 1 to appear.

Definition at line 121 of file relgen.hpp.

◆ name

std::optional<person_name> dasmig::anchor_spec::name {}

The anchor's name; the parents, siblings and children are named to match it. Drawn when omitted.

Definition at line 117 of file relgen.hpp.

◆ siblings

std::optional<std::vector<known_sibling> > dasmig::anchor_spec::siblings {}

The anchor's siblings and half-siblings, if known; none are drawn when this is set. Needs up >= 1 and siblings.

Definition at line 124 of file relgen.hpp.

◆ unions

std::optional<std::vector<known_union> > dasmig::anchor_spec::unions {}

The anchor's unions, if known (oldest first); none are drawn when this is set, and the children are the ones listed.

Definition at line 127 of file relgen.hpp.


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