Class XCAFDoc_NotesTool

Hierarchy

TDataStd_GenericEmpty
- XCAFDoc_NotesTool

Index

Constructors

constructor

Methods

Constructors

constructor

new XCAFDoc_NotesTool(): XCAFDoc_NotesTool

Overrides TDataStd_GenericEmpty.constructor
Returns XCAFDoc_NotesTool

Methods

AddAttribute

AddAttribute(other: Handle_TDF_Attribute): void

Inherited from TDataStd_GenericEmpty.AddAttribute
Parameters
- other: Handle_TDF_Attribute
Returns void

AddNoteToAttr_1

AddNoteToAttr_1(theNoteLabel: TDF_Label, theItemId: XCAFDoc_AssemblyItemId, theGUID: Standard_GUID): Handle_XCAFDoc_AssemblyItemRef

Parameters
- theNoteLabel: TDF_Label
- theItemId: XCAFDoc_AssemblyItemId
- theGUID: Standard_GUID
Returns Handle_XCAFDoc_AssemblyItemRef

AddNoteToAttr_2

AddNoteToAttr_2(theNoteLabel: TDF_Label, theItemLabel: TDF_Label, theGUID: Standard_GUID): Handle_XCAFDoc_AssemblyItemRef

Parameters
- theNoteLabel: TDF_Label
- theItemLabel: TDF_Label
- theGUID: Standard_GUID
Returns Handle_XCAFDoc_AssemblyItemRef

AddNoteToSubshape_1

AddNoteToSubshape_1(theNoteLabel: TDF_Label, theItemId: XCAFDoc_AssemblyItemId, theSubshapeIndex: Graphic3d_ZLayerId): Handle_XCAFDoc_AssemblyItemRef

Parameters
- theNoteLabel: TDF_Label
- theItemId: XCAFDoc_AssemblyItemId
- theSubshapeIndex: Graphic3d_ZLayerId
Returns Handle_XCAFDoc_AssemblyItemRef

AddNoteToSubshape_2

AddNoteToSubshape_2(theNoteLabel: TDF_Label, theItemLabel: TDF_Label, theSubshapeIndex: Graphic3d_ZLayerId): Handle_XCAFDoc_AssemblyItemRef

Parameters
- theNoteLabel: TDF_Label
- theItemLabel: TDF_Label
- theSubshapeIndex: Graphic3d_ZLayerId
Returns Handle_XCAFDoc_AssemblyItemRef

AddNote_1

AddNote_1(theNoteLabel: TDF_Label, theItemId: XCAFDoc_AssemblyItemId): Handle_XCAFDoc_AssemblyItemRef

Parameters
- theNoteLabel: TDF_Label
- theItemId: XCAFDoc_AssemblyItemId
Returns Handle_XCAFDoc_AssemblyItemRef

AddNote_2

AddNote_2(theNoteLabel: TDF_Label, theItemLabel: TDF_Label): Handle_XCAFDoc_AssemblyItemRef

Parameters
- theNoteLabel: TDF_Label
- theItemLabel: TDF_Label
Returns Handle_XCAFDoc_AssemblyItemRef

AfterAddition

AfterAddition(): void

Inherited from TDataStd_GenericEmpty.AfterAddition
Returns void

AfterResume

AfterResume(): void

Inherited from TDataStd_GenericEmpty.AfterResume
Returns void

AfterRetrieval

AfterRetrieval(forceIt: boolean): boolean

Inherited from TDataStd_GenericEmpty.AfterRetrieval
Parameters
- forceIt: boolean
Returns boolean

AfterUndo

AfterUndo(anAttDelta: Handle_TDF_AttributeDelta, forceIt: boolean): boolean

Inherited from TDataStd_GenericEmpty.AfterUndo
Parameters
- anAttDelta: Handle_TDF_AttributeDelta
- forceIt: boolean
Returns boolean

BackupCopy

BackupCopy(): Handle_TDF_Attribute

Inherited from TDataStd_GenericEmpty.BackupCopy
Returns Handle_TDF_Attribute

Backup_1

Backup_1(): void

Inherited from TDataStd_GenericEmpty.Backup_1
Returns void

BeforeCommitTransaction

BeforeCommitTransaction(): void

Inherited from TDataStd_GenericEmpty.BeforeCommitTransaction
Returns void

BeforeForget

BeforeForget(): void

Inherited from TDataStd_GenericEmpty.BeforeForget
Returns void

BeforeRemoval

BeforeRemoval(): void

Inherited from TDataStd_GenericEmpty.BeforeRemoval
Returns void

BeforeUndo

BeforeUndo(anAttDelta: Handle_TDF_AttributeDelta, forceIt: boolean): boolean

Inherited from TDataStd_GenericEmpty.BeforeUndo
Parameters
- anAttDelta: Handle_TDF_AttributeDelta
- forceIt: boolean
Returns boolean

CreateBalloon

CreateBalloon(theUserName: TCollection_ExtendedString, theTimeStamp: TCollection_ExtendedString, theComment: TCollection_ExtendedString): Handle_XCAFDoc_Note

Parameters
- theUserName: TCollection_ExtendedString
- theTimeStamp: TCollection_ExtendedString
- theComment: TCollection_ExtendedString
Returns Handle_XCAFDoc_Note

CreateBinData_1

CreateBinData_1(theUserName: TCollection_ExtendedString, theTimeStamp: TCollection_ExtendedString, theTitle: TCollection_ExtendedString, theMIMEtype: XCAFDoc_PartId, theFile: OSD_File): Handle_XCAFDoc_Note

Parameters
- theUserName: TCollection_ExtendedString
- theTimeStamp: TCollection_ExtendedString
- theTitle: TCollection_ExtendedString
- theMIMEtype: XCAFDoc_PartId
- theFile: OSD_File
Returns Handle_XCAFDoc_Note

CreateBinData_2

CreateBinData_2(theUserName: TCollection_ExtendedString, theTimeStamp: TCollection_ExtendedString, theTitle: TCollection_ExtendedString, theMIMEtype: XCAFDoc_PartId, theData: Handle_TColStd_HArray1OfByte): Handle_XCAFDoc_Note

Parameters
- theUserName: TCollection_ExtendedString
- theTimeStamp: TCollection_ExtendedString
- theTitle: TCollection_ExtendedString
- theMIMEtype: XCAFDoc_PartId
- theData: Handle_TColStd_HArray1OfByte
Returns Handle_XCAFDoc_Note

CreateComment

CreateComment(theUserName: TCollection_ExtendedString, theTimeStamp: TCollection_ExtendedString, theComment: TCollection_ExtendedString): Handle_XCAFDoc_Note

Parameters
- theUserName: TCollection_ExtendedString
- theTimeStamp: TCollection_ExtendedString
- theComment: TCollection_ExtendedString
Returns Handle_XCAFDoc_Note

DecrementRefCounter

DecrementRefCounter(): Graphic3d_ZLayerId

Inherited from TDataStd_GenericEmpty.DecrementRefCounter
Returns Graphic3d_ZLayerId

Delete

Delete(): void

Inherited from TDataStd_GenericEmpty.Delete
Returns void

DeleteAllNotes

DeleteAllNotes(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

DeleteNote

DeleteNote(theNoteLabel: TDF_Label): boolean

Parameters
- theNoteLabel: TDF_Label
Returns boolean

DeleteNotes

DeleteNotes(theNoteLabels: TDF_LabelSequence): Graphic3d_ZLayerId

Parameters
- theNoteLabels: TDF_LabelSequence
Returns Graphic3d_ZLayerId

DeleteOrphanNotes

DeleteOrphanNotes(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

DeltaOnAddition

DeltaOnAddition(): Handle_TDF_DeltaOnAddition

Inherited from TDataStd_GenericEmpty.DeltaOnAddition
Returns Handle_TDF_DeltaOnAddition

DeltaOnForget

DeltaOnForget(): Handle_TDF_DeltaOnForget

Inherited from TDataStd_GenericEmpty.DeltaOnForget
Returns Handle_TDF_DeltaOnForget

DeltaOnModification_1

DeltaOnModification_1(anOldAttribute: Handle_TDF_Attribute): Handle_TDF_DeltaOnModification

Inherited from TDataStd_GenericEmpty.DeltaOnModification_1
Parameters
- anOldAttribute: Handle_TDF_Attribute
Returns Handle_TDF_DeltaOnModification

DeltaOnModification_2

DeltaOnModification_2(aDelta: Handle_TDF_DeltaOnModification): void

Inherited from TDataStd_GenericEmpty.DeltaOnModification_2
Parameters
- aDelta: Handle_TDF_DeltaOnModification
Returns void

DeltaOnRemoval

DeltaOnRemoval(): Handle_TDF_DeltaOnRemoval

Inherited from TDataStd_GenericEmpty.DeltaOnRemoval
Returns Handle_TDF_DeltaOnRemoval

DeltaOnResume

DeltaOnResume(): Handle_TDF_DeltaOnResume

Inherited from TDataStd_GenericEmpty.DeltaOnResume
Returns Handle_TDF_DeltaOnResume

DumpJson

DumpJson(theOStream: Standard_OStream, theDepth: Graphic3d_ZLayerId): void

Inherited from TDataStd_GenericEmpty.DumpJson
Parameters
- theOStream: Standard_OStream
- theDepth: Graphic3d_ZLayerId
Returns void

DynamicType

DynamicType(): Handle_Standard_Type

Overrides TDataStd_GenericEmpty.DynamicType
Returns Handle_Standard_Type

ExtendedDump

ExtendedDump(anOS: Standard_OStream, aFilter: TDF_IDFilter, aMap: TDF_AttributeIndexedMap): void

Inherited from TDataStd_GenericEmpty.ExtendedDump
Parameters
- anOS: Standard_OStream
- aFilter: TDF_IDFilter
- aMap: TDF_AttributeIndexedMap
Returns void

FindAnnotatedItemAttr_1

FindAnnotatedItemAttr_1(theItemId: XCAFDoc_AssemblyItemId, theGUID: Standard_GUID): TDF_Label

Parameters
- theItemId: XCAFDoc_AssemblyItemId
- theGUID: Standard_GUID
Returns TDF_Label

FindAnnotatedItemAttr_2

FindAnnotatedItemAttr_2(theItemLabel: TDF_Label, theGUID: Standard_GUID): TDF_Label

Parameters
- theItemLabel: TDF_Label
- theGUID: Standard_GUID
Returns TDF_Label

FindAnnotatedItemSubshape_1

FindAnnotatedItemSubshape_1(theItemId: XCAFDoc_AssemblyItemId, theSubshapeIndex: Graphic3d_ZLayerId): TDF_Label

Parameters
- theItemId: XCAFDoc_AssemblyItemId
- theSubshapeIndex: Graphic3d_ZLayerId
Returns TDF_Label

FindAnnotatedItemSubshape_2

FindAnnotatedItemSubshape_2(theItemLabel: TDF_Label, theSubshapeIndex: Graphic3d_ZLayerId): TDF_Label

Parameters
- theItemLabel: TDF_Label
- theSubshapeIndex: Graphic3d_ZLayerId
Returns TDF_Label

FindAnnotatedItem_1

FindAnnotatedItem_1(theItemId: XCAFDoc_AssemblyItemId): TDF_Label

Parameters
- theItemId: XCAFDoc_AssemblyItemId
Returns TDF_Label

FindAnnotatedItem_2

FindAnnotatedItem_2(theItemLabel: TDF_Label): TDF_Label

Parameters
- theItemLabel: TDF_Label
Returns TDF_Label

FindAttribute_1

FindAttribute_1(anID: Standard_GUID, anAttribute: Handle_TDF_Attribute): boolean

Inherited from TDataStd_GenericEmpty.FindAttribute_1
Parameters
- anID: Standard_GUID
- anAttribute: Handle_TDF_Attribute
Returns boolean

Forget

Forget(aTransaction: Graphic3d_ZLayerId): void

Inherited from TDataStd_GenericEmpty.Forget
Parameters
- aTransaction: Graphic3d_ZLayerId
Returns void

ForgetAllAttributes

ForgetAllAttributes(clearChildren: boolean): void

Inherited from TDataStd_GenericEmpty.ForgetAllAttributes
Parameters
- clearChildren: boolean
Returns void

ForgetAttribute

ForgetAttribute(aguid: Standard_GUID): boolean

Inherited from TDataStd_GenericEmpty.ForgetAttribute
Parameters
- aguid: Standard_GUID
Returns boolean

GetAnnotatedItems

GetAnnotatedItems(theLabels: TDF_LabelSequence): void

Parameters
- theLabels: TDF_LabelSequence
Returns void

GetAnnotatedItemsLabel

GetAnnotatedItemsLabel(): TDF_Label

Returns TDF_Label

GetAttrNotes_1

GetAttrNotes_1(theItemId: XCAFDoc_AssemblyItemId, theGUID: Standard_GUID, theNoteLabels: TDF_LabelSequence): Graphic3d_ZLayerId

Parameters
- theItemId: XCAFDoc_AssemblyItemId
- theGUID: Standard_GUID
- theNoteLabels: TDF_LabelSequence
Returns Graphic3d_ZLayerId

GetAttrNotes_2

GetAttrNotes_2(theItemLabel: TDF_Label, theGUID: Standard_GUID, theNoteLabels: TDF_LabelSequence): Graphic3d_ZLayerId

Parameters
- theItemLabel: TDF_Label
- theGUID: Standard_GUID
- theNoteLabels: TDF_LabelSequence
Returns Graphic3d_ZLayerId

GetNotesLabel

GetNotesLabel(): TDF_Label

Returns TDF_Label

GetNotes_1

GetNotes_1(theNoteLabels: TDF_LabelSequence): void

Parameters
- theNoteLabels: TDF_LabelSequence
Returns void

GetNotes_2

GetNotes_2(theItemId: XCAFDoc_AssemblyItemId, theNoteLabels: TDF_LabelSequence): Graphic3d_ZLayerId

Parameters
- theItemId: XCAFDoc_AssemblyItemId
- theNoteLabels: TDF_LabelSequence
Returns Graphic3d_ZLayerId

GetNotes_3

GetNotes_3(theItemLabel: TDF_Label, theNoteLabels: TDF_LabelSequence): Graphic3d_ZLayerId

Parameters
- theItemLabel: TDF_Label
- theNoteLabels: TDF_LabelSequence
Returns Graphic3d_ZLayerId

GetOrphanNotes

GetOrphanNotes(theNoteLabels: TDF_LabelSequence): void

Parameters
- theNoteLabels: TDF_LabelSequence
Returns void

GetRefCount

GetRefCount(): Graphic3d_ZLayerId

Inherited from TDataStd_GenericEmpty.GetRefCount
Returns Graphic3d_ZLayerId

GetSubshapeNotes

GetSubshapeNotes(theItemId: XCAFDoc_AssemblyItemId, theSubshapeIndex: Graphic3d_ZLayerId, theNoteLabels: TDF_LabelSequence): Graphic3d_ZLayerId

Parameters
- theItemId: XCAFDoc_AssemblyItemId
- theSubshapeIndex: Graphic3d_ZLayerId
- theNoteLabels: TDF_LabelSequence
Returns Graphic3d_ZLayerId

ID

ID(): Standard_GUID

Overrides TDataStd_GenericEmpty.ID
Returns Standard_GUID

IncrementRefCounter

IncrementRefCounter(): void

Inherited from TDataStd_GenericEmpty.IncrementRefCounter
Returns void

IsAnnotatedItem_1

IsAnnotatedItem_1(theItemId: XCAFDoc_AssemblyItemId): boolean

Parameters
- theItemId: XCAFDoc_AssemblyItemId
Returns boolean

IsAnnotatedItem_2

IsAnnotatedItem_2(theItemLabel: TDF_Label): boolean

Parameters
- theItemLabel: TDF_Label
Returns boolean

IsAttribute

IsAttribute(anID: Standard_GUID): boolean

Inherited from TDataStd_GenericEmpty.IsAttribute
Parameters
- anID: Standard_GUID
Returns boolean

IsBackuped

IsBackuped(): boolean

Inherited from TDataStd_GenericEmpty.IsBackuped
Returns boolean

IsForgotten

IsForgotten(): boolean

Inherited from TDataStd_GenericEmpty.IsForgotten
Returns boolean

IsInstance_1

IsInstance_1(theType: Handle_Standard_Type): boolean

Inherited from TDataStd_GenericEmpty.IsInstance_1
Parameters
- theType: Handle_Standard_Type
Returns boolean

IsInstance_2

IsInstance_2(theTypeName: string): boolean

Inherited from TDataStd_GenericEmpty.IsInstance_2
Parameters
- theTypeName: string
Returns boolean

IsKind_1

IsKind_1(theType: Handle_Standard_Type): boolean

Inherited from TDataStd_GenericEmpty.IsKind_1
Parameters
- theType: Handle_Standard_Type
Returns boolean

IsKind_2

IsKind_2(theTypeName: string): boolean

Inherited from TDataStd_GenericEmpty.IsKind_2
Parameters
- theTypeName: string
Returns boolean

IsNew

IsNew(): boolean

Inherited from TDataStd_GenericEmpty.IsNew
Returns boolean

IsValid

IsValid(): boolean

Inherited from TDataStd_GenericEmpty.IsValid
Returns boolean

Label

Label(): TDF_Label

Inherited from TDataStd_GenericEmpty.Label
Returns TDF_Label

NbAnnotatedItems

NbAnnotatedItems(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

NbNotes

NbNotes(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

NbOrphanNotes

NbOrphanNotes(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

NewEmpty

NewEmpty(): Handle_TDF_Attribute

Overrides TDataStd_GenericEmpty.NewEmpty
Returns Handle_TDF_Attribute

Paste

Paste(a0: Handle_TDF_Attribute, a1: Handle_TDF_RelocationTable): void

Inherited from TDataStd_GenericEmpty.Paste
Parameters
- a0: Handle_TDF_Attribute
- a1: Handle_TDF_RelocationTable
Returns void

References

References(aDataSet: Handle_TDF_DataSet): void

Inherited from TDataStd_GenericEmpty.References
Parameters
- aDataSet: Handle_TDF_DataSet
Returns void

RemoveAllAttrNotes_1

RemoveAllAttrNotes_1(theItemId: XCAFDoc_AssemblyItemId, theGUID: Standard_GUID, theDelIfOrphan: boolean): boolean

Parameters
- theItemId: XCAFDoc_AssemblyItemId
- theGUID: Standard_GUID
- theDelIfOrphan: boolean
Returns boolean

RemoveAllAttrNotes_2

RemoveAllAttrNotes_2(theItemLabel: TDF_Label, theGUID: Standard_GUID, theDelIfOrphan: boolean): boolean

Parameters
- theItemLabel: TDF_Label
- theGUID: Standard_GUID
- theDelIfOrphan: boolean
Returns boolean

RemoveAllNotes_1

RemoveAllNotes_1(theItemId: XCAFDoc_AssemblyItemId, theDelIfOrphan: boolean): boolean

Parameters
- theItemId: XCAFDoc_AssemblyItemId
- theDelIfOrphan: boolean
Returns boolean

RemoveAllNotes_2

RemoveAllNotes_2(theItemLabel: TDF_Label, theDelIfOrphan: boolean): boolean

Parameters
- theItemLabel: TDF_Label
- theDelIfOrphan: boolean
Returns boolean

RemoveAllSubshapeNotes

RemoveAllSubshapeNotes(theItemId: XCAFDoc_AssemblyItemId, theSubshapeIndex: Graphic3d_ZLayerId, theDelIfOrphan: boolean): boolean

Parameters
- theItemId: XCAFDoc_AssemblyItemId
- theSubshapeIndex: Graphic3d_ZLayerId
- theDelIfOrphan: boolean
Returns boolean

RemoveAttrNote_1

RemoveAttrNote_1(theNoteLabel: TDF_Label, theItemId: XCAFDoc_AssemblyItemId, theGUID: Standard_GUID, theDelIfOrphan: boolean): boolean

Parameters
- theNoteLabel: TDF_Label
- theItemId: XCAFDoc_AssemblyItemId
- theGUID: Standard_GUID
- theDelIfOrphan: boolean
Returns boolean

RemoveAttrNote_2

RemoveAttrNote_2(theNoteLabel: TDF_Label, theItemLabel: TDF_Label, theGUID: Standard_GUID, theDelIfOrphan: boolean): boolean

Parameters
- theNoteLabel: TDF_Label
- theItemLabel: TDF_Label
- theGUID: Standard_GUID
- theDelIfOrphan: boolean
Returns boolean

RemoveNote_1

RemoveNote_1(theNoteLabel: TDF_Label, theItemId: XCAFDoc_AssemblyItemId, theDelIfOrphan: boolean): boolean

Parameters
- theNoteLabel: TDF_Label
- theItemId: XCAFDoc_AssemblyItemId
- theDelIfOrphan: boolean
Returns boolean

RemoveNote_2

RemoveNote_2(theNoteLabel: TDF_Label, theItemLabel: TDF_Label, theDelIfOrphan: boolean): boolean

Parameters
- theNoteLabel: TDF_Label
- theItemLabel: TDF_Label
- theDelIfOrphan: boolean
Returns boolean

RemoveSubshapeNote_1

RemoveSubshapeNote_1(theNoteLabel: TDF_Label, theItemId: XCAFDoc_AssemblyItemId, theSubshapeIndex: Graphic3d_ZLayerId, theDelIfOrphan: boolean): boolean

Parameters
- theNoteLabel: TDF_Label
- theItemId: XCAFDoc_AssemblyItemId
- theSubshapeIndex: Graphic3d_ZLayerId
- theDelIfOrphan: boolean
Returns boolean

RemoveSubshapeNote_2

RemoveSubshapeNote_2(theNoteLabel: TDF_Label, theItemLabel: TDF_Label, theSubshapeIndex: Graphic3d_ZLayerId, theDelIfOrphan: boolean): boolean

Parameters
- theNoteLabel: TDF_Label
- theItemLabel: TDF_Label
- theSubshapeIndex: Graphic3d_ZLayerId
- theDelIfOrphan: boolean
Returns boolean

Restore

Restore(a0: Handle_TDF_Attribute): void

Inherited from TDataStd_GenericEmpty.Restore
Parameters
- a0: Handle_TDF_Attribute
Returns void

SetID_1

SetID_1(a0: Standard_GUID): void

Inherited from TDataStd_GenericEmpty.SetID_1
Parameters
- a0: Standard_GUID
Returns void

SetID_2

SetID_2(): void

Inherited from TDataStd_GenericEmpty.SetID_2
Returns void

This

This(): Standard_Transient

Inherited from TDataStd_GenericEmpty.This
Returns Standard_Transient

Transaction

Transaction(): Graphic3d_ZLayerId

Inherited from TDataStd_GenericEmpty.Transaction
Returns Graphic3d_ZLayerId

UntilTransaction

UntilTransaction(): Graphic3d_ZLayerId

Inherited from TDataStd_GenericEmpty.UntilTransaction
Returns Graphic3d_ZLayerId

delete

delete(): void

Overrides TDataStd_GenericEmpty.delete
Returns void

Static GetID

GetID(): Standard_GUID

Returns Standard_GUID

Static Set

Set(theLabel: TDF_Label): Handle_XCAFDoc_NotesTool

Parameters
- theLabel: TDF_Label
Returns Handle_XCAFDoc_NotesTool

Static get_type_descriptor

get_type_descriptor(): Handle_Standard_Type

Overrides TDataStd_GenericEmpty.get_type_descriptor
Returns Handle_Standard_Type

Static get_type_name

get_type_name(): number

Overrides TDataStd_GenericEmpty.get_type_name
Returns number

Generated using TypeDoc