\inField CPPHighAPI More...

Inheritance diagram for CollectionAPI_Field:

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_AttributeSelectionList >	selection () const
	Field selection list. More...

virtual std::shared_ptr< ModelAPI_AttributeStringArray >	componentsNames () const
	Names of components list of strings. More...

virtual std::shared_ptr< ModelAPI_AttributeIntArray >	stamps () const
	Identifiers of stamps. More...

virtual std::shared_ptr< ModelAPI_AttributeTables >	values () 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_AttributeTables >	tableValues ()
	Returns the internal values tables. More...

std::shared_ptr< ModelAPI_Feature >	feature () const
	Return ModelAPI_Feature. More...

std::shared_ptr< ModelHighAPI_Interface >	subFeature (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_Selection >	results () const
	Return all objects of the feature. More...

virtual std::shared_ptr< ModelAPI_Result >	defaultResult () 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...

virtual ListOfShape	vertices (const bool theOnlyUnique=false)
	Returns all the vertices produced by this feature. More...

virtual ListOfShape	edges (const bool theOnlyUnique=false)
	Returns all the edges produced by this feature. More...

virtual ListOfShape	wires (const bool theOnlyUnique=false)
	Returns all the wires produced by this feature. More...

virtual ListOfShape	faces (const bool theOnlyUnique=false)
	Returns all the faces produced by this feature. More...

virtual ListOfShape	shells (const bool theOnlyUnique=false)
	Returns all the shells produced by this feature. More...

virtual ListOfShape	solids (const bool theOnlyUnique=false)
	Returns all the solids produced by this feature. More...

Static Public Member Functions
static std::string	ID ()

Protected Member Functions
bool	initialize ()

Protected Attributes
std::shared_ptr< ModelAPI_AttributeSelectionList >	myselection

std::shared_ptr< ModelAPI_AttributeStringArray >	mycomponentsNames

std::shared_ptr< ModelAPI_AttributeIntArray >	mystamps

std::shared_ptr< ModelAPI_AttributeTables >	myvalues

std::shared_ptr< ModelAPI_Feature >	myFeature
	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

Return ModelAPI_Feature.

◆ 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

isForce start 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.

◆ vertices()

ListOfShape ModelHighAPI_Interface::vertices ( const bool theOnlyUnique = false )

virtualinherited

Returns all the vertices produced by this feature.

◆ edges()

ListOfShape ModelHighAPI_Interface::edges ( const bool theOnlyUnique = false )

virtualinherited

Returns all the edges produced by this feature.

◆ wires()

ListOfShape ModelHighAPI_Interface::wires ( const bool theOnlyUnique = false )

virtualinherited

Returns all the wires produced by this feature.

◆ faces()

ListOfShape ModelHighAPI_Interface::faces ( const bool theOnlyUnique = false )

virtualinherited

Returns all the faces produced by this feature.

◆ shells()

ListOfShape ModelHighAPI_Interface::shells ( const bool theOnlyUnique = false )

virtualinherited

Returns all the shells produced by this feature.

◆ solids()

ListOfShape ModelHighAPI_Interface::solids ( const bool theOnlyUnique = false )

virtualinherited

Returns all the solids produced by this feature.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CollectionAPI_Field()

◆ ~CollectionAPI_Field()

Member Function Documentation

◆ selection()

◆ componentsNames()

◆ stamps()

◆ initialize()

◆ setSelection()

◆ setComponentsNames()

◆ setValuesType()

◆ setStepsNum()

◆ setStamps()

◆ addStep() [1/4]

◆ addStep() [2/4]

◆ addStep() [3/4]

◆ addStep() [4/4]

◆ dump()

◆ tableValues()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

Field Documentation

◆ myFeature

◆ myAttrGetter