kiid.h File Reference

#include <kicommon.h>
#include <boost/uuid/uuid.hpp>
#include <macros_swig.h>
#include <nlohmann/json_fwd.hpp>
#include <string>

Go to the source code of this file.

Classes
class	KIID
class	KIID_PATH
class	KIID_NIL_SET_RESET
	RAII class to safely set/reset nil KIIDs for use in footprint/symbol loading. More...
struct	std

Typedefs
typedef uint32_t	timestamp_t
	timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the timestamp when they were created.

Functions
KICOMMON_API KIID &	NilUuid ()
KICOMMON_API void	to_json (nlohmann::json &aJson, const KIID &aKIID)
KICOMMON_API void	from_json (const nlohmann::json &aJson, KIID &aKIID)

Variables
KICOMMON_API KIID	niluuid

Typedef Documentation

timestamp_t

typedef uint32_t timestamp_t

timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the timestamp when they were created.

Long term, this type might be renamed to something like unique_id_t (and then rename all the methods from {Get,Set}TimeStamp() to {Get,Set}Id()) ?

Definition at line 46 of file kiid.h.

Function Documentation

from_json()

KICOMMON_API void from_json	(	const nlohmann::json &	aJson,
		KIID &	aKIID
	)

Definition at line 365 of file kiid.cpp.

NilUuid()

KICOMMON_API KIID & NilUuid

(

)

Definition at line 67 of file kiid.cpp.

Referenced by SCH_IO_KICAD_SEXPR_PARSER::parseSchSymbolInstances().

to_json()

KICOMMON_API void to_json	(	nlohmann::json &	aJson,
		const KIID &	aKIID
	)

Definition at line 359 of file kiid.cpp.

References KIID::AsString().

Variable Documentation

niluuid

KICOMMON_API KIID niluuid

extern

Referenced by KIID::SniffTest().