Class CDM_Document

Hierarchy

Standard_Transient
- CDM_Document
  - TDocStd_Document

Index

Constructors

constructor

Methods

Constructors

constructor

new CDM_Document(): CDM_Document

Inherited from Standard_Transient.constructor
Returns CDM_Document

Methods

AddComment

AddComment(aComment: TCollection_ExtendedString): void

Parameters
- aComment: TCollection_ExtendedString
Returns void

Application

Application(): Handle_CDM_Application

Returns Handle_CDM_Application

CanClose

CanClose(): CDM_CanCloseStatus

Returns CDM_CanCloseStatus

CanCloseReference

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

Parameters
- aDocument: Handle_CDM_Document
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns boolean

Close

Close(): void

Returns void

CloseReference

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

Parameters
- aDocument: Handle_CDM_Document
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns void

Comment

Comment(): Standard_ExtString

Returns Standard_ExtString

Comments

Comments(aComments: TColStd_SequenceOfExtendedString): void

Parameters
- aComments: TColStd_SequenceOfExtendedString
Returns void

CopyReference

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

Parameters
- aFromDocument: Handle_CDM_Document
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns Graphic3d_ZLayerId

CreateReference_1

CreateReference_1(anOtherDocument: Handle_CDM_Document): Graphic3d_ZLayerId

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

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

Parameters
- aMetaData: Handle_CDM_MetaData
- anApplication: Handle_CDM_Application
- aDocumentVersion: Graphic3d_ZLayerId
- UseStorageConfiguration: boolean
Returns Graphic3d_ZLayerId

DecrementRefCounter

DecrementRefCounter(): Graphic3d_ZLayerId

Inherited from Standard_Transient.DecrementRefCounter
Returns Graphic3d_ZLayerId

DeepReferences

DeepReferences(aDocument: Handle_CDM_Document): boolean

Parameters
- aDocument: Handle_CDM_Document
Returns boolean

Delete

Delete(): void

Inherited from Standard_Transient.Delete
Returns void

Description

Description(): TCollection_ExtendedString

Returns TCollection_ExtendedString

Document

Document(aReferenceIdentifier: Graphic3d_ZLayerId): Handle_CDM_Document

Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns Handle_CDM_Document

DumpJson

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

Parameters
- theOStream: Standard_OStream
- theDepth: Graphic3d_ZLayerId
Returns void

DynamicType

DynamicType(): Handle_Standard_Type

Overrides Standard_Transient.DynamicType
Returns Handle_Standard_Type

Extensions

Extensions(Extensions: TColStd_SequenceOfExtendedString): void

Parameters
- Extensions: TColStd_SequenceOfExtendedString
Returns void

FileExtension

FileExtension(): TCollection_ExtendedString

Returns TCollection_ExtendedString

FindDescription

FindDescription(): boolean

Returns boolean

FindFileExtension

FindFileExtension(): boolean

Returns boolean

Folder

Folder(): TCollection_ExtendedString

Returns TCollection_ExtendedString

FromReferencesNumber

FromReferencesNumber(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

GetAlternativeDocument

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

Parameters
- aFormat: TCollection_ExtendedString
- anAlternativeDocument: Handle_CDM_Document
Returns boolean

GetRefCount

GetRefCount(): Graphic3d_ZLayerId

Inherited from Standard_Transient.GetRefCount
Returns Graphic3d_ZLayerId

HasRequestedFolder

HasRequestedFolder(): boolean

Returns boolean

HasRequestedPreviousVersion

HasRequestedPreviousVersion(): boolean

Returns boolean

IncrementRefCounter

IncrementRefCounter(): void

Inherited from Standard_Transient.IncrementRefCounter
Returns void

IsInSession

IsInSession(aReferenceIdentifier: Graphic3d_ZLayerId): boolean

Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns boolean

IsInstance_1

IsInstance_1(theType: Handle_Standard_Type): boolean

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

IsInstance_2

IsInstance_2(theTypeName: string): boolean

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

IsKind_1

IsKind_1(theType: Handle_Standard_Type): boolean

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

IsKind_2

IsKind_2(theTypeName: string): boolean

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

IsModified

IsModified(): boolean

Returns boolean

IsOpened_1

IsOpened_1(): boolean

Returns boolean

IsOpened_2

IsOpened_2(aReferenceIdentifier: Graphic3d_ZLayerId): boolean

Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns boolean

IsReadOnly_1

IsReadOnly_1(): boolean

Returns boolean

IsReadOnly_2

IsReadOnly_2(aReferenceIdentifier: Graphic3d_ZLayerId): boolean

Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns boolean

IsStored_1

IsStored_1(aReferenceIdentifier: Graphic3d_ZLayerId): boolean

Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns boolean

IsStored_2

IsStored_2(): boolean

Returns boolean

IsUpToDate

IsUpToDate(aReferenceIdentifier: Graphic3d_ZLayerId): boolean

Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns boolean

LoadResources

LoadResources(): void

Returns void

MetaData

MetaData(): Handle_CDM_MetaData

Returns Handle_CDM_MetaData

Modifications

Modifications(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

Modify

Modify(): void

Returns void

Name

Name(aReferenceIdentifier: Graphic3d_ZLayerId): TCollection_ExtendedString

Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns TCollection_ExtendedString

Open

Open(anApplication: Handle_CDM_Application): void

Parameters
- anApplication: Handle_CDM_Application
Returns void

Reference

Reference(aReferenceIdentifier: Graphic3d_ZLayerId): Handle_CDM_Reference

Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns Handle_CDM_Reference

ReferenceCounter

ReferenceCounter(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

RemoveAllReferences

RemoveAllReferences(): void

Returns void

RemoveReference

RemoveReference(aReferenceIdentifier: Graphic3d_ZLayerId): void

Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns void

RequestedComment

RequestedComment(): TCollection_ExtendedString

Returns TCollection_ExtendedString

RequestedFolder

RequestedFolder(): TCollection_ExtendedString

Returns TCollection_ExtendedString

RequestedName

RequestedName(): TCollection_ExtendedString

Returns TCollection_ExtendedString

RequestedPreviousVersion

RequestedPreviousVersion(): TCollection_ExtendedString

Returns TCollection_ExtendedString

SetComment

SetComment(aComment: TCollection_ExtendedString): void

Parameters
- aComment: TCollection_ExtendedString
Returns void

SetComments

SetComments(aComments: TColStd_SequenceOfExtendedString): void

Parameters
- aComments: TColStd_SequenceOfExtendedString
Returns void

SetIsReadOnly

SetIsReadOnly(): void

Returns void

SetIsUpToDate

SetIsUpToDate(aReferenceIdentifier: Graphic3d_ZLayerId): void

Parameters
- aReferenceIdentifier: Graphic3d_ZLayerId
Returns void

SetMetaData

SetMetaData(aMetaData: Handle_CDM_MetaData): void

Parameters
- aMetaData: Handle_CDM_MetaData
Returns void

SetModifications

SetModifications(Modifications: Graphic3d_ZLayerId): void

Parameters
- Modifications: Graphic3d_ZLayerId
Returns void

SetReferenceCounter

SetReferenceCounter(aReferenceCounter: Graphic3d_ZLayerId): void

Parameters
- aReferenceCounter: Graphic3d_ZLayerId
Returns void

SetRequestedComment

SetRequestedComment(aComment: TCollection_ExtendedString): void

Parameters
- aComment: TCollection_ExtendedString
Returns void

SetRequestedFolder

SetRequestedFolder(aFolder: TCollection_ExtendedString): void

Parameters
- aFolder: TCollection_ExtendedString
Returns void

SetRequestedName

SetRequestedName(aName: TCollection_ExtendedString): void

Parameters
- aName: TCollection_ExtendedString
Returns void

SetRequestedPreviousVersion

SetRequestedPreviousVersion(aPreviousVersion: TCollection_ExtendedString): void

Parameters
- aPreviousVersion: TCollection_ExtendedString
Returns void

ShallowReferences

ShallowReferences(aDocument: Handle_CDM_Document): boolean

Parameters
- aDocument: Handle_CDM_Document
Returns boolean

StorageFormat

StorageFormat(): TCollection_ExtendedString

Returns TCollection_ExtendedString

StorageVersion

StorageVersion(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

This

This(): Standard_Transient

Inherited from Standard_Transient.This
Returns Standard_Transient

ToReferencesNumber

ToReferencesNumber(): Graphic3d_ZLayerId

Returns Graphic3d_ZLayerId

UnModify

UnModify(): void

Returns void

UnsetIsReadOnly

UnsetIsReadOnly(): void

Returns void

UnsetIsStored

UnsetIsStored(): void

Returns void

UnsetRequestedPreviousVersion

UnsetRequestedPreviousVersion(): void

Returns void

UpdateFromDocuments

UpdateFromDocuments(aModifContext: Standard_Address): void

Parameters
- aModifContext: Standard_Address
Returns void

Update_1

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

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

Update_2

Update_2(ErrorString: TCollection_ExtendedString): boolean

Parameters
- ErrorString: TCollection_ExtendedString
Returns boolean

Update_3

Update_3(): void

Returns void

delete

delete(): void

Overrides Standard_Transient.delete
Returns void

Static get_type_descriptor

get_type_descriptor(): Handle_Standard_Type

Overrides Standard_Transient.get_type_descriptor
Returns Handle_Standard_Type

Static get_type_name

get_type_name(): number

Overrides Standard_Transient.get_type_name
Returns number

Generated using TypeDoc