Physlib

Physlib.Meta.Remark.Properties

4 declarations

definition

All Remark Information in the Environment

#allRemarkInfo

Within a monad mm that has access to the global environment, this definition retrieves the collection of all `RemarkInfo` metadata objects currently stored in the persistent environment extension `remarkExtension`, returning them as an array.

definition

Full name of a remark rr

#toFullName

Given an object rr of type `RemarkInfo`, which stores metadata for a "remark" in the library, this function computes its complete hierarchical identifier. If the remark is associated with a non-anonymous namespace, the full name is constructed by appending the remark's name to that namespace. Otherwise, the function returns the name of the remark itself.

definition

nn is a remark

#IsRemark

Given a name nn and working within a monad mm that has access to the global environment, this function determines if nn corresponds to a "remark" in the library. It searches through the metadata of all registered remarks and returns `true` if it finds a remark rr whose full name is equal to nn, and `false` otherwise.

definition

Retrieve the `RemarkInfo` metadata for name nn

#getRemarkInfo

Within a monad mm with access to the global environment, this function retrieves the metadata structure `RemarkInfo` associated with a given identifier nn of type `Name`. It searches the collection of all remarks currently stored in the environment and returns the specific `RemarkInfo` object rr whose full hierarchical name matches nn. If no remark with the name nn is found, the function throws an error.