Representation of STEP entity DocumentProductAssociation. More...

#include <StepBasic_DocumentProductAssociation.hxx>

Inheritance diagram for StepBasic_DocumentProductAssociation:

[legend]

Public Member Functions
	StepBasic_DocumentProductAssociation ()
	Empty constructor.

void	Init (const occ::handle< TCollection_HAsciiString > &aName, const bool hasDescription, const occ::handle< TCollection_HAsciiString > &aDescription, const occ::handle< StepBasic_Document > &aRelatingDocument, const StepBasic_ProductOrFormationOrDefinition &aRelatedProduct)
	Initialize all fields (own and inherited)

occ::handle< TCollection_HAsciiString >	Name () const
	Returns field Name.

void	SetName (const occ::handle< TCollection_HAsciiString > &Name)
	Set field Name.

occ::handle< TCollection_HAsciiString >	Description () const
	Returns field Description.

void	SetDescription (const occ::handle< TCollection_HAsciiString > &Description)
	Set field Description.

bool	HasDescription () const
	Returns True if optional field Description is defined.

occ::handle< StepBasic_Document >	RelatingDocument () const
	Returns field RelatingDocument.

void	SetRelatingDocument (const occ::handle< StepBasic_Document > &RelatingDocument)
	Set field RelatingDocument.

StepBasic_ProductOrFormationOrDefinition	RelatedProduct () const
	Returns field RelatedProduct.

void	SetRelatedProduct (const StepBasic_ProductOrFormationOrDefinition &RelatedProduct)
	Set field RelatedProduct.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

Representation of STEP entity DocumentProductAssociation.

Constructor & Destructor Documentation

◆ StepBasic_DocumentProductAssociation()

StepBasic_DocumentProductAssociation::StepBasic_DocumentProductAssociation ( )

Empty constructor.

Member Function Documentation

◆ Description()

occ::handle< TCollection_HAsciiString > StepBasic_DocumentProductAssociation::Description ( ) const

Returns field Description.

◆ HasDescription()

bool StepBasic_DocumentProductAssociation::HasDescription ( ) const

Returns True if optional field Description is defined.

◆ Init()

void StepBasic_DocumentProductAssociation::Init	(	const occ::handle< TCollection_HAsciiString > &	aName,
		const bool	hasDescription,
		const occ::handle< TCollection_HAsciiString > &	aDescription,
		const occ::handle< StepBasic_Document > &	aRelatingDocument,
		const StepBasic_ProductOrFormationOrDefinition &	aRelatedProduct )

Initialize all fields (own and inherited)

◆ Name()

occ::handle< TCollection_HAsciiString > StepBasic_DocumentProductAssociation::Name ( ) const

Returns field Name.

◆ RelatedProduct()

StepBasic_ProductOrFormationOrDefinition StepBasic_DocumentProductAssociation::RelatedProduct ( ) const

Returns field RelatedProduct.

◆ RelatingDocument()

occ::handle< StepBasic_Document > StepBasic_DocumentProductAssociation::RelatingDocument ( ) const

Returns field RelatingDocument.

◆ SetDescription()

void StepBasic_DocumentProductAssociation::SetDescription ( const occ::handle< TCollection_HAsciiString > & Description )

Set field Description.

◆ SetName()

void StepBasic_DocumentProductAssociation::SetName ( const occ::handle< TCollection_HAsciiString > & Name )

Set field Name.

◆ SetRelatedProduct()

void StepBasic_DocumentProductAssociation::SetRelatedProduct ( const StepBasic_ProductOrFormationOrDefinition & RelatedProduct )

Set field RelatedProduct.

◆ SetRelatingDocument()

void StepBasic_DocumentProductAssociation::SetRelatingDocument ( const occ::handle< StepBasic_Document > & RelatingDocument )

Set field RelatingDocument.

The documentation for this class was generated from the following file:

StepBasic_DocumentProductAssociation.hxx

Public Member Functions

Additional Inherited Members