Class TDocStd_Document

Hierarchy

CDM_Document
- TDocStd_Document

Index

Constructors

constructor

Methods

Constructors

constructor

new TDocStd_Document(astorageformat: TCollection_ExtendedString): TDocStd_Document

Overrides CDM_Document.constructor
Parameters
- astorageformat: TCollection_ExtendedString
Returns TDocStd_Document

Methods

AbortCommand

AbortCommand(): void

Returns void

AddComment

AddComment(aComment: TCollection_ExtendedString): void

Inherited from CDM_Document.AddComment
Parameters
- aComment: TCollection_ExtendedString
Returns void

Application

Application(): Handle_CDM_Application

Inherited from CDM_Document.Application
Returns Handle_CDM_Application

BeforeClose

BeforeClose(): void

Returns void

CanClose

CanClose(): CDM_CanCloseStatus

Inherited from CDM_Document.CanClose
Returns CDM_CanCloseStatus

CanCloseReference

CanCloseReference(aDocument: Handle_CDM_Document, aReferenceIdentifier: Graphic3d_ZLayerId): boolean

Inherited from CDM_Document.CanCloseReference
Parameters
- aDocument: Handle_CDM_Document
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns boolean

ChangeStorageFormat

ChangeStorageFormat(newStorageFormat: TCollection_ExtendedString): void

Parameters
- newStorageFormat: TCollection_ExtendedString
Returns void

ChangeStorageFormatVersion

ChangeStorageFormatVersion(theVersion: TDocStd_FormatVersion): void

Parameters
- theVersion: TDocStd_FormatVersion
Returns void

ClearRedos

ClearRedos(): void

Returns void

ClearUndos

ClearUndos(): void

Returns void

Close

Close(): void

Inherited from CDM_Document.Close
Returns void

CloseReference

CloseReference(aDocument: Handle_CDM_Document, aReferenceIdentifier: Graphic3d_ZLayerId): void

Inherited from CDM_Document.CloseReference
Parameters
- aDocument: Handle_CDM_Document
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns void

Comment

Comment(): Standard_ExtString

Inherited from CDM_Document.Comment
Returns Standard_ExtString

Comments

Comments(aComments: TColStd_SequenceOfExtendedString): void

Inherited from CDM_Document.Comments
Parameters
- aComments: TColStd_SequenceOfExtendedString
Returns void

CommitCommand

CommitCommand(): boolean

Returns boolean

CopyReference

CopyReference(aFromDocument: Handle_CDM_Document, aReferenceIdentifier: Graphic3d_ZLayerId): Graphic3d_ZLayerId

Inherited from CDM_Document.CopyReference
Parameters
- aFromDocument: Handle_CDM_Document
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns Graphic3d_ZLayerId

CreateReference_1

CreateReference_1(anOtherDocument: Handle_CDM_Document): Graphic3d_ZLayerId

Inherited from CDM_Document.CreateReference_1
Parameters
- anOtherDocument: Handle_CDM_Document
Returns Graphic3d_ZLayerId

CreateReference_2

CreateReference_2(aMetaData: Handle_CDM_MetaData, aReferenceIdentifier: Graphic3d_ZLayerId, anApplication: Handle_CDM_Application, aToDocumentVersion: Graphic3d_ZLayerId, UseStorageConfiguration: boolean): void

Inherited from CDM_Document.CreateReference_2
Parameters
- aMetaData: Handle_CDM_MetaData
- aReferenceIdentifier: Graphic3d_ZLayerId
- anApplication: Handle_CDM_Application
- aToDocumentVersion: Graphic3d_ZLayerId
- UseStorageConfiguration: boolean
Returns void

CreateReference_3

CreateReference_3(aMetaData: Handle_CDM_MetaData, anApplication: Handle_CDM_Application, aDocumentVersion: Graphic3d_ZLayerId, UseStorageConfiguration: boolean): Graphic3d_ZLayerId

Inherited from CDM_Document.CreateReference_3
Parameters
- aMetaData: Handle_CDM_MetaData
- anApplication: Handle_CDM_Application
- aDocumentVersion: Graphic3d_ZLayerId
- UseStorageConfiguration: boolean
Returns Graphic3d_ZLayerId

DecrementRefCounter

DecrementRefCounter(): Graphic3d_ZLayerId

Inherited from CDM_Document.DecrementRefCounter
Returns Graphic3d_ZLayerId

DeepReferences

DeepReferences(aDocument: Handle_CDM_Document): boolean

Inherited from CDM_Document.DeepReferences
Parameters
- aDocument: Handle_CDM_Document
Returns boolean

Delete

Delete(): void

Inherited from CDM_Document.Delete
Returns void

Description

Description(): TCollection_ExtendedString

Inherited from CDM_Document.Description
Returns TCollection_ExtendedString

Document

Document(aReferenceIdentifier: Graphic3d_ZLayerId): Handle_CDM_Document

Inherited from CDM_Document.Document
Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns Handle_CDM_Document

DumpJson

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

Overrides CDM_Document.DumpJson
Parameters
- theOStream: Standard_OStream
- theDepth: Graphic3d_ZLayerId
Returns void

DynamicType

DynamicType(): Handle_Standard_Type

Overrides CDM_Document.DynamicType
Returns Handle_Standard_Type

EmptyLabelsSavingMode

EmptyLabelsSavingMode(): boolean

Returns boolean

Extensions

Extensions(Extensions: TColStd_SequenceOfExtendedString): void

Inherited from CDM_Document.Extensions
Parameters
- Extensions: TColStd_SequenceOfExtendedString
Returns void

FileExtension

FileExtension(): TCollection_ExtendedString

Inherited from CDM_Document.FileExtension
Returns TCollection_ExtendedString

FindDescription

FindDescription(): boolean

Inherited from CDM_Document.FindDescription
Returns boolean

FindFileExtension

FindFileExtension(): boolean

Inherited from CDM_Document.FindFileExtension
Returns boolean

Folder

Folder(): TCollection_ExtendedString

Inherited from CDM_Document.Folder
Returns TCollection_ExtendedString

FromReferencesNumber

FromReferencesNumber(): Graphic3d_ZLayerId

Inherited from CDM_Document.FromReferencesNumber
Returns Graphic3d_ZLayerId

GetAlternativeDocument

GetAlternativeDocument(aFormat: TCollection_ExtendedString, anAlternativeDocument: Handle_CDM_Document): boolean

Inherited from CDM_Document.GetAlternativeDocument
Parameters
- aFormat: TCollection_ExtendedString
- anAlternativeDocument: Handle_CDM_Document
Returns boolean

GetAvailableRedos

GetAvailableRedos(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

GetAvailableUndos

GetAvailableUndos(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

GetData

GetData(): Handle_TDF_Data

Returns Handle_TDF_Data

GetModified

GetModified(): TDF_LabelMap

Returns TDF_LabelMap

GetName

GetName(): TCollection_ExtendedString

Returns TCollection_ExtendedString

GetPath

GetPath(): TCollection_ExtendedString

Returns TCollection_ExtendedString

GetRedos

GetRedos(): TDF_DeltaList

Returns TDF_DeltaList

GetRefCount

GetRefCount(): Graphic3d_ZLayerId

Inherited from CDM_Document.GetRefCount
Returns Graphic3d_ZLayerId

GetSavedTime

GetSavedTime(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

GetUndoLimit

GetUndoLimit(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

GetUndos

GetUndos(): TDF_DeltaList

Returns TDF_DeltaList

HasOpenCommand

HasOpenCommand(): boolean

Returns boolean

HasRequestedFolder

HasRequestedFolder(): boolean

Inherited from CDM_Document.HasRequestedFolder
Returns boolean

HasRequestedPreviousVersion

HasRequestedPreviousVersion(): boolean

Inherited from CDM_Document.HasRequestedPreviousVersion
Returns boolean

IncrementRefCounter

IncrementRefCounter(): void

Inherited from CDM_Document.IncrementRefCounter
Returns void

InitDeltaCompaction

InitDeltaCompaction(): boolean

Returns boolean

IsChanged

IsChanged(): boolean

Returns boolean

IsEmpty

IsEmpty(): boolean

Returns boolean

IsInSession

IsInSession(aReferenceIdentifier: Graphic3d_ZLayerId): boolean

Inherited from CDM_Document.IsInSession
Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns boolean

IsInstance_1

IsInstance_1(theType: Handle_Standard_Type): boolean

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

IsInstance_2

IsInstance_2(theTypeName: string): boolean

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

IsKind_1

IsKind_1(theType: Handle_Standard_Type): boolean

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

IsKind_2

IsKind_2(theTypeName: string): boolean

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

IsModified

IsModified(): boolean

Inherited from CDM_Document.IsModified
Returns boolean

IsNestedTransactionMode

IsNestedTransactionMode(): boolean

Returns boolean

IsOpened_1

IsOpened_1(): boolean

Inherited from CDM_Document.IsOpened_1
Returns boolean

IsOpened_2

IsOpened_2(aReferenceIdentifier: Graphic3d_ZLayerId): boolean

Inherited from CDM_Document.IsOpened_2
Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns boolean

IsReadOnly_1

IsReadOnly_1(): boolean

Inherited from CDM_Document.IsReadOnly_1
Returns boolean

IsReadOnly_2

IsReadOnly_2(aReferenceIdentifier: Graphic3d_ZLayerId): boolean

Inherited from CDM_Document.IsReadOnly_2
Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns boolean

IsSaved

IsSaved(): boolean

Returns boolean

IsStored_1

IsStored_1(aReferenceIdentifier: Graphic3d_ZLayerId): boolean

Inherited from CDM_Document.IsStored_1
Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns boolean

IsStored_2

IsStored_2(): boolean

Inherited from CDM_Document.IsStored_2
Returns boolean

IsUpToDate

IsUpToDate(aReferenceIdentifier: Graphic3d_ZLayerId): boolean

Inherited from CDM_Document.IsUpToDate
Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns boolean

IsValid

IsValid(): boolean

Returns boolean

LoadResources

LoadResources(): void

Inherited from CDM_Document.LoadResources
Returns void

Main

Main(): TDF_Label

Returns TDF_Label

MetaData

MetaData(): Handle_CDM_MetaData

Inherited from CDM_Document.MetaData
Returns Handle_CDM_MetaData

ModificationMode

ModificationMode(): boolean

Returns boolean

Modifications

Modifications(): Graphic3d_ZLayerId

Inherited from CDM_Document.Modifications
Returns Graphic3d_ZLayerId

Modify

Modify(): void

Inherited from CDM_Document.Modify
Returns void

Name

Name(aReferenceIdentifier: Graphic3d_ZLayerId): TCollection_ExtendedString

Inherited from CDM_Document.Name
Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns TCollection_ExtendedString

NewCommand

NewCommand(): void

Returns void

Open

Open(anApplication: Handle_CDM_Application): void

Inherited from CDM_Document.Open
Parameters
- anApplication: Handle_CDM_Application
Returns void

OpenCommand

OpenCommand(): void

Returns void

PerformDeltaCompaction

PerformDeltaCompaction(): boolean

Returns boolean

PurgeModified

PurgeModified(): void

Returns void

Recompute

Recompute(): void

Returns void

Redo

Redo(): boolean

Returns boolean

Reference

Reference(aReferenceIdentifier: Graphic3d_ZLayerId): Handle_CDM_Reference

Inherited from CDM_Document.Reference
Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns Handle_CDM_Reference

ReferenceCounter

ReferenceCounter(): Graphic3d_ZLayerId

Inherited from CDM_Document.ReferenceCounter
Returns Graphic3d_ZLayerId

RemoveAllReferences

RemoveAllReferences(): void

Inherited from CDM_Document.RemoveAllReferences
Returns void

RemoveFirstUndo

RemoveFirstUndo(): void

Returns void

RemoveReference

RemoveReference(aReferenceIdentifier: Graphic3d_ZLayerId): void

Inherited from CDM_Document.RemoveReference
Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns void

RequestedComment

RequestedComment(): TCollection_ExtendedString

Inherited from CDM_Document.RequestedComment
Returns TCollection_ExtendedString

RequestedFolder

RequestedFolder(): TCollection_ExtendedString

Inherited from CDM_Document.RequestedFolder
Returns TCollection_ExtendedString

RequestedName

RequestedName(): TCollection_ExtendedString

Inherited from CDM_Document.RequestedName
Returns TCollection_ExtendedString

RequestedPreviousVersion

RequestedPreviousVersion(): TCollection_ExtendedString

Inherited from CDM_Document.RequestedPreviousVersion
Returns TCollection_ExtendedString

SetComment

SetComment(aComment: TCollection_ExtendedString): void

Inherited from CDM_Document.SetComment
Parameters
- aComment: TCollection_ExtendedString
Returns void

SetComments

SetComments(aComments: TColStd_SequenceOfExtendedString): void

Inherited from CDM_Document.SetComments
Parameters
- aComments: TColStd_SequenceOfExtendedString
Returns void

SetData

SetData(data: Handle_TDF_Data): void

Parameters
- data: Handle_TDF_Data
Returns void

SetEmptyLabelsSavingMode

SetEmptyLabelsSavingMode(isAllowed: boolean): void

Parameters
- isAllowed: boolean
Returns void

SetIsReadOnly

SetIsReadOnly(): void

Inherited from CDM_Document.SetIsReadOnly
Returns void

SetIsUpToDate

SetIsUpToDate(aReferenceIdentifier: Graphic3d_ZLayerId): void

Inherited from CDM_Document.SetIsUpToDate
Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns void

SetMetaData

SetMetaData(aMetaData: Handle_CDM_MetaData): void

Inherited from CDM_Document.SetMetaData
Parameters
- aMetaData: Handle_CDM_MetaData
Returns void

SetModificationMode

SetModificationMode(theTransactionOnly: boolean): void

Parameters
- theTransactionOnly: boolean
Returns void

SetModifications

SetModifications(Modifications: Graphic3d_ZLayerId): void

Inherited from CDM_Document.SetModifications
Parameters
- Modifications: Graphic3d_ZLayerId
Returns void

SetModified

SetModified(L: TDF_Label): void

Parameters
- L: TDF_Label
Returns void

SetNestedTransactionMode

SetNestedTransactionMode(isAllowed: boolean): void

Parameters
- isAllowed: boolean
Returns void

SetReferenceCounter

SetReferenceCounter(aReferenceCounter: Graphic3d_ZLayerId): void

Inherited from CDM_Document.SetReferenceCounter
Parameters
- aReferenceCounter: Graphic3d_ZLayerId
Returns void

SetRequestedComment

SetRequestedComment(aComment: TCollection_ExtendedString): void

Inherited from CDM_Document.SetRequestedComment
Parameters
- aComment: TCollection_ExtendedString
Returns void

SetRequestedFolder

SetRequestedFolder(aFolder: TCollection_ExtendedString): void

Inherited from CDM_Document.SetRequestedFolder
Parameters
- aFolder: TCollection_ExtendedString
Returns void

SetRequestedName

SetRequestedName(aName: TCollection_ExtendedString): void

Inherited from CDM_Document.SetRequestedName
Parameters
- aName: TCollection_ExtendedString
Returns void

SetRequestedPreviousVersion

SetRequestedPreviousVersion(aPreviousVersion: TCollection_ExtendedString): void

Inherited from CDM_Document.SetRequestedPreviousVersion
Parameters
- aPreviousVersion: TCollection_ExtendedString
Returns void

SetSaved

SetSaved(): void

Returns void

SetSavedTime

SetSavedTime(theTime: Graphic3d_ZLayerId): void

Parameters
- theTime: Graphic3d_ZLayerId
Returns void

SetUndoLimit

SetUndoLimit(L: Graphic3d_ZLayerId): void

Parameters
- L: Graphic3d_ZLayerId
Returns void

ShallowReferences

ShallowReferences(aDocument: Handle_CDM_Document): boolean

Inherited from CDM_Document.ShallowReferences
Parameters
- aDocument: Handle_CDM_Document
Returns boolean

StorageFormat

StorageFormat(): TCollection_ExtendedString

Overrides CDM_Document.StorageFormat
Returns TCollection_ExtendedString

StorageFormatVersion

StorageFormatVersion(): TDocStd_FormatVersion

Returns TDocStd_FormatVersion

StorageVersion

StorageVersion(): Graphic3d_ZLayerId

Inherited from CDM_Document.StorageVersion
Returns Graphic3d_ZLayerId

This

This(): Standard_Transient

Inherited from CDM_Document.This
Returns Standard_Transient

ToReferencesNumber

ToReferencesNumber(): Graphic3d_ZLayerId

Inherited from CDM_Document.ToReferencesNumber
Returns Graphic3d_ZLayerId

UnModify

UnModify(): void

Inherited from CDM_Document.UnModify
Returns void

Undo

Undo(): boolean

Returns boolean

UnsetIsReadOnly

UnsetIsReadOnly(): void

Inherited from CDM_Document.UnsetIsReadOnly
Returns void

UnsetIsStored

UnsetIsStored(): void

Inherited from CDM_Document.UnsetIsStored
Returns void

UnsetRequestedPreviousVersion

UnsetRequestedPreviousVersion(): void

Inherited from CDM_Document.UnsetRequestedPreviousVersion
Returns void

Update

Update(aToDocument: Handle_CDM_Document, aReferenceIdentifier: Graphic3d_ZLayerId, aModifContext: Standard_Address): void

Parameters
- aToDocument: Handle_CDM_Document
- aReferenceIdentifier: Graphic3d_ZLayerId
- aModifContext: Standard_Address
Returns void

UpdateFromDocuments

UpdateFromDocuments(aModifContext: Standard_Address): void

Inherited from CDM_Document.UpdateFromDocuments
Parameters
- aModifContext: Standard_Address
Returns void

UpdateReferences

UpdateReferences(aDocEntry: XCAFDoc_PartId): void

Parameters
- aDocEntry: XCAFDoc_PartId
Returns void

Update_1

Update_1(aToDocument: Handle_CDM_Document, aReferenceIdentifier: Graphic3d_ZLayerId, aModifContext: Standard_Address): void

Inherited from CDM_Document.Update_1
Parameters
- aToDocument: Handle_CDM_Document
- aReferenceIdentifier: Graphic3d_ZLayerId
- aModifContext: Standard_Address
Returns void

Update_2

Update_2(ErrorString: TCollection_ExtendedString): boolean

Inherited from CDM_Document.Update_2
Parameters
- ErrorString: TCollection_ExtendedString
Returns boolean

Update_3

Update_3(): void

Inherited from CDM_Document.Update_3
Returns void

delete

delete(): void

Overrides CDM_Document.delete
Returns void

Static CurrentStorageFormatVersion

CurrentStorageFormatVersion(): TDocStd_FormatVersion

Returns TDocStd_FormatVersion

Static Get

Get(L: TDF_Label): Handle_TDocStd_Document

Parameters
- L: TDF_Label
Returns Handle_TDocStd_Document

Static get_type_descriptor

get_type_descriptor(): Handle_Standard_Type

Overrides CDM_Document.get_type_descriptor
Returns Handle_Standard_Type

Static get_type_name

get_type_name(): number

Overrides CDM_Document.get_type_name
Returns number

Generated using TypeDoc