PCDM — OpenCascade.js

OCCT package PCDM: PCDM, PCDM_Document, PCDM_DOMHeaderParser, PCDM_DriverError, and 11 more bound classes.

Instance methods(5)

SetStartElementName(aStartElementName: TCollection_AsciiString): void
Parameters (1)
- aStartElementName
SetEndElementName(anEndElementName: TCollection_AsciiString): void
Parameters (1)
- anEndElementName
startElement(): boolean
endElement(): boolean
GetElement(): LDOM_Element

PCDM_DriverError

Standard_Failureexception

Constructors(2)

constructor(theMessage: string): PCDM_DriverError
Parameters (1)
- theMessage
constructor(theMessage: string, theStackTrace: string): PCDM_DriverError
Parameters (2)
- theMessage
- theStackTrace

Instance methods(1)

ExceptionType(): string

PCDM_Reader

Standard_Transient

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(1)

DynamicType(): Standard_Type

PCDM_ReaderStatus

Properties(23)

PCDM_RS_OK:'PCDM_RS_OK'readonly
PCDM_RS_NoDriver:'PCDM_RS_NoDriver'readonly
PCDM_RS_UnknownFileDriver:'PCDM_RS_UnknownFileDriver'readonly
PCDM_RS_OpenError:'PCDM_RS_OpenError'readonly
PCDM_RS_NoVersion:'PCDM_RS_NoVersion'readonly
PCDM_RS_NoSchema:'PCDM_RS_NoSchema'readonly
PCDM_RS_NoDocument:'PCDM_RS_NoDocument'readonly
PCDM_RS_ExtensionFailure:'PCDM_RS_ExtensionFailure'readonly
PCDM_RS_WrongStreamMode:'PCDM_RS_WrongStreamMode'readonly
PCDM_RS_FormatFailure:'PCDM_RS_FormatFailure'readonly
PCDM_RS_TypeFailure:'PCDM_RS_TypeFailure'readonly
PCDM_RS_TypeNotFoundInSchema:'PCDM_RS_TypeNotFoundInSchema'readonly
PCDM_RS_UnrecognizedFileFormat:'PCDM_RS_UnrecognizedFileFormat'readonly
PCDM_RS_MakeFailure:'PCDM_RS_MakeFailure'readonly
PCDM_RS_PermissionDenied:'PCDM_RS_PermissionDenied'readonly
PCDM_RS_DriverFailure:'PCDM_RS_DriverFailure'readonly
PCDM_RS_AlreadyRetrievedAndModified:'PCDM_RS_AlreadyRetrievedAndModified'readonly
PCDM_RS_AlreadyRetrieved:'PCDM_RS_AlreadyRetrieved'readonly
PCDM_RS_UnknownDocument:'PCDM_RS_UnknownDocument'readonly
PCDM_RS_WrongResource:'PCDM_RS_WrongResource'readonly
PCDM_RS_ReaderException:'PCDM_RS_ReaderException'readonly
PCDM_RS_NoModel:'PCDM_RS_NoModel'readonly
PCDM_RS_UserBreak:'PCDM_RS_UserBreak'readonly

PCDM_ReadWriter

Standard_Transient

Static methods(6)

Reader(aFileName: TCollection_ExtendedString): PCDM_ReadWriter
returns the convenient Reader for a File.
Parameters (1)
- aFileName
Writer(): PCDM_ReadWriter
WriteFileFormat(aData: Storage_Data, aDocument: CDM_Document): void
Parameters (2)
- aData
- aDocument
FileFormat(aFileName: TCollection_ExtendedString): TCollection_ExtendedString
tries to get a format in the file. returns an empty string if the file could not be read or does not have a FileFormat information.
Parameters (1)
- aFileName
get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(5)

WriteReferenceCounter(aData: Storage_Data, aDocument: CDM_Document): void
Parameters (2)
- aData
- aDocument
WriteReferences(aData: Storage_Data, aDocument: CDM_Document, theReferencerFileName: TCollection_ExtendedString): void
Parameters (3)
- aData
- aDocument
- theReferencerFileName
WriteExtensions(aData: Storage_Data, aDocument: CDM_Document): void
Parameters (2)
- aData
- aDocument
WriteVersion(aData: Storage_Data, aDocument: CDM_Document): void
Parameters (2)
- aData
- aDocument
DynamicType(): Standard_Type

PCDM_ReadWriter_1

PCDM_ReadWriterStandard_Transient

Constructors(1)

constructor(): PCDM_ReadWriter_1

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(5)

WriteReferenceCounter(aData: Storage_Data, aDocument: CDM_Document): void
Parameters (2)
- aData
- aDocument
WriteReferences(aData: Storage_Data, aDocument: CDM_Document, theReferencerFileName: TCollection_ExtendedString): void
Parameters (3)
- aData
- aDocument
- theReferencerFileName
WriteExtensions(aData: Storage_Data, aDocument: CDM_Document): void
Parameters (2)
- aData
- aDocument
WriteVersion(aData: Storage_Data, aDocument: CDM_Document): void
Parameters (2)
- aData
- aDocument
DynamicType(): Standard_Type

PCDM_Reference

Constructors(2)

constructor(): PCDM_Reference
constructor(aReferenceIdentifier: number, aFileName: TCollection_ExtendedString, aDocumentVersion: number): PCDM_Reference
Parameters (3)
- aReferenceIdentifier
- aFileName
- aDocumentVersion

Instance methods(3)

ReferenceIdentifier(): number
FileName(): TCollection_ExtendedString
DocumentVersion(): number

PCDM_ReferenceIterator

Standard_Transient

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(2)

Init(aMetaData: CDM_MetaData): void
Parameters (1)
- aMetaData
DynamicType(): Standard_Type

PCDM_RetrievalDriver

PCDM_ReaderStandard_Transient

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(2)

persistent implementation of storage.
The application must redefine one the two Make() methods. The first one, if the application wants to put only one document in the storage file.
The second method should be redefined to put additional document that could be used by the retrieval instead of the principal document, depending on the schema used during the retrieval. For example, a second document could be a standard CDMShape_Document. This means that a client application will already be able to extract a CDMShape_Document of the file, if the Shape Schema remains unchanged.

Constructors(1)

constructor(): PCDM_StorageDriver

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(11)

Make(aDocument: CDM_Document): PCDM_Document
raises NotImplemented.
Parameters (1)
- aDocument
Make(aDocument: CDM_Document, Documents: NCollection_Sequence_handle_PCDM_Document): void
By default, puts in the Sequence the document returns by the previous Make method.
Parameters (2)
- aDocument
- Documents —
  Mutated in place; read the updated value from this argument after the call.
Write(aDocument: CDM_Document, aFileName: TCollection_ExtendedString, theRange: Message_ProgressRange): void
Warning! raises DriverError if an error occurs during inside the Make method. stores the content of the Document into a new file.
by default Write will use Make method to build a persistent document and the Schema method to write the persistent document.
Parameters (3)
- aDocument
- aFileName
- theRange
Write(theDocument: CDM_Document, theOStream: Standard_OStream, theRange: Message_ProgressRange): void
Warning! raises DriverError if an error occurs during inside the Make method. stores the content of the Document into a new file.
by default Write will use Make method to build a persistent document and the Schema method to write the persistent document.
Parameters (3)
- theDocument
- theOStream
- theRange
SetFormat(aformat: TCollection_ExtendedString): void
Parameters (1)
- aformat
GetFormat(): TCollection_ExtendedString
IsError(): boolean
SetIsError(theIsError: boolean): void
Parameters (1)
- theIsError
GetStoreStatus(): PCDM_StoreStatus
SetStoreStatus(theStoreStatus: PCDM_StoreStatus): void
Parameters (1)
- theStoreStatus
DynamicType(): Standard_Type

PCDM_StoreStatus

Properties(9)

PCDM_SS_OK:'PCDM_SS_OK'readonly
PCDM_SS_DriverFailure:'PCDM_SS_DriverFailure'readonly
PCDM_SS_WriteFailure:'PCDM_SS_WriteFailure'readonly
PCDM_SS_Failure:'PCDM_SS_Failure'readonly
PCDM_SS_Doc_IsNull:'PCDM_SS_Doc_IsNull'readonly
PCDM_SS_No_Obj:'PCDM_SS_No_Obj'readonly
PCDM_SS_Info_Section_Error:'PCDM_SS_Info_Section_Error'readonly
PCDM_SS_UserBreak:'PCDM_SS_UserBreak'readonly
PCDM_SS_UnrecognizedFormat:'PCDM_SS_UnrecognizedFormat'readonly

PCDM_TypeOfFileDriver

Properties(4)

PCDM_TOFD_File:'PCDM_TOFD_File'readonly
PCDM_TOFD_CmpFile:'PCDM_TOFD_CmpFile'readonly
PCDM_TOFD_XmlFile:'PCDM_TOFD_XmlFile'readonly
PCDM_TOFD_Unknown:'PCDM_TOFD_Unknown'readonly

PCDM_Writer

Standard_Transient

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(2)

Write(aDocument: CDM_Document, aFileName: TCollection_ExtendedString, theRange: Message_ProgressRange): void
Parameters (3)
- aDocument
- aFileName
- theRange
DynamicType(): Standard_Type