XML Documentation for gmCore

This page lists elements defined in the gmCore module and parameters (P), containers (C), their types and their corresponding C++ methods.

Parameters are set either as attributes or with the param tag, e.g. <param name="fullscreen" value="true">. Containers are typically automatically associated with the child type, through the Object::getDefaultKey() method, however it can be explicitly controlled through the KEY="container" attribute. Observe also that futher documentation for how an attribute should be used is sometimes available adjacent to the C++ methods.

XML attributes are parsed by stream operators. For more information about how this is done, refer to the documentation of the respective stream operator in the gramods namespace.

ImportLibrary

Loads a shared library and loads its nodes into the object factory. (more)

	Attribute	Type	Method	Documentation
P	dbgSuffix	string	setDbgSuffix	Set a string to append to the library name, before the file suffix.
P	library	string	setLibrary	Set name of library, used to create the name of the file.
P	libraryFile	filesystem::path	setLibraryFile	Set full path to library file.
P	prefix	string	setPrefix	Set a string to prepend to the library name.
P	suffix	string	setSuffix	Set a string to append to the library name.

LogFileMessageSink (extends MessageSink)

Message sink that writes to a specified log file. (more)

	Attribute	Type	Method	Documentation
P	append	bool	setAppend	Set to true if the messages should be appended to the end of the file, if it already exists.
P	level	int	setLevel	Set the level of messages to output.
P	logFilePath	filesystem::path	setLogFilePath	Sets the path to the log file to write to.

MessageSink

This is the base type for back-ends taking care of information sent to the Console class. (more)

	Attribute	Type	Method	Documentation
P	showTime	bool	setShowTime	Activate or deactivate the output of the time of each message.

OStreamMessageSink (extends MessageSink)

(more)

	Attribute	Type	Method	Documentation
P	level	int	setLevel	Set the level of messages to output.
P	stream	string	setStream	Set the stream to use as output, as string.
P	useAnsiColor	bool	setUseAnsiColor	Activate or deactivate the use of ANSI color escape characters to emphasize error and warning messages.