Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[systems] Clarify doc that AllocateContext is a trap #22479

Merged
merged 1 commit into from
Jan 17, 2025
Merged

[systems] Clarify doc that AllocateContext is a trap #22479

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion systems/framework/system.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,12 @@ class System : public SystemBase {

// This is just an intentional shadowing of the base class method to return
// a more convenient type.
/** Returns a Context<T> suitable for use with this System<T>. */
/** (Advanced) Returns an **uninitialized** Context<T> suitable for use with
this System<T>. Most users should use CreateDefaultContext(), instead.
@warning The returned context is uninitialized (contains invalid data). It is
useful for pre-allocating storage which will later be overwritten (e.g., by
SetDefaultContext() or Context<T>::SetTimeStateAndParametersFrom()) and **must
not** be used for any calculations until it's been overwritten. */
std::unique_ptr<Context<T>> AllocateContext() const;

/** Allocates a CompositeEventCollection for this system. The allocated
Expand Down