maxon.frameworks.graph.GraphMessageInterface¶

Description¶

A graph message is an error or warning message to tell the user about issues found in the graph.
A graph attribute which has one of GraphAttributeInterface::FLAGS::ERROR, GraphAttributeInterface::FLAGS::WARNING
set can produce such messages via the method GraphAttributeInterface.GetMessages().
To query for messages use GraphNode.GetMessages().

Inheritance diagram¶

Inheritance

Parent Class:

maxon.ObjectInterface

Child Class:

maxon.frameworks.graph.GraphMessage

Methods Signature¶

Format()

Formats this message in a user-friendly way.

GetFlags()

Returns the flags of this message, either GraphAttributeInterface::FLAGS::ERROR, GraphAttributeInterface::FLAGS::WARNING or both.

GetOrigin()

Returns the origin of the message.

Methods Definition¶

GraphMessageInterface.Format()¶

Formats this message in a user-friendly way.

Returns: A human-readable message.
Return type: str

GraphMessageInterface.GetFlags()¶

Returns the flags of this message, either GraphAttributeInterface::FLAGS::ERROR, GraphAttributeInterface::FLAGS::WARNING or both.

Returns: Message flags.
Return type: maxon.frameworks.graph.GraphAttributeInterface.FLAGS

GraphMessageInterface.GetOrigin()¶

Returns the origin of the message.

The graph model implementation may propagate a message along connections, for example to make a message for a nested node visible at the outside of a group. In such cases the origin tells where the message originates.

Return type: maxon.frameworks.graph.NodePath
Returns: The origin of the message.