API for the attribute that contains several integers in the array inside. More...

Inheritance diagram for Model_AttributeIntArray:

Public Member Functions
virtual MODEL_EXPORT int	size ()
	Returns the size of the array (zero means that it is empty) More...

virtual MODEL_EXPORT void	setSize (const int theSize, bool sendUpdated=true)
	Sets the new size of the array. The previous data is erased. More...

virtual MODEL_EXPORT void	setValue (const int theIndex, const int theValue, bool sendUpdated=true)
	Defines the value of the array by index [0; size-1]. More...

virtual MODEL_EXPORT int	value (const int theIndex)
	Returns the value by the index. More...

virtual MODELAPI_EXPORT std::string	attributeType ()
	Returns the type of this class of attributes, not static method. More...

virtual void	setObject (const std::shared_ptr< ModelAPI_Object > &theObject)
	Sets the owner of this attribute. More...

const std::shared_ptr< ModelAPI_Object > &	owner () const
	Returns the owner of this attribute. More...

virtual bool	isInitialized ()
	Returns true if attribute was initialized by some value. More...

void	setInitialized ()
	Makes attribute initialized. More...

bool	blockSetInitialized (const bool theBlock)
	Blocks sending "attribute updated" if theBlock is true. More...

void	setIsArgument (const bool theFlag)
	Set this attribute is argument for result (change of this attribute requires update of result). More...

bool	isArgument ()
	Returns true if attribute causes the result change. More...

bool	setImmutable (const bool theFlag)
	Immutable argument can not be changed programmatically (e.g. More...

bool	isImmutable ()
	Returns true if can not be changed programmatically. More...

const std::string &	id () const
	ID of the attribute in Data. More...

virtual void	reset ()
	Resets attribute to default state. More...

Static Public Member Functions
static MODELAPI_EXPORT std::string	typeId ()
	Returns the type of this class of attributes. More...

Protected Member Functions
	Model_AttributeIntArray (TDF_Label &theLabel)
	Initializes attributes. More...

virtual void	reinit ()
	Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc) More...

virtual void	setID (const std::string theID)
	Sets the ID of the attribute in Data (called from Data) More...

Protected Attributes
bool	myIsInitialized
	is some value assigned to this attribute More...

bool	mySetInitializedBlocked
	is initialized blocked More...

bool	myIsArgument
	is this attribute used as an argument for execution More...

bool	myIsImmutable
	is this attribute can be changed programmatically (e.g. by constraint) More...

Friends
class	Model_Data

Detailed Description

API for the attribute that contains several integers in the array inside.

Used for RGB color storage for an example. By default size is one, zero-based. Represented as array in OCCT. Empty array means that this attribute does not exists.

Constructor & Destructor Documentation

◆ Model_AttributeIntArray()

Model_AttributeIntArray::Model_AttributeIntArray ( TDF_Label & theLabel )

protected

Initializes attributes.

Member Function Documentation

◆ size()

int Model_AttributeIntArray::size ( )

virtual

Returns the size of the array (zero means that it is empty)

Implements ModelAPI_AttributeIntArray.

◆ setSize()

void Model_AttributeIntArray::setSize	(	const int	theSize,
		bool	sendUpdated = `true`
	)

virtual

Sets the new size of the array. The previous data is erased.

Implements ModelAPI_AttributeIntArray.

◆ setValue()

void Model_AttributeIntArray::setValue	(	const int	theIndex,
		const int	theValue,
		bool	sendUpdated = `true`
	)

virtual

Defines the value of the array by index [0; size-1].

Implements ModelAPI_AttributeIntArray.

◆ value()

int Model_AttributeIntArray::value ( const int theIndex )

virtual

Returns the value by the index.

Implements ModelAPI_AttributeIntArray.

◆ reinit()

void Model_AttributeIntArray::reinit ( )

protectedvirtual

Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)

Reimplemented from ModelAPI_Attribute.

◆ typeId()

static MODELAPI_EXPORT std::string ModelAPI_AttributeIntArray::typeId ( )

inlinestaticinherited

Returns the type of this class of attributes.

◆ attributeType()

std::string ModelAPI_AttributeIntArray::attributeType ( )

virtualinherited

Returns the type of this class of attributes, not static method.

Implements ModelAPI_Attribute.

◆ setObject()

void ModelAPI_Attribute::setObject ( const std::shared_ptr< ModelAPI_Object > & theObject )

virtualinherited

Sets the owner of this attribute.

Reimplemented in Model_AttributeSelection, and Model_AttributeReference.

◆ owner()

const std::shared_ptr< ModelAPI_Object > & ModelAPI_Attribute::owner ( ) const

inherited

Returns the owner of this attribute.

◆ isInitialized()

bool ModelAPI_Attribute::isInitialized ( )

virtualinherited

Returns true if attribute was initialized by some value.

Reimplemented in Model_AttributeSelectionList, Model_AttributeSelection, Model_AttributeRefList, Model_AttributeReference, Model_AttributeRefAttrList, Model_AttributeRefAttr, and GeomData_Dir.

◆ setInitialized()

void ModelAPI_Attribute::setInitialized ( )

inherited

Makes attribute initialized.

◆ blockSetInitialized()

bool ModelAPI_Attribute::blockSetInitialized ( const bool theBlock )

inherited

Blocks sending "attribute updated" if theBlock is true.

Parameters

theBlock a block value

Returns: the previous block value

◆ setIsArgument()

void ModelAPI_Attribute::setIsArgument ( const bool theFlag )

inherited

Set this attribute is argument for result (change of this attribute requires update of result).

By default it is true.

◆ isArgument()

bool ModelAPI_Attribute::isArgument ( )

inherited

Returns true if attribute causes the result change.

◆ setImmutable()

bool ModelAPI_Attribute::setImmutable ( const bool theFlag )

inherited

Immutable argument can not be changed programmatically (e.g.

by constraint) By default it is false. Returns the previous state of the attribute's immutability.

◆ isImmutable()

bool ModelAPI_Attribute::isImmutable ( )

inherited

Returns true if can not be changed programmatically.

◆ id()

const std::string & ModelAPI_Attribute::id ( ) const

inherited

ID of the attribute in Data.

◆ reset()

void ModelAPI_Attribute::reset ( )

virtualinherited

Resets attribute to default state.

Reimplemented in Model_AttributeSelection, Model_AttributeDouble, GeomData_Point2D, and GeomData_Dir.

◆ setID()

void ModelAPI_Attribute::setID ( const std::string theID )

protectedvirtualinherited

Sets the ID of the attribute in Data (called from Data)

Reimplemented in Model_AttributeSelection.

Field Documentation

◆ myIsInitialized

bool ModelAPI_Attribute::myIsInitialized

protectedinherited

is some value assigned to this attribute

◆ mySetInitializedBlocked

bool ModelAPI_Attribute::mySetInitializedBlocked

protectedinherited

is initialized blocked

◆ myIsArgument

bool ModelAPI_Attribute::myIsArgument

protectedinherited

is this attribute used as an argument for execution

◆ myIsImmutable

bool ModelAPI_Attribute::myIsImmutable

protectedinherited

is this attribute can be changed programmatically (e.g. by constraint)

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Model_AttributeIntArray()

Member Function Documentation

◆ size()

◆ setSize()

◆ setValue()

◆ value()

◆ reinit()

◆ typeId()

◆ attributeType()

◆ setObject()

◆ owner()

◆ isInitialized()

◆ setInitialized()

◆ blockSetInitialized()

◆ setIsArgument()

◆ isArgument()

◆ setImmutable()

◆ isImmutable()

◆ id()

◆ reset()

◆ setID()

Field Documentation

◆ myIsInitialized

◆ mySetInitializedBlocked

◆ myIsArgument

◆ myIsImmutable