Class XCAFApp_Application

Hierarchy

TDocStd_Application
- XCAFApp_Application

Constructors

constructor

new XCAFApp_Application(): XCAFApp_Application

Inherited from TDocStd_Application.constructor
Returns XCAFApp_Application

Methods

BeginOfUpdate

BeginOfUpdate(aDocument: Handle_CDM_Document): void

Inherited from TDocStd_Application.BeginOfUpdate
Parameters
- aDocument: Handle_CDM_Document
Returns void

CanClose

CanClose(aDocument: Handle_CDM_Document): CDM_CanCloseStatus

Inherited from TDocStd_Application.CanClose
Parameters
- aDocument: Handle_CDM_Document
Returns CDM_CanCloseStatus

CanRetrieve_1

CanRetrieve_1(theFolder: TCollection_ExtendedString, theName: TCollection_ExtendedString, theAppendMode: boolean): PCDM_ReaderStatus

Inherited from TDocStd_Application.CanRetrieve_1
Parameters
- theFolder: TCollection_ExtendedString
- theName: TCollection_ExtendedString
- theAppendMode: boolean
Returns PCDM_ReaderStatus

CanRetrieve_2

CanRetrieve_2(theFolder: TCollection_ExtendedString, theName: TCollection_ExtendedString, theVersion: TCollection_ExtendedString, theAppendMode: boolean): PCDM_ReaderStatus

Inherited from TDocStd_Application.CanRetrieve_2
Parameters
- theFolder: TCollection_ExtendedString
- theName: TCollection_ExtendedString
- theVersion: TCollection_ExtendedString
- theAppendMode: boolean
Returns PCDM_ReaderStatus

Close

Close(aDoc: Handle_TDocStd_Document): void

Inherited from TDocStd_Application.Close
Parameters
- aDoc: Handle_TDocStd_Document
Returns void

DecrementRefCounter

DecrementRefCounter(): Graphic3d_ZLayerId

Inherited from TDocStd_Application.DecrementRefCounter
Returns Graphic3d_ZLayerId

DefaultFolder

DefaultFolder(): Standard_ExtString

Inherited from TDocStd_Application.DefaultFolder
Returns Standard_ExtString

DefineFormat

DefineFormat(theFormat: XCAFDoc_PartId, theDescription: XCAFDoc_PartId, theExtension: XCAFDoc_PartId, theReader: Handle_PCDM_RetrievalDriver, theWriter: Handle_PCDM_StorageDriver): void

Inherited from TDocStd_Application.DefineFormat
Parameters
- theFormat: XCAFDoc_PartId
- theDescription: XCAFDoc_PartId
- theExtension: XCAFDoc_PartId
- theReader: Handle_PCDM_RetrievalDriver
- theWriter: Handle_PCDM_StorageDriver
Returns void

Delete

Delete(): void

Inherited from TDocStd_Application.Delete
Returns void

DumpJson

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

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

DynamicType

DynamicType(): Handle_Standard_Type

Overrides TDocStd_Application.DynamicType
Returns Handle_Standard_Type

EndOfUpdate

EndOfUpdate(aDocument: Handle_CDM_Document, theStatus: boolean, ErrorString: TCollection_ExtendedString): void

Inherited from TDocStd_Application.EndOfUpdate
Parameters
- aDocument: Handle_CDM_Document
- theStatus: boolean
- ErrorString: TCollection_ExtendedString
Returns void

Format

Format(aFileName: TCollection_ExtendedString, theFormat: TCollection_ExtendedString): boolean

Inherited from TDocStd_Application.Format
Parameters
- aFileName: TCollection_ExtendedString
- theFormat: TCollection_ExtendedString
Returns boolean

GetDocument

GetDocument(index: Graphic3d_ZLayerId, aDoc: Handle_TDocStd_Document): void

Inherited from TDocStd_Application.GetDocument
Parameters
- index: Graphic3d_ZLayerId
- aDoc: Handle_TDocStd_Document
Returns void

GetRefCount

GetRefCount(): Graphic3d_ZLayerId

Inherited from TDocStd_Application.GetRefCount
Returns Graphic3d_ZLayerId

GetRetrieveStatus

GetRetrieveStatus(): PCDM_ReaderStatus

Inherited from TDocStd_Application.GetRetrieveStatus
Returns PCDM_ReaderStatus

IncrementRefCounter

IncrementRefCounter(): void

Inherited from TDocStd_Application.IncrementRefCounter
Returns void

InitDocument

InitDocument(aDoc: Handle_CDM_Document): void

Overrides TDocStd_Application.InitDocument
Parameters
- aDoc: Handle_CDM_Document
Returns void

IsDriverLoaded

IsDriverLoaded(): boolean

Inherited from TDocStd_Application.IsDriverLoaded
Returns boolean

IsInSession

IsInSession(path: TCollection_ExtendedString): Graphic3d_ZLayerId

Inherited from TDocStd_Application.IsInSession
Parameters
- path: TCollection_ExtendedString
Returns Graphic3d_ZLayerId

IsInstance_1

IsInstance_1(theType: Handle_Standard_Type): boolean

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

IsInstance_2

IsInstance_2(theTypeName: string): boolean

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

IsKind_1

IsKind_1(theType: Handle_Standard_Type): boolean

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

IsKind_2

IsKind_2(theTypeName: string): boolean

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

MessageDriver

MessageDriver(): Handle_Message_Messenger

Inherited from TDocStd_Application.MessageDriver
Returns Handle_Message_Messenger

MetaDataDriver

MetaDataDriver(): Handle_CDF_MetaDataDriver

Inherited from TDocStd_Application.MetaDataDriver
Returns Handle_CDF_MetaDataDriver

MetaDataLookUpTable

MetaDataLookUpTable(): CDM_MetaDataLookUpTable

Inherited from TDocStd_Application.MetaDataLookUpTable
Returns CDM_MetaDataLookUpTable

Name

Name(): TCollection_ExtendedString

Inherited from TDocStd_Application.Name
Returns TCollection_ExtendedString

NbDocuments

NbDocuments(): Graphic3d_ZLayerId

Inherited from TDocStd_Application.NbDocuments
Returns Graphic3d_ZLayerId

NewDocument

NewDocument(theFormat: TCollection_ExtendedString, theDoc: Handle_CDM_Document): void

Inherited from TDocStd_Application.NewDocument
Parameters
- theFormat: TCollection_ExtendedString
- theDoc: Handle_CDM_Document
Returns void

NewDocument_1

NewDocument_1(format: TCollection_ExtendedString, aDoc: Handle_CDM_Document): void

Inherited from TDocStd_Application.NewDocument_1
Parameters
- format: TCollection_ExtendedString
- aDoc: Handle_CDM_Document
Returns void

NewDocument_2

NewDocument_2(format: TCollection_ExtendedString, aDoc: Handle_TDocStd_Document): void

Inherited from TDocStd_Application.NewDocument_2
Parameters
- format: TCollection_ExtendedString
- aDoc: Handle_TDocStd_Document
Returns void

OnAbortTransaction

OnAbortTransaction(theDoc: Handle_TDocStd_Document): void

Inherited from TDocStd_Application.OnAbortTransaction
Parameters
- theDoc: Handle_TDocStd_Document
Returns void

OnCommitTransaction

OnCommitTransaction(theDoc: Handle_TDocStd_Document): void

Inherited from TDocStd_Application.OnCommitTransaction
Parameters
- theDoc: Handle_TDocStd_Document
Returns void

OnOpenTransaction

OnOpenTransaction(theDoc: Handle_TDocStd_Document): void

Inherited from TDocStd_Application.OnOpenTransaction
Parameters
- theDoc: Handle_TDocStd_Document
Returns void

Open

Open(aDocument: Handle_CDM_Document): void

Inherited from TDocStd_Application.Open
Parameters
- aDocument: Handle_CDM_Document
Returns void

Open_1

Open_1(thePath: TCollection_ExtendedString, theDoc: Handle_TDocStd_Document, theFilter: Handle_PCDM_ReaderFilter, theRange: Message_ProgressRange): PCDM_ReaderStatus

Inherited from TDocStd_Application.Open_1
Parameters
- thePath: TCollection_ExtendedString
- theDoc: Handle_TDocStd_Document
- theFilter: Handle_PCDM_ReaderFilter
- theRange: Message_ProgressRange
Returns PCDM_ReaderStatus

Open_2

Open_2(thePath: TCollection_ExtendedString, theDoc: Handle_TDocStd_Document, theRange: Message_ProgressRange): PCDM_ReaderStatus

Inherited from TDocStd_Application.Open_2
Parameters
- thePath: TCollection_ExtendedString
- theDoc: Handle_TDocStd_Document
- theRange: Message_ProgressRange
Returns PCDM_ReaderStatus

Open_3

Open_3(theIStream: Standard_IStream, theDoc: Handle_TDocStd_Document, theFilter: Handle_PCDM_ReaderFilter, theRange: Message_ProgressRange): PCDM_ReaderStatus

Inherited from TDocStd_Application.Open_3
Parameters
- theIStream: Standard_IStream
- theDoc: Handle_TDocStd_Document
- theFilter: Handle_PCDM_ReaderFilter
- theRange: Message_ProgressRange
Returns PCDM_ReaderStatus

Open_4

Open_4(theIStream: Standard_IStream, theDoc: Handle_TDocStd_Document, theRange: Message_ProgressRange): PCDM_ReaderStatus

Inherited from TDocStd_Application.Open_4
Parameters
- theIStream: Standard_IStream
- theDoc: Handle_TDocStd_Document
- theRange: Message_ProgressRange
Returns PCDM_ReaderStatus

Read

Read(theIStream: Standard_IStream, theDocument: Handle_CDM_Document, theFilter: Handle_PCDM_ReaderFilter, theRange: Message_ProgressRange): void

Inherited from TDocStd_Application.Read
Parameters
- theIStream: Standard_IStream
- theDocument: Handle_CDM_Document
- theFilter: Handle_PCDM_ReaderFilter
- theRange: Message_ProgressRange
Returns void

ReaderFromFormat

ReaderFromFormat(aFormat: TCollection_ExtendedString): Handle_PCDM_Reader

Inherited from TDocStd_Application.ReaderFromFormat
Parameters
- aFormat: TCollection_ExtendedString
Returns Handle_PCDM_Reader

ReadingFormats

ReadingFormats(theFormats: TColStd_SequenceOfAsciiString): void

Inherited from TDocStd_Application.ReadingFormats
Parameters
- theFormats: TColStd_SequenceOfAsciiString
Returns void

Resources

Resources(): Handle_Resource_Manager

Inherited from TDocStd_Application.Resources
Returns Handle_Resource_Manager

ResourcesName

ResourcesName(): string

Overrides TDocStd_Application.ResourcesName
Returns string

Retrieve_1

Retrieve_1(aFolder: TCollection_ExtendedString, aName: TCollection_ExtendedString, UseStorageConfiguration: boolean, theFilter: Handle_PCDM_ReaderFilter, theRange: Message_ProgressRange): Handle_CDM_Document

Inherited from TDocStd_Application.Retrieve_1
Parameters
- aFolder: TCollection_ExtendedString
- aName: TCollection_ExtendedString
- UseStorageConfiguration: boolean
- theFilter: Handle_PCDM_ReaderFilter
- theRange: Message_ProgressRange
Returns Handle_CDM_Document

Retrieve_2

Retrieve_2(aFolder: TCollection_ExtendedString, aName: TCollection_ExtendedString, aVersion: TCollection_ExtendedString, UseStorageConfiguration: boolean, theFilter: Handle_PCDM_ReaderFilter, theRange: Message_ProgressRange): Handle_CDM_Document

Inherited from TDocStd_Application.Retrieve_2
Parameters
- aFolder: TCollection_ExtendedString
- aName: TCollection_ExtendedString
- aVersion: TCollection_ExtendedString
- UseStorageConfiguration: boolean
- theFilter: Handle_PCDM_ReaderFilter
- theRange: Message_ProgressRange
Returns Handle_CDM_Document

SaveAs_1

SaveAs_1(theDoc: Handle_TDocStd_Document, path: TCollection_ExtendedString, theRange: Message_ProgressRange): PCDM_StoreStatus

Inherited from TDocStd_Application.SaveAs_1
Parameters
- theDoc: Handle_TDocStd_Document
- path: TCollection_ExtendedString
- theRange: Message_ProgressRange
Returns PCDM_StoreStatus

SaveAs_2

SaveAs_2(theDoc: Handle_TDocStd_Document, theOStream: Standard_OStream, theRange: Message_ProgressRange): PCDM_StoreStatus

Inherited from TDocStd_Application.SaveAs_2
Parameters
- theDoc: Handle_TDocStd_Document
- theOStream: Standard_OStream
- theRange: Message_ProgressRange
Returns PCDM_StoreStatus

SaveAs_3

SaveAs_3(theDoc: Handle_TDocStd_Document, path: TCollection_ExtendedString, theStatusMessage: TCollection_ExtendedString, theRange: Message_ProgressRange): PCDM_StoreStatus

Inherited from TDocStd_Application.SaveAs_3
Parameters
- theDoc: Handle_TDocStd_Document
- path: TCollection_ExtendedString
- theStatusMessage: TCollection_ExtendedString
- theRange: Message_ProgressRange
Returns PCDM_StoreStatus

SaveAs_4

SaveAs_4(theDoc: Handle_TDocStd_Document, theOStream: Standard_OStream, theStatusMessage: TCollection_ExtendedString, theRange: Message_ProgressRange): PCDM_StoreStatus

Inherited from TDocStd_Application.SaveAs_4
Parameters
- theDoc: Handle_TDocStd_Document
- theOStream: Standard_OStream
- theStatusMessage: TCollection_ExtendedString
- theRange: Message_ProgressRange
Returns PCDM_StoreStatus

Save_1

Save_1(theDoc: Handle_TDocStd_Document, theRange: Message_ProgressRange): PCDM_StoreStatus

Inherited from TDocStd_Application.Save_1
Parameters
- theDoc: Handle_TDocStd_Document
- theRange: Message_ProgressRange
Returns PCDM_StoreStatus

Save_2

Save_2(theDoc: Handle_TDocStd_Document, theStatusMessage: TCollection_ExtendedString, theRange: Message_ProgressRange): PCDM_StoreStatus

Inherited from TDocStd_Application.Save_2
Parameters
- theDoc: Handle_TDocStd_Document
- theStatusMessage: TCollection_ExtendedString
- theRange: Message_ProgressRange
Returns PCDM_StoreStatus

SetDefaultFolder

SetDefaultFolder(aFolder: Standard_ExtString): boolean

Inherited from TDocStd_Application.SetDefaultFolder
Parameters
- aFolder: Standard_ExtString
Returns boolean

This

This(): Standard_Transient

Inherited from TDocStd_Application.This
Returns Standard_Transient

Version

Version(): XCAFDoc_PartId

Inherited from TDocStd_Application.Version
Returns XCAFDoc_PartId

Write

Write(aString: Standard_ExtString): void

Inherited from TDocStd_Application.Write
Parameters
- aString: Standard_ExtString
Returns void

WriterFromFormat

WriterFromFormat(aFormat: TCollection_ExtendedString): Handle_PCDM_StorageDriver

Inherited from TDocStd_Application.WriterFromFormat
Parameters
- aFormat: TCollection_ExtendedString
Returns Handle_PCDM_StorageDriver

WritingFormats

WritingFormats(theFormats: TColStd_SequenceOfAsciiString): void

Inherited from TDocStd_Application.WritingFormats
Parameters
- theFormats: TColStd_SequenceOfAsciiString
Returns void

delete

delete(): void

Overrides TDocStd_Application.delete
Returns void

Static GetApplication

GetApplication(): Handle_XCAFApp_Application

Returns Handle_XCAFApp_Application

Static Load

Load(aGUID: Standard_GUID): Handle_CDF_Application

Inherited from TDocStd_Application.Load
Parameters
- aGUID: Standard_GUID
Returns Handle_CDF_Application

Static get_type_descriptor

get_type_descriptor(): Handle_Standard_Type

Overrides TDocStd_Application.get_type_descriptor
Returns Handle_Standard_Type

Static get_type_name

get_type_name(): number

Overrides TDocStd_Application.get_type_name
Returns number

Generated using TypeDoc