OCC.Core.TDocStd module¶
TDocStd module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_tdocstd.html
-
class
SwigPyIterator
(*args, **kwargs)¶ Bases:
object
-
advance
()¶
-
copy
()¶
-
decr
()¶
-
distance
()¶
-
equal
()¶
-
incr
()¶
-
next
()¶
-
previous
()¶
-
property
thisown
¶ The membership flag
-
value
()¶
-
-
class
TDocStd_Application
(*args)¶ Bases:
OCC.Core.CDF.CDF_Application
- Constructs the new instance and registers it in CDM_Session
- rtype
None
-
Close
()¶ - Close the given document. the document is not any more handled by the applicative session.
- param aDoc
- type aDoc
TDocStd_Document
- rtype
None
-
DefineFormat
()¶ - Sets up resources and registers read and storage drivers for the specified format. @param theFormat - unique name for the format, used to identify it. @param theDescription - textual description of the format. @param theExtension - extension of the files in that format. The same extension can be used by several formats. @param theReader - instance of the read driver for the format. Null value is allowed (no possibility to read). @param theWriter - instance of the write driver for the format. Null value is allowed (no possibility to write).
- param theFormat
- type theFormat
TCollection_AsciiString
- param theDescription
- type theDescription
TCollection_AsciiString
- param theExtension
- type theExtension
TCollection_AsciiString
- param theReader
- type theReader
PCDM_RetrievalDriver
- param theWriter
- type theWriter
PCDM_StorageDriver
- rtype
None
-
static
DownCast
(t)¶
-
GetDocument
()¶ - Constructs the new document aDoc. aDoc is identified by the index index which is any integer between 1 and n where n is the number of documents returned by NbDocument. Example opencascade::handle<TDocStd_Application> anApp; if (!CafTest::Find(A)) return 1; opencascade::handle<TDocStd> aDoc; Standard_Integer nbdoc = anApp->NbDocuments(); for (Standard_Integer i = 1; i <= nbdoc; i++) { aApp->GetDocument(i,aDoc);
- param index
- type index
int
- param aDoc
- type aDoc
TDocStd_Document
- rtype
None
-
InitDocument
()¶ - Initialize the document aDoc for the applicative session. This virtual function is called by NewDocument and is to be redefined for each specific application. Modified flag (different of disk version) ============= to open/save a document =======================
- param aDoc
- type aDoc
TDocStd_Document
- rtype
void
-
IsDriverLoaded
()¶ - Check if meta data driver was successfully loaded by the application constructor
- rtype
bool
-
IsInSession
()¶ - Returns an index for the document found in the path path in this applicative session. If the returned value is 0, the document is not present in the applicative session. This method can be used for the interactive part of an application. For instance, on a call to Open, the document to be opened may already be in memory. IsInSession checks to see if this is the case. Open can be made to depend on the value of the index returned: if IsInSession returns 0, the document is opened; if it returns another value, a message is displayed asking the user if he wants to override the version of the document in memory. Example: Standard_Integer insession = A->IsInSession(aDoc); if (insession > 0) { std::cout << ‘document ‘ << insession << ‘ is already in session’ << std::endl; return 0; }
- param path
- type path
TCollection_ExtendedString
- rtype
int
-
NbDocuments
()¶ - returns the number of documents handled by the current applicative session.
- rtype
int
-
NewDocument
()¶ - Constructs the empty new document aDoc. This document will have the format format. If InitDocument is redefined for a specific application, the new document is handled by the applicative session.
- param format
- type format
TCollection_ExtendedString
- param aDoc
- type aDoc
TDocStd_Document
- rtype
void
-
OnAbortTransaction
()¶ - Notification that is fired at each AbortTransaction event.
- param theDoc
- type theDoc
TDocStd_Document
- rtype
void
-
OnCommitTransaction
()¶ - Notification that is fired at each CommitTransaction event.
- param theDoc
- type theDoc
TDocStd_Document
- rtype
void
-
OnOpenTransaction
()¶ - Notification that is fired at each OpenTransaction event.
- param theDoc
- type theDoc
TDocStd_Document
- rtype
void
-
Open
()¶ - Retrieves the document aDoc stored under the name aName in the directory directory. In order not to override a version of aDoc which is already in memory, this method can be made to depend on the value returned by IsInSession.
- param path
- type path
TCollection_ExtendedString
- param aDoc
- type aDoc
TDocStd_Document
- rtype
PCDM_ReaderStatus* Retrieves aDoc from standard SEEKABLE stream theIStream. the stream should support SEEK fuctionality
- param theIStream
- type theIStream
Standard_IStream
- param theDoc
- type theDoc
TDocStd_Document
- rtype
PCDM_ReaderStatus
-
ReadingFormats
()¶ - Returns the sequence of reading formats supported by the application. //! @param theFormats - sequence of reading formats. Output parameter.
- param theFormats
- type theFormats
TColStd_SequenceOfAsciiString
- rtype
None
-
ResourcesName
()¶ - Returns the name of the file containing the resources of this application, for support of legacy method of loading formats data from resource files. //! Method DefineFormat() can be used to define all necessary parameters explicitly without actually using resource files. //! In a resource file, the application associates the schema name of the document with the storage and retrieval plug-ins that are to be loaded for each document. On retrieval, the application reads the schema name in the heading of the CSF file and loads the plug-in indicated in the resource file. This plug-in instantiates the actual driver for transient-persistent conversion. Your application can bring this process into play by defining a class which inherits CDF_Application and redefines the function which returns the appropriate resources file. At this point, the function Retrieve and the class CDF_Store can be called. This allows you to deal with storage and retrieval of - as well as copying and pasting - documents. To implement a class like this, several virtual functions should be redefined. In particular, you must redefine the abstract function Resources inherited from the superclass CDM_Application. //! Default implementation returns empty string.
- rtype
char *
-
Save
()¶ - Save aDoc active document. Exceptions: Standard_NotImplemented if the document was not retrieved in the applicative session by using Open.
- param aDoc
- type aDoc
TDocStd_Document
- rtype
PCDM_StoreStatus* Save the document overwriting the previous file
- param aDoc
- type aDoc
TDocStd_Document
- param theStatusMessage
- type theStatusMessage
TCollection_ExtendedString
- rtype
PCDM_StoreStatus
-
SaveAs
()¶ - Save the active document in the file <name> in the path <path> ; o verwrites the file if it already exists.
- param aDoc
- type aDoc
TDocStd_Document
- param path
- type path
TCollection_ExtendedString
- rtype
PCDM_StoreStatus* Save theDoc to standard SEEKABLE stream theOStream. the stream should support SEEK fuctionality
- param theDoc
- type theDoc
TDocStd_Document
- param theOStream
- type theOStream
Standard_OStream
- rtype
PCDM_StoreStatus* Save the active document in the file <name> in the path <path> . overwrite the file if it already exist.
- param aDoc
- type aDoc
TDocStd_Document
- param path
- type path
TCollection_ExtendedString
- param theStatusMessage
- type theStatusMessage
TCollection_ExtendedString
- rtype
PCDM_StoreStatus* Save theDoc TO standard SEEKABLE stream theOStream. the stream should support SEEK fuctionality
- param theDoc
- type theDoc
TDocStd_Document
- param theOStream
- type theOStream
Standard_OStream
- param theStatusMessage
- type theStatusMessage
TCollection_ExtendedString
- rtype
PCDM_StoreStatus
-
WritingFormats
()¶ - Returns the sequence of writing formats supported by the application. //! @param theFormats - sequence of writing formats. Output parameter.
- param theFormats
- type theFormats
TColStd_SequenceOfAsciiString
- rtype
None
-
property
thisown
¶ The membership flag
-
class
TDocStd_ApplicationDelta
(*args)¶ Bases:
OCC.Core.Standard.Standard_Transient
- Return type
-
static
DownCast
(t)¶
-
DumpToString
(TDocStd_ApplicationDelta self) → std::string¶
-
GetDocuments
()¶ - Return type
-
GetName
()¶ - Return type
-
SetName
()¶ - Parameters
theName –
- type theName
TCollection_ExtendedString
- rtype
None
-
property
thisown
¶ The membership flag
-
class
TDocStd_CompoundDelta
(*args)¶ Bases:
OCC.Core.TDF.TDF_Delta
- Creates a compound delta. Validates <self> at <aBeginTime>. If applied, it restores the TDF_Data in the state it was at <anEndTime>. Reserved to TDF_Data.
- rtype
None
-
static
DownCast
(t)¶
-
property
thisown
¶ The membership flag
-
class
TDocStd_Context
(*args)¶ Bases:
object
- Return type
-
SetModifiedReferences
()¶ - Parameters
Mod –
- type Mod
bool
- rtype
None
-
property
thisown
¶ The membership flag
-
class
TDocStd_Document
(*args)¶ Bases:
OCC.Core.CDM.CDM_Document
- Constructs a document object defined by the string astorageformat.
- param astorageformat
- type astorageformat
TCollection_ExtendedString
- rtype
None
-
AbortCommand
()¶ - Abort the Command transaction. Does nothing If there is no Command transaction open.
- rtype
None
-
BeforeClose
()¶ - Prepares document for closing
- rtype
void
-
ChangeStorageFormat
()¶ - methods for the nested transaction mode
- param newStorageFormat
- type newStorageFormat
TCollection_ExtendedString
- rtype
void
-
ClearRedos
()¶ - Remove all stored Redos
- rtype
None
-
ClearUndos
()¶ - Remove all stored Undos and Redos
- rtype
None
-
CommitCommand
()¶ - Commits documents transactions and fills the transaction manager with documents that have been changed during the transaction. If no command transaction is open, nothing is done. Returns True if a new delta has been added to myUndos.
- rtype
bool
-
static
DownCast
(t)¶
-
EmptyLabelsSavingMode
()¶ - Returns saving mode for empty labels.
- rtype
bool
-
static
Get
()¶ - Will Abort any execution, clear fields returns the document which contains <L>. raises an exception if the document is not found.
- param L
- type L
TDF_Label
- rtype
opencascade::handle<TDocStd_Document>
-
GetAvailableRedos
()¶ - Returns the number of redos stored in this document. If this figure is greater than 0, the method Redo can be used.
- rtype
int
-
GetAvailableUndos
()¶ - Returns the number of undos stored in this document. If this figure is greater than 0, the method Undo can be used.
- rtype
int
-
GetData
()¶ - Return type
opencascade::handle<TDF_Data>
-
GetModified
()¶ - Returns the labels which have been modified in this document.
- rtype
TDF_LabelMap
-
GetName
()¶ - raise if <self> is not saved.
- rtype
TCollection_ExtendedString
-
GetPath
()¶ - returns the OS path of the file, in wich one <self> is saved. Raise an exception if <self> is not saved.
- rtype
TCollection_ExtendedString
-
GetRedos
()¶ - Return type
-
GetSavedTime
()¶ - Returns value of <mySavedTime> to be used later in SetSavedTime()
- rtype
int
-
GetUndoLimit
()¶ - The current limit on the number of undos
- rtype
int
-
GetUndos
()¶ - Return type
-
HasOpenCommand
()¶ - returns True if a Command transaction is open in the curret .
- rtype
bool
-
InitDeltaCompaction
()¶ - Initializes the procedure of delta compaction Returns false if there is no delta to compact Marks the last delta as a ‘from’ delta
- rtype
bool
-
IsChanged
()¶ - returns True if document differs from the state of last saving. this method have to be called only wroking in the transaction mode
- rtype
bool
-
IsEmpty
()¶ - Returns True if the main label has no attributes
- rtype
bool
-
IsNestedTransactionMode
()¶ - Returns Standard_True if mode is set
- rtype
bool
-
IsSaved
()¶ - the document is saved in a file.
- rtype
bool
-
IsValid
()¶ - Returns False if the document has been modified but not recomputed.
- rtype
bool
-
Main
()¶ - Returns the main label in this data framework. By definition, this is the label with the entry 0:1.
- rtype
TDF_Label
-
ModificationMode
()¶ - returns True if changes allowed only inside transactions
- rtype
bool
-
NewCommand
()¶ - Launches a new command. This command may be undone.
- rtype
None
-
OpenCommand
()¶ - Opens a new command transaction in this document. You can use HasOpenCommand to see whether a command is already open. Exceptions Standard_DomainError if a command is already open in this document.
- rtype
None
-
PerformDeltaCompaction
()¶ - Performs the procedure of delta compaction Makes all deltas starting from ‘from’ delta till the last one to be one delta.
- rtype
bool
-
PurgeModified
()¶ - Remove all modifications. After this call The document becomesagain Valid.
- rtype
None
-
Recompute
()¶ - Recompute if the document was not valid and propagate the reccorded modification.
- rtype
None
-
Redo
()¶ - Will REDO one step, returns False if no redo was done (Redos == 0). Otherwise, true is returned, and one step in the list of redoes is done again.
- rtype
bool
-
RemoveFirstUndo
()¶ - Removes the first undo in the list of document undos. It is used in the application when the undo limit is exceed.
- rtype
None
-
SetData
()¶ - Parameters
data –
- type data
TDF_Data
- rtype
None
-
SetEmptyLabelsSavingMode
()¶ - Sets saving mode for empty labels. If Standard_True, empty labels will be saved.
- param isAllowed
- type isAllowed
bool
- rtype
None
-
SetModificationMode
()¶ - if theTransactionOnly is True changes is denied outside transactions
- param theTransactionOnly
- type theTransactionOnly
bool
- rtype
None
-
SetModified
()¶ - Notify the label as modified, the Document becomes UnValid. returns True if <L> has been notified as modified.
- param L
- type L
TDF_Label
- rtype
None
-
SetNestedTransactionMode
()¶ - Sets nested transaction mode if isAllowed == Standard_True
- param isAllowed
default value is Standard_True
- type isAllowed
bool
- rtype
None
-
SetSaved
()¶ - This method have to be called to show document that it has been saved
- rtype
None
-
SetSavedTime
()¶ - Say to document what it is not saved. Use value, returned earlier by GetSavedTime().
- param theTime
- type theTime
int
- rtype
None
-
SetUndoLimit
()¶ - Set the limit on the number of Undo Delta stored 0 will disable Undo on the document A negative value means no limit. Note that by default Undo is disabled. Enabling it will take effect with the next call to NewCommand. Of course this limit is the same for Redo
- param L
- type L
int
- rtype
None
-
Undo
()¶ - Will UNDO one step, returns False if no undo was done (Undos == 0). Otherwise, true is returned and one step in the list of undoes is undone.
- rtype
bool
-
UpdateReferences
()¶ - Set modifications on labels impacted by external references to the entry. The document becomes invalid and must be recomputed.
- param aDocEntry
- type aDocEntry
TCollection_AsciiString
- rtype
None
-
property
thisown
¶ The membership flag
-
class
TDocStd_LabelIDMapDataMap
(*args)¶ Bases:
object
-
Assign
()¶
-
Bind
()¶
-
Bound
()¶
-
ChangeFind
()¶
-
ChangeSeek
()¶
-
Clear
()¶
-
Exchange
()¶
-
Find
()¶
-
IsBound
()¶
-
ReSize
()¶
-
Seek
()¶
-
Set
()¶
-
Size
()¶
-
UnBind
()¶
-
begin
()¶
-
cbegin
()¶
-
cend
()¶
-
end
()¶
-
property
thisown
¶ The membership flag
-
-
class
TDocStd_Modified
(*args)¶ Bases:
OCC.Core.TDF.TDF_Attribute
- Return type
-
static
Add
()¶ - Parameters
alabel –
- type alabel
TDF_Label
- rtype
bool
-
AddLabel
()¶ - add <L> as modified
- param L
- type L
TDF_Label
- rtype
bool
-
Clear
()¶ - remove all modified labels. becomes empty
- param access
- type access
TDF_Label
- rtype
void:rtype: None
-
static
Contains
()¶ - Parameters
alabel –
- type alabel
TDF_Label
- rtype
bool
-
static
DownCast
(t)¶
-
DumpToString
(TDocStd_Modified self) → std::string¶
-
Get
()¶ - if <IsEmpty> raise an exception.
- param access
- type access
TDF_Label
- rtype
TDF_LabelMap* returns modified label map
- rtype
TDF_LabelMap
-
static
GetID
()¶ - Modified methods ================
- rtype
Standard_GUID
-
IsEmpty
()¶ - API class methods =================
- param access
- type access
TDF_Label
- rtype
bool:rtype: bool
-
static
Remove
()¶ - Parameters
alabel –
- type alabel
TDF_Label
- rtype
bool
-
RemoveLabel
()¶ - remove <L> as modified
- param L
- type L
TDF_Label
- rtype
bool
-
property
thisown
¶ The membership flag
-
class
TDocStd_MultiTransactionManager
(*args)¶ Bases:
OCC.Core.Standard.Standard_Transient
- Constructor
- rtype
None
-
AbortCommand
()¶ - Unsets the flag of started manager transaction and aborts transaction in each document.
- rtype
None
-
AddDocument
()¶ - Adds the document to the transaction manager and checks if it has been already added
- param theDoc
- type theDoc
TDocStd_Document
- rtype
None
-
ClearRedos
()¶ - Clears redos in the manager and in documents.
- rtype
None
-
ClearUndos
()¶ - Clears undos in the manager and in documents.
- rtype
None
-
CommitCommand
()¶ - Commits transaction in all documents and fills the transaction manager with the documents that have been changed during the transaction. Returns True if new data has been added to myUndos. NOTE: All nested transactions in the documents will be commited.
- rtype
bool* Makes the same steps as the previous function but defines the name for transaction. Returns True if new data has been added to myUndos.
- param theName
- type theName
TCollection_ExtendedString
- rtype
bool
-
Documents
()¶ - Returns the added documents to the transaction manager.
- rtype
TDocStd_SequenceOfDocument
-
static
DownCast
(t)¶
-
DumpTransactionToString
(TDocStd_MultiTransactionManager self) → std::string¶
-
GetAvailableRedos
()¶ - Returns available manager redos.
- rtype
TDocStd_SequenceOfApplicationDelta
-
GetAvailableUndos
()¶ - Returns available manager undos.
- rtype
TDocStd_SequenceOfApplicationDelta
-
GetUndoLimit
()¶ - Returns undo limit for the manager.
- rtype
int
-
HasOpenCommand
()¶ - Returns true if a transaction is opened.
- rtype
bool
-
IsNestedTransactionMode
()¶ - Returns Standard_True if NestedTransaction mode is set. Methods for protection of changes outside transactions
- rtype
bool
-
ModificationMode
()¶ - Returns True if changes are allowed only inside transactions.
- rtype
bool
-
OpenCommand
()¶ - Opens transaction in each document and sets the flag that transaction is opened. If there are already opened transactions in the documents, these transactions will be aborted before openning new ones.
- rtype
None
-
Redo
()¶ - Redoes the current transaction of the application. It calls the Redo () method of the document being on top of the manager list of redos (list.First()) and moves the list item to the top of the list of manager undos (list.Prepend(item)).
- rtype
None
-
RemoveDocument
()¶ - Removes the document from the transaction manager.
- param theDoc
- type theDoc
TDocStd_Document
- rtype
None
-
RemoveLastUndo
()¶ - Removes undo information from the list of undos of the manager and all documents which have been modified during the transaction.
- rtype
None
-
SetModificationMode
()¶ - If theTransactionOnly is True, denies all changes outside transactions.
- param theTransactionOnly
- type theTransactionOnly
bool
- rtype
None
-
SetNestedTransactionMode
()¶ - Sets nested transaction mode if isAllowed == Standard_True NOTE: field myIsNestedTransactionMode exists only for synchronization between several documents and has no effect on transactions of multitransaction manager.
- param isAllowed
default value is Standard_True
- type isAllowed
bool
- rtype
None
-
SetUndoLimit
()¶ - Sets undo limit for the manager and all documents.
- param theLimit
- type theLimit
int
- rtype
None
-
Undo
()¶ - Undoes the current transaction of the manager. It calls the Undo () method of the document being on top of the manager list of undos (list.First()) and moves the list item to the top of the list of manager redos (list.Prepend(item)).
- rtype
None
-
property
thisown
¶ The membership flag
-
class
TDocStd_Owner
(*args)¶ Bases:
OCC.Core.TDF.TDF_Attribute
- Return type
-
static
DownCast
(t)¶
-
DumpToString
(TDocStd_Owner self) → std::string¶
-
GetDocument
()¶ - Owner methods ===============
- param ofdata
- type ofdata
TDF_Data
- rtype
opencascade::handle<TDocStd_Document>:rtype: opencascade::handle<TDocStd_Document>
-
static
GetID
()¶ - class methods =============
- rtype
Standard_GUID
-
SetDocument
()¶ - Parameters
indata –
- type indata
TDF_Data
- param doc
- type doc
TDocStd_Document
- rtype
void:param document:
- type document
TDocStd_Document
- rtype
None
-
property
thisown
¶ The membership flag
-
class
TDocStd_PathParser
(*args)¶ Bases:
object
- Parameters
path –
- type path
TCollection_ExtendedString
- rtype
None
-
Extension
()¶ - Return type
-
Name
()¶ - Return type
-
Path
()¶ - Return type
-
Trek
()¶ - Return type
-
property
thisown
¶ The membership flag
-
class
TDocStd_SequenceOfApplicationDelta
(*args)¶ Bases:
object
-
Append
()¶
-
Assign
()¶
-
ChangeFirst
()¶
-
ChangeLast
()¶
-
ChangeValue
()¶
-
Clear
()¶
-
Exchange
()¶
-
First
()¶
-
InsertAfter
()¶
-
InsertBefore
()¶
-
IsEmpty
()¶
-
Last
()¶
-
Length
()¶
-
Lower
()¶
-
Prepend
()¶
-
Remove
()¶
-
Reverse
()¶
-
Set
()¶
-
SetValue
()¶
-
Size
()¶
-
Split
()¶
-
Upper
()¶
-
Value
()¶
-
begin
()¶
-
cbegin
()¶
-
cend
()¶
-
static
delNode
()¶
-
end
()¶
-
property
thisown
¶ The membership flag
-
-
class
TDocStd_SequenceOfDocument
(*args)¶ Bases:
object
-
Append
()¶
-
Assign
()¶
-
ChangeFirst
()¶
-
ChangeLast
()¶
-
ChangeValue
()¶
-
Clear
()¶
-
Exchange
()¶
-
First
()¶
-
InsertAfter
()¶
-
InsertBefore
()¶
-
IsEmpty
()¶
-
Last
()¶
-
Length
()¶
-
Lower
()¶
-
Prepend
()¶
-
Remove
()¶
-
Reverse
()¶
-
Set
()¶
-
SetValue
()¶
-
Size
()¶
-
Split
()¶
-
Upper
()¶
-
Value
()¶
-
begin
()¶
-
cbegin
()¶
-
cend
()¶
-
static
delNode
()¶
-
end
()¶
-
property
thisown
¶ The membership flag
-
-
class
TDocStd_XLink
(*args)¶ Bases:
OCC.Core.TDF.TDF_Attribute
- Initializes fields.
- rtype
None
-
DocumentEntry
()¶ - Sets the name aDocEntry for the external document in this external link attribute.
- param aDocEntry
- type aDocEntry
TCollection_AsciiString
- rtype
None* Returns the contents of the document identified by aDocEntry. aDocEntry provides external data to this external link attribute.
- rtype
TCollection_AsciiString
-
static
DownCast
(t)¶
-
DumpToString
(TDocStd_XLink self) → std::string¶
-
static
GetID
()¶ - Returns the GUID for external links.
- rtype
Standard_GUID
-
LabelEntry
()¶ - Sets the label entry for this external link attribute with the label aLabel. aLabel pilots the importation of data from the document entry.
- param aLabel
- type aLabel
TDF_Label
- rtype
None* Sets the label entry for this external link attribute as a document identified by aLabEntry.
- param aLabEntry
- type aLabEntry
TCollection_AsciiString
- rtype
None* Returns the contents of the field <myLabelEntry>.
- rtype
TCollection_AsciiString
-
static
Set
()¶ - Sets an empty external reference, at the label aLabel.
- param atLabel
- type atLabel
TDF_Label
- rtype
opencascade::handle<TDocStd_XLink>
-
Update
()¶ - Updates the data referenced in this external link attribute.
- rtype
opencascade::handle<TDF_Reference>
-
property
thisown
¶ The membership flag
-
class
TDocStd_XLinkIterator
(*args)¶ Bases:
object
- Returns an empty iterator;
- rtype
None* Creates an iterator on Reference of <D>.
- param D
- type D
TDocStd_Document
- rtype
None
-
Initialize
()¶ - Restarts an iteration with <D>.
- param D
- type D
TDocStd_Document
- rtype
None
-
More
()¶ - Returns True if there is a current Item in the iteration.
- rtype
bool
-
Next
()¶ - Move to the next item; raises if there is no more item.
- rtype
None
-
Value
()¶ - Returns the current item; a null handle if there is none.
- rtype
TDocStd_XLinkPtr
-
property
thisown
¶ The membership flag
-
class
TDocStd_XLinkRoot
(*args, **kwargs)¶ Bases:
OCC.Core.TDF.TDF_Attribute
Empty constructor
- Return type
None* Copy constructor – does nothing
- Parameters
& (Standard_Transient) –
- Return type
-
static
DownCast
(t)¶
-
DumpToString
(TDocStd_XLinkRoot self) → std::string¶
-
static
GetID
()¶ - Returns the ID: 2a96b61d-ec8b-11d0-bee7-080009dc3333
- rtype
Standard_GUID
-
static
Insert
()¶ - Inserts <anXLinkPtr> at the beginning of the XLink chain.
- param anXLinkPtr
- type anXLinkPtr
TDocStd_XLinkPtr
- rtype
void
-
static
Remove
()¶ - Removes <anXLinkPtr> from the XLink chain, if it exists.
- param anXLinkPtr
- type anXLinkPtr
TDocStd_XLinkPtr
- rtype
void
-
static
Set
()¶ - Sets an empty XLinkRoot to Root or gets the existing one. Only one attribute per TDF_Data.
- param aDF
- type aDF
TDF_Data
- rtype
opencascade::handle<TDocStd_XLinkRoot>
-
property
thisown
¶ The membership flag
-
class
TDocStd_XLinkTool
(*args)¶ Bases:
object
- Return type
-
Copy
()¶ - Copy the content of <fromsource> under <intarget>. Noone link is registred. noone check is done. Example opencascade::handle<TDocStd_Document> DOC, XDOC; TDF_Label L, XL; TDocStd_XLinkTool xlinktool; xlinktool.Copy(L,XL); Exceptions: Standard_DomainError if the contents of fromsource are not entirely in the scope of this label, in other words, are not self-contained. !!! ==> Warning: If the document manages shapes use the next way: TDocStd_XLinkTool xlinktool; xlinktool.Copy(L,XL); TopTools_DataMapOfShapeShape M; TNaming::ChangeShapes(target,M);
- param intarget
- type intarget
TDF_Label
- param fromsource
- type fromsource
TDF_Label
- rtype
void
-
CopyWithLink
()¶ - Copies the content of the label <fromsource> to the label <intarget>. The link is registred with an XLink attribute by <intarget> label. if the content of <fromsource> is not self-contained, and/or <intarget> has already an XLink attribute, an exception is raised.
- param intarget
- type intarget
TDF_Label
- param fromsource
- type fromsource
TDF_Label
- rtype
None
-
DataSet
()¶ - Return type
opencascade::handle<TDF_DataSet>
-
RelocationTable
()¶ - Return type
opencascade::handle<TDF_RelocationTable>
-
UpdateLink
()¶ - Update the external reference set at <L>. Example opencascade::handle<TDocStd_Document> aDoc; if (!OCAFTest::GetDocument(1,aDoc)) return 1; opencascade::handle<TDataStd_Reference> aRef; TDocStd_XLinkTool xlinktool; if (!OCAFTest::Find(aDoc,2),TDataStd_Reference::GetID(),aRef) return 1; xlinktool.UpdateLink(aRef->Label()); Exceptions Standard_DomainError if <L> has no XLink attribute.
- param L
- type L
TDF_Label
- rtype
None
-
property
thisown
¶ The membership flag
-
class
tdocstd
¶ Bases:
object
-
static
IDList
()¶ - specific GUID of this package ============================= Appends to <anIDList> the list of the attributes IDs of this package. CAUTION: <anIDList> is NOT cleared before use.
- param anIDList
- type anIDList
TDF_IDList
- rtype
void
-
property
thisown
¶ The membership flag
-
static