RayZaler 0.1
The free opto-mechanical simulation framework
RZ::CompositeElement Class Reference
Inheritance diagram for RZ::CompositeElement:
Collaboration diagram for RZ::CompositeElement:

Public Member Functions

 CompositeElement (ElementFactory *factory, std::string const &name, ReferenceFrame *pFrame, Recipe *recipe, GenericCompositeModel *parentCompositeModel, Element *parent=nullptr)
 
virtual OpticalPath opticalPath (std::string const &name="") const override
 
virtual void renderOpenGL () override
 
virtual OMModelnestedModel () const override
 
virtual GenericCompositeModelnestedCompositeModel () const
 
virtual void notifyDetector (std::string const &preferredName, Detector *det) override
 
virtual void setRecordHits (bool) override
 
virtual void clearHits () override
 
- Public Member Functions inherited from RZ::IHateCPlusPlus
 IHateCPlusPlus (OMModel *model)
 
OMModelmodel () const
 
- Public Member Functions inherited from RZ::GenericCompositeModel
 GenericCompositeModel (Recipe *, OMModel *, GenericCompositeModel *parentModel=nullptr, Element *parent=nullptr)
 
std::string givenName () const
 
std::list< std::string > params () const
 
std::list< std::string > dofs () const
 
GenericModelParamlookupParam (std::string const &)
 
GenericModelParamlookupDof (std::string const &)
 
GenericCompositeModelparentCompositeModel () const
 
bool loadScript (std::string const &path)
 
bool setParam (std::string const &, Real)
 
bool setDof (std::string const &, Real)
 
std::string resolveFilePath (std::string const &) const
 
void assignEverything ()
 
void updateRandState ()
 
void setRandomState (ExprRandomState *state)
 
ExprRandomStaterandState () const
 
void build (ReferenceFrame *, std::string const &prefix="")
 
void transferRecipeOwnership ()
 
virtual void notifyDetector (std::string const &preferredName, Detector *det)=0
 
- Public Member Functions inherited from RZ::OpticalElement
bool recordHits () const
 
virtual OpticalPath opticalPath (std::string const &name="") const
 
OpticalPath plug (OpticalElement *, std::string const &name="") const
 
const std::list< const OpticalSurface * > & opticalSurfaces () const
 
std::list< OpticalSurface * > opticalSurfaces ()
 
std::list< std::string > surfaceNames () const
 
OpticalSurfacelookupSurface (std::string const &)
 
const std::vector< Real > & hits (std::string const &name="") const
 
const std::vector< Real > & directions (std::string const &name="") const
 
virtual void setRecordHits (bool)
 
virtual void clearHits ()
 
- Public Member Functions inherited from RZ::Element
Real red () const
 
Real green () const
 
Real blue () const
 
ElementFactoryfactory () const
 
GenericCompositeModelparentModel ()
 
void setParentModel (GenericCompositeModel *model)
 
std::string const & name () const
 
bool hasProperty (std::string const &prop) const
 
PropertyValueType queryPropertyType (std::string const &prop) const
 
bool propertyIsHidden (std::string const &prop) const
 
ReferenceFrameparentFrame () const
 
bool visible () const
 
void refreshFrames ()
 
std::set< std::string > ports () const
 
std::set< std::string > properties () const
 
std::vector< std::string > sortedProperties () const
 
ReferenceFramegetPortFrame (std::string const &) const
 
Elementplug (std::string const &port, std::string const &type, std::string const &name="")
 
template<class T >
T * plug (std::string const &port, std::string const &type, std::string const &name="")
 
bool set (std::string const &, PropertyValue const &)
 
void setDefaults ()
 
PropertyValue get (std::string const &) const
 
template<class T >
get (std::string const &name) const
 
void setSelected (bool)
 
void setVisible (bool)
 
void boundingBox (Vec3 &p1, Vec3 &p2) const
 
virtual void enterOpenGL ()
 
virtual void nativeMaterialOpenGL (std::string const &role)
 
virtual void renderOpenGL ()
 
void calcBoundingBoxOpenGL ()
 
void renderBoundingBoxOpenGL ()
 
virtual OMModelnestedModel () const
 
virtual GenericCompositeModelnestedCompositeModel () const
 
ElementlookupElement (std::string const &name) const
 
OpticalElementlookupOpticalElement (std::string const &name) const
 
DetectorlookupDetector (std::string const &name) const
 
const OpticalPathlookupOpticalPath (std::string const &name) const
 

Protected Member Functions

virtual void registerDof (std::string const &name, GenericModelParam *) override
 
virtual void registerParam (std::string const &name, GenericModelParam *) override
 
virtual void registerOpticalPath (std::string const &name, std::list< std::string > &params) override
 
virtual GenericEvaluatorallocateEvaluator (std::string const &expr, const GenericEvaluatorSymbolDict *dict, std::list< GenericCustomFunction * > const &functions, ExprRandomState *state) override
 
virtual void exposePort (std::string const &name, ReferenceFrame *frame) override
 
virtual bool propertyChanged (std::string const &name, PropertyValue const &val) override
 
- Protected Member Functions inherited from RZ::GenericCompositeModel
GenericModelParamallocateParam ()
 
GenericEvaluatorSymbolDict const & symbolDict () const
 
void setName (std::string const &)
 
virtual void registerDof (std::string const &name, GenericModelParam *)=0
 
virtual void registerParam (std::string const &name, GenericModelParam *)=0
 
virtual void registerOpticalPath (std::string const &name, std::list< std::string > &params)=0
 
virtual GenericEvaluatorallocateEvaluator (std::string const &expr, const GenericEvaluatorSymbolDict *dict, std::list< GenericCustomFunction * > const &functions, ExprRandomState *state)=0
 
virtual void exposePort (std::string const &name, ReferenceFrame *frame)
 
ReferenceFramegetFrameOfContext (const RecipeContext *) const
 
- Protected Member Functions inherited from RZ::OpticalElement
void pushOpticalSurface (std::string, ReferenceFrame *, const MediumBoundary *)
 
void defineOpticalSurface (std::string, ReferenceFrame *, const MediumBoundary *)
 
 OpticalElement (ElementFactory *, std::string const &, ReferenceFrame *, Element *parent=nullptr)
 
- Protected Member Functions inherited from RZ::Element
void material (std::string const &role)
 
void refreshProperties ()
 
void registerProperty (std::string const &, PropertyValue const &, std::string const &)
 
ReferenceFrameregisterPort (std::string const &, ReferenceFrame *)
 
bool addPort (std::string const &, ReferenceFrame *)
 
template<class T >
T * registerPort (std::string const &name, T *frame)
 
virtual bool propertyChanged (std::string const &, PropertyValue const &)
 
void setBoundingBox (Vec3 const &p1, Vec3 const &p2)
 
void updatePropertyValue (std::string const &, PropertyValue const &)
 
 Element (ElementFactory *, std::string const &, ReferenceFrame *, Element *parent=nullptr)
 

Additional Inherited Members

- Static Public Member Functions inherited from RZ::OpticalElement
static OpticalElementfromElement (Element *element)
 

Member Function Documentation

◆ allocateEvaluator()

GenericEvaluator * CompositeElement::allocateEvaluator ( std::string const &  expr,
const GenericEvaluatorSymbolDict *  dict,
std::list< GenericCustomFunction * > const &  functions,
ExprRandomState state 
)
overrideprotectedvirtual

◆ clearHits()

void CompositeElement::clearHits ( )
overridevirtual

Reimplemented from RZ::OpticalElement.

◆ exposePort()

void CompositeElement::exposePort ( std::string const &  name,
ReferenceFrame frame 
)
overrideprotectedvirtual

Reimplemented from RZ::GenericCompositeModel.

◆ nestedCompositeModel()

GenericCompositeModel * CompositeElement::nestedCompositeModel ( ) const
virtual

Reimplemented from RZ::Element.

◆ nestedModel()

OMModel * CompositeElement::nestedModel ( ) const
overridevirtual

Reimplemented from RZ::Element.

◆ notifyDetector()

void CompositeElement::notifyDetector ( std::string const &  preferredName,
Detector det 
)
overridevirtual

◆ opticalPath()

OpticalPath CompositeElement::opticalPath ( std::string const &  name = "") const
overridevirtual

Reimplemented from RZ::OpticalElement.

◆ propertyChanged()

bool CompositeElement::propertyChanged ( std::string const &  name,
PropertyValue const &  val 
)
overrideprotectedvirtual

Reimplemented from RZ::Element.

◆ registerDof()

void CompositeElement::registerDof ( std::string const &  name,
GenericModelParam param 
)
overrideprotectedvirtual

◆ registerOpticalPath()

void CompositeElement::registerOpticalPath ( std::string const &  name,
std::list< std::string > &  params 
)
overrideprotectedvirtual

◆ registerParam()

void CompositeElement::registerParam ( std::string const &  name,
GenericModelParam param 
)
overrideprotectedvirtual

◆ renderOpenGL()

void CompositeElement::renderOpenGL ( )
overridevirtual

Reimplemented from RZ::Element.

◆ setRecordHits()

void CompositeElement::setRecordHits ( bool  record)
overridevirtual

Reimplemented from RZ::OpticalElement.


The documentation for this class was generated from the following files: