summaryrefslogtreecommitdiff
path: root/docs/data/core/id.json
blob: dc22fac940ff2e3640364d98f727ab2310ef34cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
{
	"format": 1,
	"id": "saw-id",
	"kind": "class",
	"name": "id",
	"namespace": "saw",
	"module": "core",
	"header": "modules/core/c++/id.hpp",
	"brief_description": "An identifier tied to the class it stands for.",
	"detailed_description": [
		[
			"A number underneath, but a distinct type per subject, so an id for one schema cannot be handed where an id for another is expected. That is what makes the remote layer safe to work with: nothing there moves data, it moves these."
		],
		[
			"Comparable and copyable, with no default constructor, so an id always refers to something somebody handed out."
		]
	],
	"templates": [
		{"name": "T", "kind": "type", "brief_description": "What the id refers to."}
	],
	"attributes": {
		"saw-id-value_": {
			"id": "saw-id-value_",
			"name": "value_",
			"type": ["uint64_t"],
			"visibility": "private"
		}
	},
	"functions": {
		"saw-id-ctor": {
			"id": "saw-id-ctor",
			"name": "id",
			"type": [],
			"parameters": [
				{"name": "val", "type": ["uint64_t"]}
			]
		},
		"saw-id-eq": {
			"id": "saw-id-eq",
			"name": "operator==",
			"type": ["bool"],
			"const": true,
			"parameters": [
				{"name": "rhs", "type": ["const id< T > &"]}
			]
		},
		"saw-id-neq": {
			"id": "saw-id-neq",
			"name": "operator!=",
			"type": ["bool"],
			"const": true,
			"parameters": [
				{"name": "rhs", "type": ["const id< T > &"]}
			]
		},
		"saw-id-get_value": {
			"id": "saw-id-get_value",
			"name": "get_value",
			"type": ["const uint64_t &"],
			"const": true,
			"brief_description": "The underlying number.",
			"detailed_description": [
				["Mostly for internal purposes, and for the moment an id has to be put somewhere which only understands numbers."]
			]
		}
	}
}