Jump to content

MultiSegmentPipe class: Difference between revisions

From LabVIEW Wiki
VisualWikitext
Started page
 
m Removed VI Server Category from page
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{VIServerClass|name=MultiSegmentPipe|id=130|scope=basic|class_0=Generic|class_1=GObject|class_2=Control|class_3=MultiSegmentPipe}}
{{VIServerClass|130}}


{{stub}}
{{stub}}
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide MultiSegmentPipe Properties Table</span>
{{VIServerClassTables|130}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ MultiSegmentPipe Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|311C4C05
| [[MultiSegmentPipe class/Colors(2) property|Colors(2)]]
|Gets or sets the color of the Multi-Segment Pipe control.
 
The Multi-Segment Pipe control is a Boolean control that uses different colors to represent TRUE and FALSE values. Therefore, you can change the color of the pipe network to customize what the pipe network represents. For example, you might use the color blue to represent cold water and the color red to represent hot water flowing through the pipe network.
 
This property uses an array of two clusters, where each cluster contains a color pair, to represent the TRUE and FALSE values. Each color pair represents the foreground and background color of the control. You can set the color of the Multi-Segment Pipe control by wiring an array of two hexadecimal number pairs with the form RRGGBB or by wiring an array of two color box constant pairs to the property.
 
You also can set the colors interactively.
|R/W
|X
|- style="background-color:#FFFFCC;"
|311C4C02
| [[MultiSegmentPipe class/Flange1Depth property|Flange1Depth]]
|Gets or sets the depth of the flange that appears on the left end of a pipe network when you first place the Multi-Segment Pipe control on the front panel window.
 
The flange depth is the distance, in pixels, from the end of the adjoining pipe segment to the end of the flange. The maximum flange depth is 50 pixels. The minimum flange depth is four pixels. LabVIEW returns an error if you specify a value greater than the maximum or less than the minimum flange depth.
 
The following illustration shows the flange depth.
 
You also can set the flange depth interactively.
|R/W
|X
|- style="background-color:#FFFFCC;"
|311C4C00
| [[MultiSegmentPipe class/Flange1Width property|Flange1Width]]
|Gets or sets the width of the flange that appears on the left end of a pipe network when you first place the Multi-Segment Pipe control on the front panel window.
 
The flange width is the distance, in pixels, from the edge of the adjoining pipe segment to the edge of the flange. The maximum flange width is 500 pixels. The minimum flange width is one pixel. LabVIEW returns an error if you specify a value greater than the maximum or less than the minimum flange width.
 
The following illustration shows the flange width.
 
You also can set the flange width interactively.
|R/W
|X
|- style="background-color:#FFFFCC;"
|311C4C03
| [[MultiSegmentPipe class/Flange2Depth property|Flange2Depth]]
|Gets or sets the depth of the flange that appears on the right end of a pipe network when you first place the Multi-Segment Pipe control on the front panel window.
 
The flange depth is the distance, in pixels, from the end of the adjoining pipe segment to the end of the flange. The maximum flange depth is 50 pixels. The minimum flange depth is four pixels. LabVIEW returns an error if you specify a value greater than the maximum or less than the minimum flange depth.
 
The following illustration shows the flange depth.
 
You also can set the flange depth interactively.
|R/W
|X
|- style="background-color:#FFFFCC;"
|311C4C01
| [[MultiSegmentPipe class/Flange2Width property|Flange2Width]]
|Gets or sets the width of the flange that appears on the right end of a pipe network when you first place the Multi-Segment Pipe control on the front panel window.
 
The flange width is the distance, in pixels, from the edge of the adjoining pipe segment to the edge of the flange. The maximum flange width is 500 pixels. The minimum flange width is one pixel. LabVIEW returns an error if you specify a value greater than the maximum or less than the minimum flange width.
 
The following illustration shows the flange width.
 
You also can set the flange width interactively.
|R/W
|X
|- style="background-color:#FFFFCC;"
|311C4C04
| [[MultiSegmentPipe class/PipeRadius property|PipeRadius]]
|Gets or sets the radius of the pipe segments in a pipe network. All pipe segments in a pipe network have the same radius.
 
The pipe radius is the distance, in pixels, between the center of a pipe segment to the edge of the pipe segment. The maximum pipe radius is one pixel less than the radius of the narrowest flange. The radius of a flange is equal to the pipe radius plus the flange width. The minimum pipe radius is five pixels. LabVIEW returns an error if you specify a pipe radius greater than the maximum or less than the minimum pipe radius.
 
The following illustration shows the pipe radius.
 
You also can set the pipe radius interactively.
|R/W
|X
|}
</div>
 
==Methods==
''No Methods for this class.''
 
==Events==
''No Events for this class.''


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version
Line 113: Line 24:
*[[VI Server]]
*[[VI Server]]


[[Category:VI Server]]
 
[[Category:VI Server Class]]
[[Category:VI Server Class]]

Latest revision as of 02:03, 8 May 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name MultiSegmentPipe class
Class ID 130
Scope Basic Development Environment
Class Inheritance
Class Children

This class has no children.


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

The MultiSegmentPipe class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide MultiSegmentPipe Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
MultiSegmentPipe Properties Table
Property ID Long Name (English) Description R/W RTE
311C4C00Flange 1:WidthGets or sets the width of the flange that appears on the left end of a pipe network when you first place the Multi-Segment Pipe control on the front panel window.Read/WriteYes
311C4C01Flange 2:WidthGets or sets the width of the flange that appears on the right end of a pipe network when you first place the Multi-Segment Pipe control on the front panel window.Read/WriteYes
311C4C02Flange 1:DepthGets or sets the depth of the flange that appears on the left end of a pipe network when you first place the Multi-Segment Pipe control on the front panel window.Read/WriteYes
311C4C03Flange 2:DepthGets or sets the depth of the flange that appears on the right end of a pipe network when you first place the Multi-Segment Pipe control on the front panel window.Read/WriteYes
311C4C04Pipe RadiusGets or sets the radius of the pipe segments in a pipe network. All pipe segments in a pipe network have the same radius.Read/WriteYes
311C4C05Colors [2]Gets or sets the color of the Multi-Segment Pipe control.Read/WriteYes

Methods

This class has no methods or it inherits methods from its parent: Control Class.

Events

This class has no events or it inherits events from its parent: Control Class.


History

History information is needed. What changes have occurred over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=MultiSegmentPipe_class&oldid=26706"