SHAPER  9.12.0
Model_ResultField::Model_FieldStep Class Reference
Inheritance diagram for Model_ResultField::Model_FieldStep:
Inheritance graph

Public Member Functions

 Model_FieldStep (ModelAPI_ResultField *theParent, int theId)
 
virtual ModelAPI_ResultFieldfield () const
 
virtual int id () const
 
virtual std::shared_ptr< ModelAPI_Documentdocument () const
 Returns document this feature belongs to. More...
 
virtual std::wstring name ()
 Returns a GUI name of this step. More...
 
virtual std::string groupName ()
 Returns the group identifier of this object. More...
 
virtual void initAttributes ()
 Request for initialization of data model of the object: adding all attributes. More...
 
virtual bool isDisabled ()
 Returns the feature is disabled or not. More...
 
virtual bool isDisplayed ()
 Returns true if object must be displayed in the viewer: flag is stored in the data model, so on undo/redo, open/save or recreation of object by history-playing it keeps the original state in the current transaction. More...
 
virtual void setDisplayed (const bool theDisplay)
 Sets the displayed/hidden state of the object. More...
 
virtual bool isInHistory ()
 By default object is displayed in the object browser. More...
 
virtual void setInHistory (const std::shared_ptr< ModelAPI_Object > theObject, const bool theFlag)
 Makes object presented or not in the history of the created objects. More...
 
virtual std::shared_ptr< ModelAPI_Datadata () const
 Returns the data manager of this object: attributes. More...
 
virtual bool isSame (const std::shared_ptr< ModelAPI_Object > &theObject)
 Returns true if object refers to the same data model instance. More...
 
virtual void colorConfigInfo (std::string &, std::string &, std::string &)
 Returns the parameters of color definition in the resources config manager. More...
 
virtual void attributeChanged (const std::string &theID)
 Called on change of any argument-attribute of this object. More...
 
virtual bool hasTexture ()
 
virtual void emptyFunction () const
 Empty function which is added for virtualiation of the interface. More...
 

Static Public Member Functions

static std::string group ()
 Returns the group identifier of this result. More...
 

Protected Member Functions

virtual void init ()
 This method is called just after creation of the object: it must initialize all fields, normally initialized in the constructor. More...
 
virtual void setData (std::shared_ptr< ModelAPI_Data > theData)
 Sets the data manager of an object (document does) More...
 
virtual void setDoc (std::shared_ptr< ModelAPI_Document > theDoc)
 Sets the data manager of an object (document does) More...
 
virtual void erase ()
 removes all fields from this feature More...
 

Member Function Documentation

◆ document()

virtual std::shared_ptr<ModelAPI_Document> Model_ResultField::Model_FieldStep::document ( ) const
inlinevirtual

Returns document this feature belongs to.

Reimplemented from ModelAPI_Object.

◆ name()

std::wstring Model_ResultField::Model_FieldStep::name ( )
virtual

Returns a GUI name of this step.

Implements ModelAPI_ResultField::ModelAPI_FieldStep.

◆ group()

static std::string ModelAPI_ResultField::ModelAPI_FieldStep::group ( )
inlinestaticinherited

Returns the group identifier of this result.

◆ groupName()

virtual std::string ModelAPI_ResultField::ModelAPI_FieldStep::groupName ( )
inlinevirtualinherited

Returns the group identifier of this object.

Implements ModelAPI_Object.

◆ initAttributes()

virtual void ModelAPI_ResultField::ModelAPI_FieldStep::initAttributes ( )
inlinevirtualinherited

Request for initialization of data model of the object: adding all attributes.

Implements ModelAPI_Object.

◆ isDisabled()

virtual bool ModelAPI_ResultField::ModelAPI_FieldStep::isDisabled ( )
inlinevirtualinherited

Returns the feature is disabled or not.

Implements ModelAPI_Object.

◆ isDisplayed()

virtual bool ModelAPI_ResultField::ModelAPI_FieldStep::isDisplayed ( )
inlinevirtualinherited

Returns true if object must be displayed in the viewer: flag is stored in the data model, so on undo/redo, open/save or recreation of object by history-playing it keeps the original state in the current transaction.

Reimplemented from ModelAPI_Object.

◆ setDisplayed()

void ModelAPI_ResultField::ModelAPI_FieldStep::setDisplayed ( const bool  theDisplay)
virtualinherited

Sets the displayed/hidden state of the object.

If it is changed, sends the "redisplay" signal.

Reimplemented from ModelAPI_Object.

◆ init()

virtual void ModelAPI_ResultField::ModelAPI_FieldStep::init ( )
inlineprotectedvirtualinherited

This method is called just after creation of the object: it must initialize all fields, normally initialized in the constructor.

Implements ModelAPI_Object.

◆ isInHistory()

bool ModelAPI_Object::isInHistory ( )
virtualinherited

◆ setInHistory()

void ModelAPI_Object::setInHistory ( const std::shared_ptr< ModelAPI_Object theObject,
const bool  theFlag 
)
virtualinherited

Makes object presented or not in the history of the created objects.

Parameters
theObjectis shared pointer to "this"
theFlagis boolean value: to add or remove from the history

◆ data()

std::shared_ptr< ModelAPI_Data > ModelAPI_Object::data ( ) const
virtualinherited

Returns the data manager of this object: attributes.

◆ isSame()

bool ModelAPI_Object::isSame ( const std::shared_ptr< ModelAPI_Object > &  theObject)
virtualinherited

Returns true if object refers to the same data model instance.

◆ colorConfigInfo()

virtual void ModelAPI_Object::colorConfigInfo ( std::string &  ,
std::string &  ,
std::string &   
)
inlinevirtualinherited

◆ attributeChanged()

void ModelAPI_Object::attributeChanged ( const std::string &  theID)
virtualinherited

◆ setData()

void ModelAPI_Object::setData ( std::shared_ptr< ModelAPI_Data theData)
protectedvirtualinherited

Sets the data manager of an object (document does)

◆ setDoc()

void ModelAPI_Object::setDoc ( std::shared_ptr< ModelAPI_Document theDoc)
protectedvirtualinherited

Sets the data manager of an object (document does)

◆ erase()

void ModelAPI_Object::erase ( )
protectedvirtualinherited

◆ emptyFunction()

virtual void ModelAPI_Entity::emptyFunction ( ) const
inlinevirtualinherited

Empty function which is added for virtualiation of the interface.