C3D Toolkit  Kernel - 117982, Vision - 2.9.2.2

Topological name. More...

#include <attr_identifier.h>

+ Inheritance diagram for MbNameAttribute:
+ Collaboration diagram for MbNameAttribute:

Public Member Functions

 MbNameAttribute (bool isTemporal=false)
 Constructor.
 
 MbNameAttribute (const MbName &, bool isTemporal=false)
 Constructor.
 
 MbNameAttribute (const MbName &, const TCHAR *prompt, bool isTemporal=false)
 Constructor by name, description and temporary flag.
 
virtual ~MbNameAttribute ()
 Destructor.
 
MbeAttributeType AttributeType () const override
 Get subtype of an attribute.
 
MbAttributeDuplicate (MbRegDuplicate *=nullptr) const override
 Create a copy of the element.
 
bool IsSame (const MbAttribute &, double accuracy) const override
 Determine whether objects are equal. More...
 
bool Init (const MbAttribute &) override
 Initialize data.
 
void OnMergeOwner (const MbAttributeContainer &owner, MbAttributeContainer &other) override
 
const MbNameGetName () const
 Get name.
 
MbNameSetName ()
 Get name.
 
void SetName (const MbName &, bool deleteParentNames=true)
 Set name.
 
const c3d::string_tGetPrompt () const
 Get a prompt of attribute.
 
bool IsAnyParentName () const
 Determine whether at least one name of parent object exists.
 
size_t GetParentNamesCount () const
 Get the number of parent names of the first level.
 
void DeleteParentNames ()
 Delete names of parent objects.
 
bool DeleteParentName (const MbName &)
 Delete the name of a parent object.
 
bool AddParentName (const MbName &, bool isTemporal=false)
 Add a name of parent object.
 
bool AddParentName (const MbName &, const TCHAR *prompt, bool isTemporal=false)
 Add name and description of parent object.
 
bool AddParentNames (const MbNameAttribute &, double accuracy)
 Add names of parent objects.
 
void GetParentNames (c3d::ConstNamesVector &names, c3d::StringTVector *prompts=nullptr) const
 Get names and descriptions of parent objects. More...
 
void GetProperties (MbProperties &) override
 Get properties of the object.
 
size_t SetProperties (const MbProperties &) override
 Set properties of object.
 
MbePrompt GetPropertyName () override
 Get a name of object property.
 
- Public Member Functions inherited from MbElementaryAttribute
MbeAttributeType AttributeFamily () const override
 Get attribute type.
 
void OnChangeOwner (const MbAttributeContainer &owner) override
 Perform actions which are not associated with other actions when changing the owner. More...
 
void OnConvertOwner (const MbAttributeContainer &owner, MbAttributeContainer &other) override
 
void OnTransformOwner (const MbAttributeContainer &owner, const MbMatrix3D &, MbRegTransform *=nullptr) override
 Actions when transforming the owner.
 
void OnMoveOwner (const MbAttributeContainer &owner, const MbVector3D &, MbRegTransform *=nullptr) override
 
void OnRotateOwner (const MbAttributeContainer &owner, const MbAxis3D &, double angle, MbRegTransform *=nullptr) override
 
void OnCopyOwner (const MbAttributeContainer &owner, MbAttributeContainer &other, MbRegDuplicate *=nullptr) override
 
void OnReplaceOwner (const MbAttributeContainer &owner, MbAttributeContainer &other) override
 
void OnSplitOwner (const MbAttributeContainer &owner, const std::vector< MbAttributeContainer * > &others) override
 
void OnDeleteOwner (const MbAttributeContainer &owner) override
 
- Public Member Functions inherited from MbAttribute
virtual ~MbAttribute ()
 Destructor.
 
OnChangeOwnerAction GetActionForChange () const
 Get behavior of attribute when changing the owner.
 
OnConvertOwnerAction GetActionForConvert () const
 Get behavior of attribute when converting the owner.
 
OnTransformOwnerAction GetActionForTransform () const
 Get behavior of attribute when transforming the owner.
 
OnCopyOwnerAction GetActionForCopy () const
 Get behavior of attribute when copying the owner.
 
OnMergeOwnerAction GetActionForMerge () const
 Get behavior of attribute when merging the owner.
 
OnReplaceOwnerAction GetActionForReplace () const
 Get behavior of attribute when replacing the owner.
 
OnSplitOwnerAction GetActionForSplit () const
 Get behavior of attribute when splitting the owner.
 
OnDeleteOwnerAction GetActionForDelete () const
 Get behavior of attribute when deleting the owner.
 
void SetActionForChange (OnChangeOwnerAction a)
 Set behavior of attribute when changing the owner.
 
void SetActionForConvert (OnConvertOwnerAction a)
 Set behavior of attribute when converting the owner.
 
void SetActionForTransform (OnTransformOwnerAction a)
 Set behavior of attribute when transforming the owner.
 
void SetActionForCopy (OnCopyOwnerAction a)
 Set behavior of attribute when copying the owner.
 
void SetActionForMerge (OnMergeOwnerAction a)
 Set behavior of attribute when merging the owner.
 
void SetActionForReplace (OnReplaceOwnerAction a)
 Set behavior of attribute when replacing the owner.
 
void SetActionForSplit (OnSplitOwnerAction a)
 Set behavior of attribute when splitting the owner.
 
void SetActionForDelete (OnDeleteOwnerAction a)
 Set behavior of attribute when deleting the owner.
 
void InitActions (const MbAttribute &)
 Define behavior of an attribute by another attribute.
 
bool IsFamilyRegistrable () const override
 Whether the object belongs to a registrable family.
 
MbeRefType RefType () const override
 Get registrational type (for copying, duplication)
 
virtual MbeImplicationType ImplicationType () const
 Get attribute container type.
 
bool IsA (MbeAttributeType t) const
 Check an attribute type.
 
- Public Member Functions inherited from MbRefItem
refcount_t GetUseCount () const
 Get count of references (get count of owners of an object).
 
refcount_t AddRef () const
 Increase count of references by one.
 
refcount_t DecRef () const
 Decrease count of references by one.
 
refcount_t Release () const
 Decrease count of references by one and if count of references became zero, then remove itself.
 
- Public Member Functions inherited from TapeBase
 TapeBase (RegistrableRec regs=noRegistrable)
 Constructor.
 
 TapeBase (const TapeBase &)
 Copy-constructor.
 
virtual ~TapeBase ()
 Destructor.
 
RegistrableRec GetRegistrable () const
 Whether the stream class is registrable.
 
void SetRegistrable (RegistrableRec regs=registrable) const
 Set the state of registration of the stream class.
 
virtual const char * GetPureName (const VersionContainer &) const
 Get the class name.
 

Protected Member Functions

 MbNameAttribute (const MbNameAttribute &)
 Copy constructor.
 
- Protected Member Functions inherited from MbAttribute
 MbAttribute ()
 Constructor without parameters for inheritors.
 
 MbAttribute (const MbAttribute &)
 Copy constructor for inheritors.
 
- Protected Member Functions inherited from MbRefItem
 MbRefItem ()
 Constructor without parameters.
 

Protected Attributes

MbName tName
 A name of a topological object.
 

Additional Inherited Members

- Public Types inherited from MbAttribute
enum  OnChangeOwnerAction { chn_Self = 0 , chn_Free , chn_Keep , chn_ActCount }
 
enum  OnConvertOwnerAction {
  cnv_Self = 0 , cnv_Free , cnv_Keep , cnv_Copy ,
  cnv_Convert , cnv_ActCount
}
 
enum  OnTransformOwnerAction { trn_Self = 0 , trn_Free , trn_Keep , trn_ActCount }
 
enum  OnCopyOwnerAction {
  cpy_Self = 0 , cpy_Free , cpy_Keep , cpy_Copy ,
  cpy_ActCount
}
 
enum  OnMergeOwnerAction {
  mrg_Self = 0 , mrg_Free , mrg_Keep , mrg_KeepAll ,
  mrg_KeepRep , mrg_ActCount
}
 
enum  OnReplaceOwnerAction {
  rep_Self = 0 , rep_Free , rep_Keep , rep_KeepAll ,
  rep_KeepRep , rep_ActCount
}
 
enum  OnSplitOwnerAction {
  spl_Self = 0 , spl_Free , spl_Keep , spl_Copy ,
  spl_ActCount
}
 
enum  OnDeleteOwnerAction { del_Self = 0 , del_Free , del_ActCount }
 

Detailed Description

Topological name.

Topological name.

Member Function Documentation

◆ IsSame()

bool MbNameAttribute::IsSame ( const MbAttribute item,
double  accuracy 
) const
overridevirtual

Determine whether objects are equal.

Objects of the same types with similar (equal) data are considered to be equal.

Parameters
[in]item- Objects for comparison.
[in]accuracy- The accuracy to compare.
Returns
Whether objects are equal.

Implements MbAttribute.

◆ OnMergeOwner()

void MbNameAttribute::OnMergeOwner ( const MbAttributeContainer owner,
MbAttributeContainer other 
)
overridevirtual

Perform actions when merging the owner.
This function is called before merging the owner in a case when GetActionForMerge() == mrg_Self.
The object which will be absorbed is passed as input parameter.

Reimplemented from MbElementaryAttribute.

◆ GetParentNames()

void MbNameAttribute::GetParentNames ( c3d::ConstNamesVector &  names,
c3d::StringTVector *  prompts = nullptr 
) const

Get names and descriptions of parent objects.

Whether this attribute is temporary.


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