Skip to content
Snippets Groups Projects
Commit 1ecfc600 authored by Wuttke, Joachim's avatar Wuttke, Joachim
Browse files

doxy comments; expand alias

parent af098ebc
No related branches found
No related tags found
No related merge requests found
...@@ -46,7 +46,7 @@ SampleBuilderNode& SampleBuilderNode::operator=(const SampleBuilderNode& other) ...@@ -46,7 +46,7 @@ SampleBuilderNode& SampleBuilderNode::operator=(const SampleBuilderNode& other)
//! Sets sample builder and borrows its parameters. //! Sets sample builder and borrows its parameters.
void SampleBuilderNode::setSBN(const builder_t& sample_builder) void SampleBuilderNode::setSBN(const std::shared_ptr<ISampleBuilder>& sample_builder)
{ {
if (!sample_builder) if (!sample_builder)
throw std::runtime_error("SampleContainer::setSampleBuilder() -> Error. " throw std::runtime_error("SampleContainer::setSampleBuilder() -> Error. "
...@@ -76,7 +76,7 @@ std::unique_ptr<MultiLayer> SampleBuilderNode::createMultiLayer() ...@@ -76,7 +76,7 @@ std::unique_ptr<MultiLayer> SampleBuilderNode::createMultiLayer()
//! Returns current sample builder. //! Returns current sample builder.
SampleBuilderNode::builder_t SampleBuilderNode::builder() const std::shared_ptr<ISampleBuilder> SampleBuilderNode::builder() const
{ {
return m_sample_builder; return m_sample_builder;
} }
......
...@@ -20,20 +20,19 @@ ...@@ -20,20 +20,19 @@
class ISampleBuilder; class ISampleBuilder;
//! Enfolds MultiLayerBuilder to have it in INode tree. //! Wraps an ISampleBuilder, and puts it in an INode tree.
//! Used by SampleProvider.
//! @ingroup simulation_internal //! @ingroup simulation_internal
class SampleBuilderNode : public INode class SampleBuilderNode : public INode
{ {
using builder_t = std::shared_ptr<ISampleBuilder>;
public: public:
SampleBuilderNode(); SampleBuilderNode();
SampleBuilderNode(const SampleBuilderNode& other); SampleBuilderNode(const SampleBuilderNode& other);
SampleBuilderNode& operator=(const SampleBuilderNode& other); SampleBuilderNode& operator=(const SampleBuilderNode& other);
void setSBN(const builder_t& sample_builder); void setSBN(const std::shared_ptr<ISampleBuilder>& sample_builder);
void reset(); void reset();
...@@ -43,12 +42,12 @@ public: ...@@ -43,12 +42,12 @@ public:
explicit operator bool() const; explicit operator bool() const;
builder_t builder() const; std::shared_ptr<ISampleBuilder> builder() const;
private: private:
void borrow_builder_parameters(); void borrow_builder_parameters();
builder_t m_sample_builder; std::shared_ptr<ISampleBuilder> m_sample_builder;
}; };
#endif // BORNAGAIN_CORE_SAMPLEBUILDERENGINE_SAMPLEBUILDERNODE_H #endif // BORNAGAIN_CORE_SAMPLEBUILDERENGINE_SAMPLEBUILDERNODE_H
...@@ -20,8 +20,9 @@ ...@@ -20,8 +20,9 @@
class MultiLayer; class MultiLayer;
//! Gives access to the sample to simulate. Sample can come either directly from //! Holds either a Sample, or a SampleBuilderNode (which holds an ISampleBuilder).
//! the user or from SampleBuilder. //! Used in Simulation, which holds a SampleProvider member.
//! @ingroup simulation_internal //! @ingroup simulation_internal
class SampleProvider : public INode class SampleProvider : public INode
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment