celeritas::orangeinp::ObjectInterface Class Reference

Base class for constructing high-level CSG objects in ORANGE. More...

#include <ObjectInterface.hh>

Inheritance diagram for celeritas::orangeinp::ObjectInterface:

Public Types
Type aliases
using	SPConstObject = std::shared_ptr< ObjectInterface const >
using	VolumeBuilder = detail::VolumeBuilder

Public Member Functions
virtual	~ObjectInterface ()=0
	Anchored default destructor.
virtual std::string_view	label () const =0
	Short unique name of this object.
virtual NodeId	build (VolumeBuilder &) const =0
	Construct a volume from this object.
virtual void	output (JsonPimpl *) const =0
	Write the region to a JSON object.

Protected Member Functions
	ObjectInterface (ObjectInterface const &)=default
ObjectInterface &	operator= (ObjectInterface const &)=default
	ObjectInterface (ObjectInterface &&)=default
ObjectInterface &	operator= (ObjectInterface &&)=default

Detailed Description

Base class for constructing high-level CSG objects in ORANGE.

Constructor & Destructor Documentation

ObjectInterface() [1/3]

celeritas::orangeinp::ObjectInterface::ObjectInterface ( )

protecteddefault

Allow construction and assignment only through daughter classes

ObjectInterface() [2/3]

celeritas::orangeinp::ObjectInterface::ObjectInterface ( ObjectInterface const &  )

protecteddefault

Allow construction and assignment only through daughter classes

ObjectInterface() [3/3]

celeritas::orangeinp::ObjectInterface::ObjectInterface ( ObjectInterface &&  )

protecteddefault

Allow construction and assignment only through daughter classes

Member Function Documentation

build()

virtual NodeId celeritas::orangeinp::ObjectInterface::build ( VolumeBuilder &  ) const

pure virtual

Construct a volume from this object.

Implemented in celeritas::orangeinp::NegatedObject, celeritas::orangeinp::JoinObjects< Op >, celeritas::orangeinp::PolyCone, celeritas::orangeinp::PolyPrism, celeritas::orangeinp::RevolvedPolygon, celeritas::orangeinp::ShapeBase, celeritas::orangeinp::SolidBase, celeritas::orangeinp::StackedExtrudedPolygon, celeritas::orangeinp::Transformed, and celeritas::orangeinp::Truncated.

label()

virtual std::string_view celeritas::orangeinp::ObjectInterface::label ( ) const

pure virtual

Short unique name of this object.

Implemented in celeritas::orangeinp::NegatedObject, celeritas::orangeinp::JoinObjects< Op >, celeritas::orangeinp::PolySolidBase, celeritas::orangeinp::RevolvedPolygon, celeritas::orangeinp::ShapeBase, celeritas::orangeinp::Solid< T >, celeritas::orangeinp::StackedExtrudedPolygon, celeritas::orangeinp::Transformed, and celeritas::orangeinp::Truncated.

operator=() [1/2]

ObjectInterface & celeritas::orangeinp::ObjectInterface::operator= ( ObjectInterface &&  )

protecteddefault

Allow construction and assignment only through daughter classes

operator=() [2/2]

ObjectInterface & celeritas::orangeinp::ObjectInterface::operator= ( ObjectInterface const &  )

protecteddefault

Allow construction and assignment only through daughter classes

output()

virtual void celeritas::orangeinp::ObjectInterface::output ( JsonPimpl *  ) const

pure virtual

Write the region to a JSON object.

Implemented in celeritas::orangeinp::NegatedObject, celeritas::orangeinp::JoinObjects< Op >, celeritas::orangeinp::PolyCone, celeritas::orangeinp::PolyPrism, celeritas::orangeinp::RevolvedPolygon, celeritas::orangeinp::ShapeBase, celeritas::orangeinp::SolidBase, celeritas::orangeinp::StackedExtrudedPolygon, celeritas::orangeinp::Transformed, and celeritas::orangeinp::Truncated.

---

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

• ObjectInterface.hh
• ObjectInterface.cc