realvirtual.PLCOutputBool Class Reference

PLC Boolean Output Signal - Represents a boolean output signal from PLC to simulation. More...

Inheritance diagram for realvirtual.PLCOutputBool:

Public Member Functions
override void	OnToggleHierarchy ()
	Virtual for toogle in hierarhy view.
override void	SetStatusConnected (bool status)
	Virtual for setting the Status to connected.
override bool	GetStatusConnected ()
	Virtual for getting the connected Status.
override string	GetVisuText ()
	Virtual for getting the text for the Hierarchy View.
override byte[]	GetByteValue ()
override int	GetByteSize ()
override void	SetValue (string value)
	Virtual for setting the value.
override void	SetValue (object value)
	Sets the value of the signal.
override object	GetValue ()
	Gets the value of the signal.
void	SetValue (bool value)
override void	SetValue (byte[] value)
void	FixedUpdate ()
Public Member Functions inherited from realvirtual.Signal
delegate void	OnSignalChangedDelegate (Signal obj)
void	OnInspectValueChanged ()
bool	OnObjectDrop (Object reference)
void	OnInspectedToggleChanged (bool arg0)
string	GetSignalName ()
virtual bool	IsInput ()
	Virtual for getting information if the signal is an Input.
void	Unforce ()
	Unforces the signal.
void	DeleteSignalConnectionInfos ()
void	AddSignalConnectionInfo (GameObject behavior, string connectionname)
bool	IsConnectedToBehavior ()
	Returns true if InterfaceSignal is connected to any Behavior Script.
string	GetTypeString ()
	Returns the type of the Signal as a String.
InterfaceSignal	GetInterfaceSignal ()
	Returns an InterfaceSignal Object based on the Signal Component.
void	SetMetadata (string key, object value)
	Set metadata value for this signal.
T	GetMetadata< T > (string key, T defaultValue=default(T))
	Get metadata value with automatic type conversion.
bool	HasMetadata (string key)
	Check if metadata key exists for this signal.
void	RemoveMetadata (string key)
	Remove metadata key from this signal.
IEnumerable< string >	GetMetadataKeys ()
	Get all metadata keys for this signal.
Public Member Functions inherited from realvirtual.realvirtualBehavior
virtual void	OnOwnershipChanged (bool isOwner)
	Called when network ownership changes.
void	SetNetworkOwner (bool isOwner)
	Sets IsNetworkOwner and triggers OnOwnershipChanged callback.
void	PreStartSim ()
	Is called by the realvirtualController before the component is started.
void	StartSim ()
	Is called by the realvirtualController to start or stop the component.
void	StopSim ()
Vector3	DirectionToVector (DIRECTION direction)
	Transfers the direction enumeration to a vector.
DIRECTION	VectorToDirection (bool torotatoin, Vector3 vector)
	Transfers a vector to the direction enumeration.
float	GetLocalScale (Transform thetransform, DIRECTION direction)
List< BehaviorInterfaceConnection >	UpdateConnectionInfo ()
List< Signal >	GetConnectedSignals ()
void	SetVisibility (bool visibility)
	Sets the visibility of this object including all subobjects.
List< BehaviorInterfaceConnection >	GetConnections ()
List< Signal >	GetSignals ()
GameObject	GetChildByName (string name)
	Gets a child by name.
List< GameObject >	GetChildsByName (string name)
	Gets all child by name.
GameObject	GetChildByNameAlsoHidden (string name)
List< GameObject >	GetAllMeshesWithGroup (string group)
List< GameObject >	GetAllWithGroup (string group)
List< GameObject >	GetAllWithGroups (List< string > groups)
List< GameObject >	GetAllMeshesWithGroups (List< string > groups)
List< string >	GetMyGroups ()
List< GameObject >	GetMeshesWithSameGroups ()
List< GameObject >	GetAllWithSameGroups ()
MeshRenderer	GetMeshRenderer ()
	Gets the mesh renderers in the childrens.
void	SetCollider (bool enabled, bool includeTriggers=true)
	sets the collider in all child objects
void	ErrorMessage (string message)
	Displays an error message.
void	ChangeConnectionMode (bool isconnected)
void	Log (string message)
	Logs a message.
void	Log (string message, object obj)
	Logs a message with a relation to an object.
void	Warning (string message, object obj)
	Logs a warning with a relation to an object.
void	Error (string message, object obj)
	Logs an error with a relation to an object.
void	Error (string message)
	Logs an error.
GameObject	DebugPosition (string debugname, Vector3 position, Quaternion quaternation, float scale)
	Displays a gizmo for debugging positions.
void	SetFreezePosition (bool enabled)
	Freezes all child components to the current poosition.
void	SetRbConstraints (RigidbodyConstraints constraints)
virtual void	AwakeAlsoDeactivated ()

Public Attributes
StatusBool	Status
bool	ChangedToTrue
bool	ChangedToFalse
Public Attributes inherited from realvirtual.Signal
string	Comment
string	OriginDataType
SettingsSignal	Settings
SignalEvent	EventSignalChanged
bool	Autoconnected
bool	UpdateEnable
List< Connection >	ConnectionInfo
InterfaceSignal	interfacesignal
SignalMetadata	Metadata
	Metadata for PLC communication and interface configuration.
Public Attributes inherited from realvirtual.realvirtualBehavior
string	Name
	The name of the component if it should be different from the GameObject name.
ActiveOnly	Active
GameObject	FromTemplate
realvirtualController	realvirtualController
bool	HideNonG44Components
bool	SceneIsAdditive
bool	ForceStop
bool	IsNetworkOwner
	True when this component owns its simulation (local authority). Set to false by MultiplayerWEB on remote clients.

Properties
bool	Value [get, set]

Additional Inherited Members
Public Types inherited from realvirtual.realvirtualBehavior
enum	ActiveOnly {   Always , Connected , Disconnected , Never ,   DontChange }
Static Public Member Functions inherited from realvirtual.realvirtualBehavior
static bool	DirectionIsLinear (DIRECTION direction)
	Gets back if the direction is linear or a rotation.
Protected Member Functions inherited from realvirtual.Signal
void	SignalChangedEvent (Signal signal)
new bool	hidename ()
Protected Member Functions inherited from realvirtual.realvirtualBehavior
bool	hidename ()
bool	hideactiveonly ()
virtual void	OnStopSim ()
virtual void	OnPreStartSim ()
virtual void	OnStartSim ()
MU	GetTopOfMu (GameObject obj)
	Gets the top of an MU component (the first MU script going up in the hierarchy)
void	InitGame4Automation ()
	Initialiates the components and gets the reference to the realvirtualController in the scene.
virtual void	AfterAwake ()
void	Awake ()
Protected Attributes inherited from realvirtual.Signal
string	Visutext
Events inherited from realvirtual.Signal
OnSignalChangedDelegate	SignalChanged

Detailed Description

PLC Boolean Output Signal - Represents a boolean output signal from PLC to simulation.

PLCOutputBool is a core signal type for receiving boolean (true/false) data from external PLC systems into the Unity simulation environment. This component acts as a digital output point from the PLC that simulation components can read and monitor to react to PLC control logic.

Key Features:

• Receives boolean values from connected PLC systems through various industrial protocols
• Provides real-time value updates with automatic change detection
• Supports edge detection for state transitions from PLC programs
• Includes override functionality for testing and manual control
• Tracks connection status for reliable communication monitoring

Signal Direction: PLC → Simulation (Output from PLC from PLC perspective) The signal flows from PLC controller to Unity simulation, enabling PLC programs to control simulation behavior through boolean states such as start/stop commands, valve controls, and motor enables.

Common Applications:

• Sending simulated sensor states to PLC (photoelectric sensors, limit switches)
• Providing component status feedback (motor running, valve open/closed)
• Signaling operation completion or error states
• Implementing virtual buttons and switches for HMI functionality
• Transmitting safety-relevant information like emergency stop acknowledgment

Interface Integration: PLCOutputBool supports all major industrial communication protocols:

• OPC UA: Writes to OPC UA boolean nodes with configurable update rates
• S7 TCP/IP: Direct writing to Siemens S7 PLC data blocks
• Modbus TCP/RTU: Updates Modbus coil or holding registers
• TwinCAT ADS: Writes to Beckhoff TwinCAT boolean variables
• MQTT: Publishes to MQTT topics for cloud and IoT connectivity
• Shared Memory: Provides high-performance local data exchange

Update Mechanism: The component monitors value changes in FixedUpdate() for physics-synchronized updates. When values change, the EventSignalChanged event notifies all connected interfaces to transmit the new state to the PLC. This ensures minimal latency between simulation state changes and PLC program reactions, critical for real-time control applications.

Virtual Commissioning: In virtual commissioning scenarios, PLCOutputBool signals replace physical sensors and actuator feedback, allowing complete PLC program testing without hardware. The override feature enables manual manipulation of signals for comprehensive test coverage.

Member Function Documentation

GetByteSize()

override int realvirtual.PLCOutputBool.GetByteSize ( )

virtual

Reimplemented from realvirtual.Signal.

GetByteValue()

override byte[] realvirtual.PLCOutputBool.GetByteValue ( )

virtual

Reimplemented from realvirtual.Signal.

GetStatusConnected()

override bool realvirtual.PLCOutputBool.GetStatusConnected ( )

virtual

Virtual for getting the connected Status.

Reimplemented from realvirtual.Signal.

GetValue()

override object realvirtual.PLCOutputBool.GetValue ( )

virtual

Gets the value of the signal.

Reimplemented from realvirtual.Signal.

GetVisuText()

override string realvirtual.PLCOutputBool.GetVisuText ( )

virtual

Virtual for getting the text for the Hierarchy View.

Reimplemented from realvirtual.Signal.

OnToggleHierarchy()

override void realvirtual.PLCOutputBool.OnToggleHierarchy ( )

virtual

Virtual for toogle in hierarhy view.

Reimplemented from realvirtual.Signal.

SetStatusConnected()

override void realvirtual.PLCOutputBool.SetStatusConnected ( bool  status )

virtual

Virtual for setting the Status to connected.

Reimplemented from realvirtual.Signal.

SetValue() [1/3]

override void realvirtual.PLCOutputBool.SetValue ( byte[]  value )

virtual

Reimplemented from realvirtual.Signal.

SetValue() [2/3]

override void realvirtual.PLCOutputBool.SetValue ( object  value )

virtual

Sets the value of the signal.

Reimplemented from realvirtual.Signal.

SetValue() [3/3]

override void realvirtual.PLCOutputBool.SetValue ( string  value )

virtual

Virtual for setting the value.

Reimplemented from realvirtual.Signal.