SHAPER  9.12.0
GDMLAPI_Ellipsoid Class Reference

Interface for primitive Ellipsoid feature. More...

Inheritance diagram for GDMLAPI_Ellipsoid:
Inheritance graph

Public Member Functions

 GDMLAPI_Ellipsoid (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 
 GDMLAPI_Ellipsoid (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Double &theAX, const ModelHighAPI_Double &theBY, const ModelHighAPI_Double &theCZ)
 Constructor with values. More...
 
 GDMLAPI_Ellipsoid (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Double &theAX, const ModelHighAPI_Double &theBY, const ModelHighAPI_Double &theCZ, const ModelHighAPI_Double &theZCut1, const ModelHighAPI_Double &theZCut2)
 Constructor with values. More...
 
virtual ~GDMLAPI_Ellipsoid ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< ModelAPI_AttributeDoubleax () const
 Ellipsoid size along X axis. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubleby () const
 Ellipsoid size along Y axis. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublecz () const
 Ellipsoid size along Z axis. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringuseZCut1 () const
 First cut of the ellipsoid along Z axis. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublezCut1 () const
 Position of the first cut. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringuseZCut2 () const
 Second cut of the ellipsoid along Z axis. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublezCut2 () const
 Position of the second cut. More...
 
void setSizes (const ModelHighAPI_Double &theAX, const ModelHighAPI_Double &theBY, const ModelHighAPI_Double &theCZ)
 Set dimensions. More...
 
void setZCut1 (const ModelHighAPI_Double &theZCut1)
 Set Z cut no.1. More...
 
void setZCut2 (const ModelHighAPI_Double &theZCut2)
 Set Z cut no.2. More...
 
virtual void dump (ModelHighAPI_Dumper &theDumper) const
 Dump wrapped feature. More...
 
std::shared_ptr< ModelAPI_Featurefeature () const
 Return ModelAPI_Feature. More...
 
std::shared_ptr< ModelHighAPI_InterfacesubFeature (const int theIndex) const
 If feature is composite return intefrace for sub-feature by zero-based index, or empty pointer if feature not composite or does not have sub-feature with such index. More...
 
const std::string & getKind () const
 Shortcut for feature()->getKind() More...
 
void execute (bool isForce=false)
 Shortcut for feature()->execute() More...
 
void setName (const std::wstring &theName)
 Shortcut for feature()->data()->setName() More...
 
std::wstring name () const
 Shortcut for feature()->data()->name() More...
 
virtual ModelHighAPI_Selection result () const
 Return firts object of the feature. More...
 
virtual std::list< ModelHighAPI_Selectionresults () const
 Return all objects of the feature. More...
 
virtual std::shared_ptr< ModelAPI_ResultdefaultResult () const
 Return default result. Default implementation feature()->lastResult() More...
 
void throwException (const std::string &theDescription)
 Throw exception to event loop. More...
 
const std::string & attributeGetter (const std::string &theAttrName)
 Return name of getter for specified attribute. More...
 

Static Public Member Functions

static std::string ID ()
 

Protected Member Functions

bool initialize ()
 

Protected Attributes

std::shared_ptr< ModelAPI_AttributeDoublemyax
 
std::shared_ptr< ModelAPI_AttributeDoublemyby
 
std::shared_ptr< ModelAPI_AttributeDoublemycz
 
std::shared_ptr< ModelAPI_AttributeStringmyuseZCut1
 
std::shared_ptr< ModelAPI_AttributeDoublemyzCut1
 
std::shared_ptr< ModelAPI_AttributeStringmyuseZCut2
 
std::shared_ptr< ModelAPI_AttributeDoublemyzCut2
 
std::shared_ptr< ModelAPI_FeaturemyFeature
 feature of this interface More...
 
std::map< std::string, std::string > myAttrGetter
 names of attributes and their getters More...
 

Detailed Description

Interface for primitive Ellipsoid feature.

Constructor & Destructor Documentation

◆ GDMLAPI_Ellipsoid() [1/3]

GDMLAPI_Ellipsoid::GDMLAPI_Ellipsoid ( const std::shared_ptr< ModelAPI_Feature > &  theFeature)
explicit

Constructor without values.

◆ GDMLAPI_Ellipsoid() [2/3]

GDMLAPI_Ellipsoid::GDMLAPI_Ellipsoid ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const ModelHighAPI_Double theAX,
const ModelHighAPI_Double theBY,
const ModelHighAPI_Double theCZ 
)
explicit

Constructor with values.

◆ GDMLAPI_Ellipsoid() [3/3]

GDMLAPI_Ellipsoid::GDMLAPI_Ellipsoid ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const ModelHighAPI_Double theAX,
const ModelHighAPI_Double theBY,
const ModelHighAPI_Double theCZ,
const ModelHighAPI_Double theZCut1,
const ModelHighAPI_Double theZCut2 
)
explicit

Constructor with values.

◆ ~GDMLAPI_Ellipsoid()

GDMLAPI_Ellipsoid::~GDMLAPI_Ellipsoid ( )
virtual

Destructor.

Member Function Documentation

◆ ax()

virtual std::shared_ptr< ModelAPI_AttributeDouble > GDMLAPI_Ellipsoid::ax ( ) const
inlinevirtual

Ellipsoid size along X axis.

◆ by()

virtual std::shared_ptr< ModelAPI_AttributeDouble > GDMLAPI_Ellipsoid::by ( ) const
inlinevirtual

Ellipsoid size along Y axis.

◆ cz()

virtual std::shared_ptr< ModelAPI_AttributeDouble > GDMLAPI_Ellipsoid::cz ( ) const
inlinevirtual

Ellipsoid size along Z axis.

◆ useZCut1()

virtual std::shared_ptr< ModelAPI_AttributeString > GDMLAPI_Ellipsoid::useZCut1 ( ) const
inlinevirtual

First cut of the ellipsoid along Z axis.

◆ zCut1()

virtual std::shared_ptr< ModelAPI_AttributeDouble > GDMLAPI_Ellipsoid::zCut1 ( ) const
inlinevirtual

Position of the first cut.

◆ useZCut2()

virtual std::shared_ptr< ModelAPI_AttributeString > GDMLAPI_Ellipsoid::useZCut2 ( ) const
inlinevirtual

Second cut of the ellipsoid along Z axis.

◆ zCut2()

virtual std::shared_ptr< ModelAPI_AttributeDouble > GDMLAPI_Ellipsoid::zCut2 ( ) const
inlinevirtual

Position of the second cut.

◆ setSizes()

void GDMLAPI_Ellipsoid::setSizes ( const ModelHighAPI_Double theAX,
const ModelHighAPI_Double theBY,
const ModelHighAPI_Double theCZ 
)

Set dimensions.

◆ setZCut1()

void GDMLAPI_Ellipsoid::setZCut1 ( const ModelHighAPI_Double theZCut1)

Set Z cut no.1.

◆ setZCut2()

void GDMLAPI_Ellipsoid::setZCut2 ( const ModelHighAPI_Double theZCut2)

Set Z cut no.2.

◆ dump()

void GDMLAPI_Ellipsoid::dump ( ModelHighAPI_Dumper theDumper) const
virtual

Dump wrapped feature.

Reimplemented from ModelHighAPI_Interface.

◆ feature()

std::shared_ptr< ModelAPI_Feature > ModelHighAPI_Interface::feature ( ) const
inherited

◆ subFeature()

std::shared_ptr< ModelHighAPI_Interface > ModelHighAPI_Interface::subFeature ( const int  theIndex) const
inherited

If feature is composite return intefrace for sub-feature by zero-based index, or empty pointer if feature not composite or does not have sub-feature with such index.

◆ getKind()

const std::string & ModelHighAPI_Interface::getKind ( ) const
inherited

Shortcut for feature()->getKind()

◆ execute()

void ModelHighAPI_Interface::execute ( bool  isForce = false)
inherited

Shortcut for feature()->execute()

Parameters
isForcestart execution of feature instead of sending events

◆ setName()

void ModelHighAPI_Interface::setName ( const std::wstring &  theName)
inherited

Shortcut for feature()->data()->setName()

◆ name()

std::wstring ModelHighAPI_Interface::name ( ) const
inherited

Shortcut for feature()->data()->name()

◆ result()

ModelHighAPI_Selection ModelHighAPI_Interface::result ( ) const
virtualinherited

Return firts object of the feature.

◆ results()

std::list< ModelHighAPI_Selection > ModelHighAPI_Interface::results ( ) const
virtualinherited

Return all objects of the feature.

◆ defaultResult()

std::shared_ptr< ModelAPI_Result > ModelHighAPI_Interface::defaultResult ( ) const
virtualinherited

Return default result. Default implementation feature()->lastResult()

◆ throwException()

void ModelHighAPI_Interface::throwException ( const std::string &  theDescription)
inherited

Throw exception to event loop.

◆ attributeGetter()

const std::string & ModelHighAPI_Interface::attributeGetter ( const std::string &  theAttrName)
inherited

Return name of getter for specified attribute.

Field Documentation

◆ myFeature

std::shared_ptr<ModelAPI_Feature> ModelHighAPI_Interface::myFeature
protectedinherited

feature of this interface

◆ myAttrGetter

std::map<std::string, std::string> ModelHighAPI_Interface::myAttrGetter
protectedinherited

names of attributes and their getters