Physicalize Method (_UADataSetWriterDescriptor)

Physicalizes the PubSub object descriptor, by removing the logical information from it.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Sub Physicalize( _
   ByVal transportProfileUriString As String, _
   ByVal assumeTopicTree As Boolean, _
   ByVal force As Boolean _
)

'Usage
 
Dim instance As _UADataSetWriterDescriptor
Dim transportProfileUriString As String
Dim assumeTopicTree As Boolean
Dim force As Boolean
 
instance.Physicalize(transportProfileUriString, assumeTopicTree, force)

void Physicalize( 
   string transportProfileUriString,
   bool assumeTopicTree,
   bool force
)

void Physicalize( 
   String^ transportProfileUriString,
   bool assumeTopicTree,
   bool force
)

Parameters

transportProfileUriString: The URI string of the PubSub transport profile.
The value of this parameter can be null (Nothing in Visual Basic).
assumeTopicTree: Determines whether the (standard) topic tree is used.
force: When true, the physicalization is performed even when the descriptor requires resolution.

Exceptions

Exception Description

Exception	Description
System.InvalidOperationException	A method call was invalid for the object's current state. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.InvalidOperationException

A method call was invalid for the object's current state.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

When force is false, it is only allowed to call this method on descriptors that do not require resolution. That is, the descriptor must already contain enough physical information for it to be usable. The physicalization then just removes the associated logical information that is not necessary in this descriptor.

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

_UADataSetWriterDescriptor Interface
_UADataSetWriterDescriptor Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.