Search
Preparing search index...
The search index is not available
OpenCascade.js - v2.0.0-beta.533428a
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
OpenCascade.js - v2.0.0-beta.533428a
AppStd_Application
Class AppStd_Application
Hierarchy
TDocStd_Application
AppStd_Application
Index
Constructors
constructor
Methods
Begin
Of
Update
Can
Close
Can
Retrieve_
1
Can
Retrieve_
2
Close
Decrement
Ref
Counter
Default
Folder
Define
Format
Delete
Dump
Json
Dynamic
Type
End
Of
Update
Format
Get
Document
Get
Ref
Count
Get
Retrieve
Status
Increment
Ref
Counter
Init
Document
Is
Driver
Loaded
Is
In
Session
Is
Instance_
1
Is
Instance_
2
Is
Kind_
1
Is
Kind_
2
Message
Driver
Meta
Data
Driver
Meta
Data
Look
Up
Table
Name
Nb
Documents
New
Document
New
Document_
1
New
Document_
2
On
Abort
Transaction
On
Commit
Transaction
On
Open
Transaction
Open
Open_
1
Open_
2
Open_
3
Open_
4
Read
Reader
From
Format
Reading
Formats
Resources
Resources
Name
Retrieve_
1
Retrieve_
2
Save
As_
1
Save
As_
2
Save
As_
3
Save
As_
4
Save_
1
Save_
2
Set
Default
Folder
This
Version
Write
Writer
From
Format
Writing
Formats
delete
Load
get_
type_
descriptor
get_
type_
name
Constructors
constructor
new
App
Std_
Application
(
)
:
AppStd_Application
Returns
AppStd_Application
Methods
Begin
Of
Update
Begin
Of
Update
(
aDocument
:
Handle_CDM_Document
)
:
void
Parameters
aDocument:
Handle_CDM_Document
Returns
void
Can
Close
Can
Close
(
aDocument
:
Handle_CDM_Document
)
:
CDM_CanCloseStatus
Parameters
aDocument:
Handle_CDM_Document
Returns
CDM_CanCloseStatus
Can
Retrieve_
1
Can
Retrieve_
1
(
theFolder
:
TCollection_ExtendedString
, theName
:
TCollection_ExtendedString
, theAppendMode
:
boolean
)
:
PCDM_ReaderStatus
Parameters
theFolder:
TCollection_ExtendedString
theName:
TCollection_ExtendedString
theAppendMode:
boolean
Returns
PCDM_ReaderStatus
Can
Retrieve_
2
Can
Retrieve_
2
(
theFolder
:
TCollection_ExtendedString
, theName
:
TCollection_ExtendedString
, theVersion
:
TCollection_ExtendedString
, theAppendMode
:
boolean
)
:
PCDM_ReaderStatus
Parameters
theFolder:
TCollection_ExtendedString
theName:
TCollection_ExtendedString
theVersion:
TCollection_ExtendedString
theAppendMode:
boolean
Returns
PCDM_ReaderStatus
Close
Close
(
aDoc
:
Handle_TDocStd_Document
)
:
void
Parameters
aDoc:
Handle_TDocStd_Document
Returns
void
Decrement
Ref
Counter
Decrement
Ref
Counter
(
)
:
Graphic3d_ZLayerId
Returns
Graphic3d_ZLayerId
Default
Folder
Default
Folder
(
)
:
Standard_ExtString
Returns
Standard_ExtString
Define
Format
Define
Format
(
theFormat
:
XCAFDoc_PartId
, theDescription
:
XCAFDoc_PartId
, theExtension
:
XCAFDoc_PartId
, theReader
:
Handle_PCDM_RetrievalDriver
, theWriter
:
Handle_PCDM_StorageDriver
)
:
void
Parameters
theFormat:
XCAFDoc_PartId
theDescription:
XCAFDoc_PartId
theExtension:
XCAFDoc_PartId
theReader:
Handle_PCDM_RetrievalDriver
theWriter:
Handle_PCDM_StorageDriver
Returns
void
Delete
Delete
(
)
:
void
Returns
void
Dump
Json
Dump
Json
(
theOStream
:
Standard_OStream
, theDepth
:
Graphic3d_ZLayerId
)
:
void
Parameters
theOStream:
Standard_OStream
theDepth:
Graphic3d_ZLayerId
Returns
void
Dynamic
Type
Dynamic
Type
(
)
:
Handle_Standard_Type
Returns
Handle_Standard_Type
End
Of
Update
End
Of
Update
(
aDocument
:
Handle_CDM_Document
, theStatus
:
boolean
, ErrorString
:
TCollection_ExtendedString
)
:
void
Parameters
aDocument:
Handle_CDM_Document
theStatus:
boolean
ErrorString:
TCollection_ExtendedString
Returns
void
Format
Format
(
aFileName
:
TCollection_ExtendedString
, theFormat
:
TCollection_ExtendedString
)
:
boolean
Parameters
aFileName:
TCollection_ExtendedString
theFormat:
TCollection_ExtendedString
Returns
boolean
Get
Document
Get
Document
(
index
:
Graphic3d_ZLayerId
, aDoc
:
Handle_TDocStd_Document
)
:
void
Parameters
index:
Graphic3d_ZLayerId
aDoc:
Handle_TDocStd_Document
Returns
void
Get
Ref
Count
Get
Ref
Count
(
)
:
Graphic3d_ZLayerId
Returns
Graphic3d_ZLayerId
Get
Retrieve
Status
Get
Retrieve
Status
(
)
:
PCDM_ReaderStatus
Returns
PCDM_ReaderStatus
Increment
Ref
Counter
Increment
Ref
Counter
(
)
:
void
Returns
void
Init
Document
Init
Document
(
aDoc
:
Handle_CDM_Document
)
:
void
Parameters
aDoc:
Handle_CDM_Document
Returns
void
Is
Driver
Loaded
Is
Driver
Loaded
(
)
:
boolean
Returns
boolean
Is
In
Session
Is
In
Session
(
path
:
TCollection_ExtendedString
)
:
Graphic3d_ZLayerId
Parameters
path:
TCollection_ExtendedString
Returns
Graphic3d_ZLayerId
Is
Instance_
1
Is
Instance_
1
(
theType
:
Handle_Standard_Type
)
:
boolean
Parameters
theType:
Handle_Standard_Type
Returns
boolean
Is
Instance_
2
Is
Instance_
2
(
theTypeName
:
string
)
:
boolean
Parameters
theTypeName:
string
Returns
boolean
Is
Kind_
1
Is
Kind_
1
(
theType
:
Handle_Standard_Type
)
:
boolean
Parameters
theType:
Handle_Standard_Type
Returns
boolean
Is
Kind_
2
Is
Kind_
2
(
theTypeName
:
string
)
:
boolean
Parameters
theTypeName:
string
Returns
boolean
Message
Driver
Message
Driver
(
)
:
Handle_Message_Messenger
Returns
Handle_Message_Messenger
Meta
Data
Driver
Meta
Data
Driver
(
)
:
Handle_CDF_MetaDataDriver
Returns
Handle_CDF_MetaDataDriver
Meta
Data
Look
Up
Table
Meta
Data
Look
Up
Table
(
)
:
CDM_MetaDataLookUpTable
Returns
CDM_MetaDataLookUpTable
Name
Name
(
)
:
TCollection_ExtendedString
Returns
TCollection_ExtendedString
Nb
Documents
Nb
Documents
(
)
:
Graphic3d_ZLayerId
Returns
Graphic3d_ZLayerId
New
Document
New
Document
(
theFormat
:
TCollection_ExtendedString
, theDoc
:
Handle_CDM_Document
)
:
void
Parameters
theFormat:
TCollection_ExtendedString
theDoc:
Handle_CDM_Document
Returns
void
New
Document_
1
New
Document_
1
(
format
:
TCollection_ExtendedString
, aDoc
:
Handle_CDM_Document
)
:
void
Parameters
format:
TCollection_ExtendedString
aDoc:
Handle_CDM_Document
Returns
void
New
Document_
2
New
Document_
2
(
format
:
TCollection_ExtendedString
, aDoc
:
Handle_TDocStd_Document
)
:
void
Parameters
format:
TCollection_ExtendedString
aDoc:
Handle_TDocStd_Document
Returns
void
On
Abort
Transaction
On
Abort
Transaction
(
theDoc
:
Handle_TDocStd_Document
)
:
void
Parameters
theDoc:
Handle_TDocStd_Document
Returns
void
On
Commit
Transaction
On
Commit
Transaction
(
theDoc
:
Handle_TDocStd_Document
)
:
void
Parameters
theDoc:
Handle_TDocStd_Document
Returns
void
On
Open
Transaction
On
Open
Transaction
(
theDoc
:
Handle_TDocStd_Document
)
:
void
Parameters
theDoc:
Handle_TDocStd_Document
Returns
void
Open
Open
(
aDocument
:
Handle_CDM_Document
)
:
void
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
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
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
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
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
Parameters
theIStream:
Standard_IStream
theDocument:
Handle_CDM_Document
theFilter:
Handle_PCDM_ReaderFilter
theRange:
Message_ProgressRange
Returns
void
Reader
From
Format
Reader
From
Format
(
aFormat
:
TCollection_ExtendedString
)
:
Handle_PCDM_Reader
Parameters
aFormat:
TCollection_ExtendedString
Returns
Handle_PCDM_Reader
Reading
Formats
Reading
Formats
(
theFormats
:
TColStd_SequenceOfAsciiString
)
:
void
Parameters
theFormats:
TColStd_SequenceOfAsciiString
Returns
void
Resources
Resources
(
)
:
Handle_Resource_Manager
Returns
Handle_Resource_Manager
Resources
Name
Resources
Name
(
)
:
string
Returns
string
Retrieve_
1
Retrieve_
1
(
aFolder
:
TCollection_ExtendedString
, aName
:
TCollection_ExtendedString
, UseStorageConfiguration
:
boolean
, theFilter
:
Handle_PCDM_ReaderFilter
, theRange
:
Message_ProgressRange
)
:
Handle_CDM_Document
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
Parameters
aFolder:
TCollection_ExtendedString
aName:
TCollection_ExtendedString
aVersion:
TCollection_ExtendedString
UseStorageConfiguration:
boolean
theFilter:
Handle_PCDM_ReaderFilter
theRange:
Message_ProgressRange
Returns
Handle_CDM_Document
Save
As_
1
Save
As_
1
(
theDoc
:
Handle_TDocStd_Document
, path
:
TCollection_ExtendedString
, theRange
:
Message_ProgressRange
)
:
PCDM_StoreStatus
Parameters
theDoc:
Handle_TDocStd_Document
path:
TCollection_ExtendedString
theRange:
Message_ProgressRange
Returns
PCDM_StoreStatus
Save
As_
2
Save
As_
2
(
theDoc
:
Handle_TDocStd_Document
, theOStream
:
Standard_OStream
, theRange
:
Message_ProgressRange
)
:
PCDM_StoreStatus
Parameters
theDoc:
Handle_TDocStd_Document
theOStream:
Standard_OStream
theRange:
Message_ProgressRange
Returns
PCDM_StoreStatus
Save
As_
3
Save
As_
3
(
theDoc
:
Handle_TDocStd_Document
, path
:
TCollection_ExtendedString
, theStatusMessage
:
TCollection_ExtendedString
, theRange
:
Message_ProgressRange
)
:
PCDM_StoreStatus
Parameters
theDoc:
Handle_TDocStd_Document
path:
TCollection_ExtendedString
theStatusMessage:
TCollection_ExtendedString
theRange:
Message_ProgressRange
Returns
PCDM_StoreStatus
Save
As_
4
Save
As_
4
(
theDoc
:
Handle_TDocStd_Document
, theOStream
:
Standard_OStream
, theStatusMessage
:
TCollection_ExtendedString
, theRange
:
Message_ProgressRange
)
:
PCDM_StoreStatus
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
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
Parameters
theDoc:
Handle_TDocStd_Document
theStatusMessage:
TCollection_ExtendedString
theRange:
Message_ProgressRange
Returns
PCDM_StoreStatus
Set
Default
Folder
Set
Default
Folder
(
aFolder
:
Standard_ExtString
)
:
boolean
Parameters
aFolder:
Standard_ExtString
Returns
boolean
This
This
(
)
:
Standard_Transient
Returns
Standard_Transient
Version
Version
(
)
:
XCAFDoc_PartId
Returns
XCAFDoc_PartId
Write
Write
(
aString
:
Standard_ExtString
)
:
void
Parameters
aString:
Standard_ExtString
Returns
void
Writer
From
Format
Writer
From
Format
(
aFormat
:
TCollection_ExtendedString
)
:
Handle_PCDM_StorageDriver
Parameters
aFormat:
TCollection_ExtendedString
Returns
Handle_PCDM_StorageDriver
Writing
Formats
Writing
Formats
(
theFormats
:
TColStd_SequenceOfAsciiString
)
:
void
Parameters
theFormats:
TColStd_SequenceOfAsciiString
Returns
void
delete
delete
(
)
:
void
Returns
void
Static
Load
Load
(
aGUID
:
Standard_GUID
)
:
Handle_CDF_Application
Parameters
aGUID:
Standard_GUID
Returns
Handle_CDF_Application
Static
get_
type_
descriptor
get_
type_
descriptor
(
)
:
Handle_Standard_Type
Returns
Handle_Standard_Type
Static
get_
type_
name
get_
type_
name
(
)
:
number
Returns
number
Exports
App
Std_
Application
constructor
Begin
Of
Update
Can
Close
Can
Retrieve_
1
Can
Retrieve_
2
Close
Decrement
Ref
Counter
Default
Folder
Define
Format
Delete
Dump
Json
Dynamic
Type
End
Of
Update
Format
Get
Document
Get
Ref
Count
Get
Retrieve
Status
Increment
Ref
Counter
Init
Document
Is
Driver
Loaded
Is
In
Session
Is
Instance_
1
Is
Instance_
2
Is
Kind_
1
Is
Kind_
2
Message
Driver
Meta
Data
Driver
Meta
Data
Look
Up
Table
Name
Nb
Documents
New
Document
New
Document_
1
New
Document_
2
On
Abort
Transaction
On
Commit
Transaction
On
Open
Transaction
Open
Open_
1
Open_
2
Open_
3
Open_
4
Read
Reader
From
Format
Reading
Formats
Resources
Resources
Name
Retrieve_
1
Retrieve_
2
Save
As_
1
Save
As_
2
Save
As_
3
Save
As_
4
Save_
1
Save_
2
Set
Default
Folder
This
Version
Write
Writer
From
Format
Writing
Formats
delete
Load
get_
type_
descriptor
get_
type_
name
Generated using
TypeDoc