Skip to content

Added access to plugin datas from the DataManager, Actor and Report c… #328

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

Merged
shawnhatch merged 1 commit into from
Jun 13, 2025
Merged

Added access to plugin datas from the DataManager, Actor and Report c… #328

Show file tree
Hide file tree
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
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,4 +326,5 @@ Temporary Items
###################################

# VSCode
.vscode
.vscode
docgen/renv
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@

<!-- Properties -->
<properties>
<revision>4.4.3</revision>
<revision>4.4.4</revision>

<!-- basic project properties -->
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
Expand Down
26 changes: 26 additions & 0 deletions simulation/src/main/java/gov/hhs/aspr/ms/gcm/simulation/nucleus/ActorContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,5 +243,31 @@ public List<ActorPlan> retrievePlans() {
public Optional<Double> getSimulationHaltTime() {
return simulation.getSimulationHaltTime();
}

/**
* Returns the plugin data object associated with the given class reference
*
* @throws ContractException
* <ul>
* <li>{@linkplain NucleusError#NULL_PLUGIN_DATA_CLASS}
* if the class reference is null</li>
* <li>{@linkplain NucleusError#AMBIGUOUS_PLUGIN_DATA_CLASS}
* if more than one plugin data object matches the
* class reference</li>
* </ul>
*/
public <T extends PluginData> Optional<T> getPluginData(Class<T> pluginDataClass) {
return simulation.getPluginData(pluginDataClass);
}

/**
* Returns the plugin data objects associated with the given class reference
*
* @throws ContractException {@linkplain NucleusError#NULL_PLUGIN_DATA_CLASS} if
* the class reference is null
*/
public <T extends PluginData> List<T> getPluginDatas(Class<T> pluginDataClass) {
return simulation.getPluginDatas(pluginDataClass);
}

}
26 changes: 26 additions & 0 deletions simulation/src/main/java/gov/hhs/aspr/ms/gcm/simulation/nucleus/DataManagerContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,5 +315,31 @@ public DataManagerId getDataManagerId() {
public Optional<Double> getSimulationHaltTime() {
return simulation.getSimulationHaltTime();
}

/**
* Returns the plugin data object associated with the given class reference
*
* @throws ContractException
* <ul>
* <li>{@linkplain NucleusError#NULL_PLUGIN_DATA_CLASS}
* if the class reference is null</li>
* <li>{@linkplain NucleusError#AMBIGUOUS_PLUGIN_DATA_CLASS}
* if more than one plugin data object matches the
* class reference</li>
* </ul>
*/
public <T extends PluginData> Optional<T> getPluginData(Class<T> pluginDataClass) {
return simulation.getPluginData(pluginDataClass);
}

/**
* Returns the plugin data objects associated with the given class reference
*
* @throws ContractException {@linkplain NucleusError#NULL_PLUGIN_DATA_CLASS} if
* the class reference is null
*/
public <T extends PluginData> List<T> getPluginDatas(Class<T> pluginDataClass) {
return simulation.getPluginDatas(pluginDataClass);
}

}
26 changes: 26 additions & 0 deletions simulation/src/main/java/gov/hhs/aspr/ms/gcm/simulation/nucleus/ReportContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,5 +202,31 @@ public List<ReportPlan> retrievePlans() {
public Optional<Double> getSimulationHaltTime() {
return simulation.getSimulationHaltTime();
}

/**
* Returns the plugin data object associated with the given class reference
*
* @throws ContractException
* <ul>
* <li>{@linkplain NucleusError#NULL_PLUGIN_DATA_CLASS}
* if the class reference is null</li>
* <li>{@linkplain NucleusError#AMBIGUOUS_PLUGIN_DATA_CLASS}
* if more than one plugin data object matches the
* class reference</li>
* </ul>
*/
public <T extends PluginData> Optional<T> getPluginData(Class<T> pluginDataClass) {
return simulation.getPluginData(pluginDataClass);
}

/**
* Returns the plugin data objects associated with the given class reference
*
* @throws ContractException {@linkplain NucleusError#NULL_PLUGIN_DATA_CLASS} if
* the class reference is null
*/
public <T extends PluginData> List<T> getPluginDatas(Class<T> pluginDataClass) {
return simulation.getPluginDatas(pluginDataClass);
}

}
183 changes: 166 additions & 17 deletions simulation/src/test/java/gov/hhs/aspr/ms/gcm/simulation/nucleus/AT_ActorContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
Expand Down Expand Up @@ -392,12 +393,9 @@ public void testGetActorId() {
// show that the number of actor ids matches the number of actor aliases
assertEquals(3, observedActorIds.size());
}





private void executeGetDataManagerTest(Consumer<ActorContext> consumer) {

// create the test plugin data builder
TestPluginData.Builder pluginDataBuilder = TestPluginData.builder();

Expand All @@ -408,7 +406,7 @@ private void executeGetDataManagerTest(Consumer<ActorContext> consumer) {
pluginDataBuilder.addTestDataManager("dm3B", () -> new TestDataManager3B());
pluginDataBuilder.addTestDataManager("dm4A", () -> new TestDataManager4A());

pluginDataBuilder.addTestActorPlan("actor", new TestActorPlan(0, consumer));
pluginDataBuilder.addTestActorPlan("actor", new TestActorPlan(0, consumer));

// build the action plugin
TestPluginData testPluginData = pluginDataBuilder.build();
Expand All @@ -421,34 +419,34 @@ private void executeGetDataManagerTest(Consumer<ActorContext> consumer) {
@UnitTestMethod(target = ActorContext.class, name = "getDataManager", args = { Class.class })
public void testGetDataManager() {

//postcondition test:
executeGetDataManagerTest((c)->{
assertNotNull(c.getDataManager(TestDataManager1.class));
// postcondition test:
executeGetDataManagerTest((c) -> {
assertNotNull(c.getDataManager(TestDataManager1.class));
assertNotNull(c.getDataManager(TestDataManager3A.class));
assertNotNull(c.getDataManager(TestDataManager3B.class));
assertNotNull(c.getDataManager(TestDataManager4A.class));
assertNotNull(c.getDataManager(TestDataManager4.class));
});

// precondition test: if the class reference is null
ContractException contractException = assertThrows(ContractException.class, ()->{
executeGetDataManagerTest((c)->{
ContractException contractException = assertThrows(ContractException.class, () -> {
executeGetDataManagerTest((c) -> {
c.getDataManager(null);
});
});
assertEquals(NucleusError.NULL_DATA_MANAGER_CLASS, contractException.getErrorType());

// precondition test: if the class reference is null
contractException = assertThrows(ContractException.class, ()->{
executeGetDataManagerTest((c)->{
contractException = assertThrows(ContractException.class, () -> {
executeGetDataManagerTest((c) -> {
c.getDataManager(TestDataManager3.class);
});
});
assertEquals(NucleusError.AMBIGUOUS_DATA_MANAGER_CLASS, contractException.getErrorType());

// precondition test: if the class reference is unknown
contractException = assertThrows(ContractException.class, ()->{
executeGetDataManagerTest((c)->{
contractException = assertThrows(ContractException.class, () -> {
executeGetDataManagerTest((c) -> {
c.getDataManager(TestDataManager4B.class);
});
});
Expand Down Expand Up @@ -1070,4 +1068,155 @@ private void planRetrievalSimCloseSubscribe(ActorContext context, List<ActorPlan
assertEquals(expectedPlans.size(), plans.size());
assertEquals(expectedPlans, plans);
}

private static class LocalPluginData implements PluginData {

public static class Builder implements PluginDataBuilder {
@Override
public LocalPluginData build() {
return new LocalPluginData();
}
}

@Override
public PluginDataBuilder toBuilder() {
return new Builder();
}
}

private static class LocalPluginData2 implements PluginData {

public static class Builder implements PluginDataBuilder {
@Override
public LocalPluginData2 build() {
return new LocalPluginData2();
}
}

@Override
public PluginDataBuilder toBuilder() {
return new Builder();
}
}

@Test
@UnitTestMethod(target = ActorContext.class, name = "getPluginData", args = { Class.class })
public void testGetPluginData() {

TestPluginData.Builder pluginDataBuilder = TestPluginData.builder();

pluginDataBuilder.addTestActorPlan("actor", new TestActorPlan(0, (c) -> {
Optional<LocalPluginData> optional1 = c.getPluginData(LocalPluginData.class);
assertTrue(optional1.isPresent());
Optional<LocalPluginData2> optional2 = c.getPluginData(LocalPluginData2.class);
assertFalse(optional2.isPresent());

}));

// build the plugin
TestPluginData testPluginData = pluginDataBuilder.build();
Plugin testPlugin = TestPlugin.getTestPlugin(testPluginData);

Plugin localPlugin = Plugin.builder()//
.setPluginId(new SimplePluginId("localPlugin"))//
.addPluginData(new LocalPluginData())//
.build();

// run the simulation
Simulation.builder()//
.addPlugin(testPlugin)//
.addPlugin(localPlugin)//
.build()//
.execute();//

// precondition test: if more than one plugin data object matches the class
// reference
ContractException contractException = assertThrows(ContractException.class, () -> {
Plugin lp = Plugin.builder()//
.setPluginId(new SimplePluginId("localPlugin"))//
.addPluginData(new LocalPluginData())//
.addPluginData(new LocalPluginData())//
.build();

Simulation.builder()//
.addPlugin(lp)//
.addPlugin(TestPlugin.getTestPlugin(
TestPluginData.builder().addTestActorPlan("actor", new TestActorPlan(0, (c) -> {
c.getPluginData(LocalPluginData.class);
})).build()))//
.build()//
.execute();//
});
assertEquals(NucleusError.AMBIGUOUS_PLUGIN_DATA_CLASS, contractException.getErrorType());

// precondition test: if the class reference is null
contractException = assertThrows(ContractException.class, () -> {
Simulation.builder()//
.addPlugin(TestPlugin.getTestPlugin(
TestPluginData.builder().addTestActorPlan("actor", new TestActorPlan(0, (c) -> {
c.getPluginData(null);
})).build()))//
.build()//
.execute();//
});
assertEquals(NucleusError.NULL_PLUGIN_DATA_CLASS, contractException.getErrorType());

}

@Test
@UnitTestMethod(target = ActorContext.class, name = "getPluginDatas", args = { Class.class })
public void testGetPluginDatas() {
/*
* Returns the plugin data objects associated with the given class reference
*
* @throws ContractException {@linkplain NucleusError#NULL_PLUGIN_DATA_CLASS} if
* the class reference is null
*/
TestPluginData.Builder pluginDataBuilder = TestPluginData.builder();

pluginDataBuilder.addTestActorPlan("actor", new TestActorPlan(0, (c) -> {
List<LocalPluginData> localPluginDatas = c.getPluginDatas(LocalPluginData.class);
assertNotNull(localPluginDatas);
assertEquals(2,localPluginDatas.size());

List<LocalPluginData2> localPluginData2s = c.getPluginDatas(LocalPluginData2.class);
assertNotNull(localPluginData2s);
assertEquals(0,localPluginData2s.size());

List<PluginData> pluginDatas = c.getPluginDatas(PluginData.class);
assertNotNull(pluginDatas);
assertEquals(3,pluginDatas.size());

}));

// build the plugin
TestPluginData testPluginData = pluginDataBuilder.build();
Plugin testPlugin = TestPlugin.getTestPlugin(testPluginData);

Plugin localPlugin = Plugin.builder()//
.setPluginId(new SimplePluginId("localPlugin"))//
.addPluginData(new LocalPluginData())//
.addPluginData(new LocalPluginData())//
.build();

// run the simulation
Simulation.builder()//
.addPlugin(testPlugin)//
.addPlugin(localPlugin)//
.build()//
.execute();//

// precondition test: if the class reference is null
ContractException contractException = assertThrows(ContractException.class, () -> {
Simulation.builder()//
.addPlugin(TestPlugin.getTestPlugin(
TestPluginData.builder().addTestActorPlan("actor", new TestActorPlan(0, (c) -> {
c.getPluginDatas(null);
})).build()))//
.build()//
.execute();//
});
assertEquals(NucleusError.NULL_PLUGIN_DATA_CLASS, contractException.getErrorType());

}
}
Loading