SHAPER  9.12.0
CollectionAPI_Field Class Reference

\inField CPPHighAPI More...

Inheritance diagram for CollectionAPI_Field:
Inheritance graph

Public Member Functions

 CollectionAPI_Field (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 
virtual ~CollectionAPI_Field ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionListselection () const
 Field selection list. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringArraycomponentsNames () const
 Names of components list of strings. More...
 
virtual std::shared_ptr< ModelAPI_AttributeIntArraystamps () const
 Identifiers of stamps. More...
 
virtual std::shared_ptr< ModelAPI_AttributeTablesvalues () const
 
void setSelection (const std::list< ModelHighAPI_Selection > &theFieldList)
 Set selected objects. More...
 
void setComponentsNames (const std::list< std::string > &theNames)
 Set names of components. More...
 
void setValuesType (const std::string &theType)
 Set type of values. More...
 
void setStepsNum (const ModelHighAPI_Integer &theSteps)
 Set number of steps. More...
 
void setStamps (const std::list< ModelHighAPI_Integer > &theStamps)
 Set stamps identifiers. More...
 
void addStep (const ModelHighAPI_Integer &theStepNum, const ModelHighAPI_Integer &theStamp, const std::list< std::list< double > > &theComponents)
 Sets the double values of specific step. More...
 
void addStep (const ModelHighAPI_Integer &theStepNum, const ModelHighAPI_Integer &theStamp, const std::list< std::list< int > > &theComponents)
 Sets the integer values of specific step. More...
 
void addStep (const ModelHighAPI_Integer &theStepNum, const ModelHighAPI_Integer &theStamp, const std::list< std::list< std::string > > &theComponents)
 Sets the string values of specific step. More...
 
void addStep (const ModelHighAPI_Integer &theStepNum, const ModelHighAPI_Integer &theStamp, const std::list< std::list< bool > > &theComponents)
 Sets the boolean values of specific step. More...
 
virtual void dump (ModelHighAPI_Dumper &theDumper) const
 Dump wrapped feature. More...
 
std::shared_ptr< ModelAPI_AttributeTablestableValues ()
 Returns the internal values tables. 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_AttributeSelectionListmyselection
 
std::shared_ptr< ModelAPI_AttributeStringArraymycomponentsNames
 
std::shared_ptr< ModelAPI_AttributeIntArraymystamps
 
std::shared_ptr< ModelAPI_AttributeTablesmyvalues
 
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

\inField CPPHighAPI

Interface for Field feature.

Constructor & Destructor Documentation

◆ CollectionAPI_Field()

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

Constructor without values.

◆ ~CollectionAPI_Field()

CollectionAPI_Field::~CollectionAPI_Field ( )
virtual

Destructor.

Member Function Documentation

◆ selection()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList > CollectionAPI_Field::selection ( ) const
inlinevirtual

Field selection list.

◆ componentsNames()

virtual std::shared_ptr< ModelAPI_AttributeStringArray > CollectionAPI_Field::componentsNames ( ) const
inlinevirtual

Names of components list of strings.

◆ stamps()

virtual std::shared_ptr< ModelAPI_AttributeIntArray > CollectionAPI_Field::stamps ( ) const
inlinevirtual

Identifiers of stamps.

◆ initialize()

bool CollectionAPI_Field::initialize ( )
inlineprotected

Table of values

◆ setSelection()

void CollectionAPI_Field::setSelection ( const std::list< ModelHighAPI_Selection > &  theFieldList)

Set selected objects.

◆ setComponentsNames()

void CollectionAPI_Field::setComponentsNames ( const std::list< std::string > &  theNames)

Set names of components.

◆ setValuesType()

void CollectionAPI_Field::setValuesType ( const std::string &  theType)

Set type of values.

◆ setStepsNum()

void CollectionAPI_Field::setStepsNum ( const ModelHighAPI_Integer theSteps)

Set number of steps.

◆ setStamps()

void CollectionAPI_Field::setStamps ( const std::list< ModelHighAPI_Integer > &  theStamps)

Set stamps identifiers.

◆ addStep() [1/4]

void CollectionAPI_Field::addStep ( const ModelHighAPI_Integer theStepNum,
const ModelHighAPI_Integer theStamp,
const std::list< std::list< double > > &  theComponents 
)

Sets the double values of specific step.

◆ addStep() [2/4]

void CollectionAPI_Field::addStep ( const ModelHighAPI_Integer theStepNum,
const ModelHighAPI_Integer theStamp,
const std::list< std::list< int > > &  theComponents 
)

Sets the integer values of specific step.

◆ addStep() [3/4]

void CollectionAPI_Field::addStep ( const ModelHighAPI_Integer theStepNum,
const ModelHighAPI_Integer theStamp,
const std::list< std::list< std::string > > &  theComponents 
)

Sets the string values of specific step.

◆ addStep() [4/4]

void CollectionAPI_Field::addStep ( const ModelHighAPI_Integer theStepNum,
const ModelHighAPI_Integer theStamp,
const std::list< std::list< bool > > &  theComponents 
)

Sets the boolean values of specific step.

◆ dump()

void CollectionAPI_Field::dump ( ModelHighAPI_Dumper theDumper) const
virtual

Dump wrapped feature.

Reimplemented from ModelHighAPI_Interface.

◆ tableValues()

std::shared_ptr< ModelAPI_AttributeTables > CollectionAPI_Field::tableValues ( )

Returns the internal values tables.

◆ 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