realvirtual.PLCInputBool Class Reference

PLC Boolean Input Signal - Represents a boolean input signal to PLC from simulation. More...

Inheritance diagram for realvirtual.PLCInputBool:

Public Member Functions
override void	OnToggleHierarchy ()
	Virtual for toogle in hierarhy view.
override void	SetStatusConnected (bool status)
	Sets the Status connected.
override bool	GetStatusConnected ()
	Gets the status connected.
override void	SetValue (byte[] value)
override byte[]	GetByteValue ()
override int	GetByteSize ()
override string	GetVisuText ()
	Gets the text for displaying it in the hierarchy view.
override bool	IsInput ()
	True if signal is input.
override void	SetValue (string value)
	Sets the Value as a string.
override void	SetValue (object value)
	Sets the value of the signal.
override object	GetValue ()
	Gets the value of the signal.
void	SetValue (bool value)
	Sets the Value as a bool.
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 ()
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
	Status struct of the bool.
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]
	Sets and gets the value.

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 Input Signal - Represents a boolean input signal to PLC from simulation.

PLCInputBool is a fundamental signal type for sending boolean (true/false) data from Unity simulation to external PLC systems. This component serves as a digital input point for the PLC that simulation components can write to, providing sensor states and feedback to PLC control logic.

Key Features:

• Sends boolean values to connected PLC systems via various industrial protocols
• Supports real-time value changes with automatic change detection
• Provides edge detection for rising (false to true) and falling (true to false) transitions
• Implements override capability for manual testing and debugging without PLC connection
• Maintains connection status to indicate communication health with PLC

Signal Direction: Simulation → PLC (Input to PLC from PLC perspective) The signal flows from Unity simulation to the PLC controller, allowing simulation to provide sensor readings and status information to PLC programs such as proximity sensors, limit switches, or status flags.

Common Applications:

• Receiving start/stop commands from PLC programs
• Reading digital sensor states (proximity sensors, light barriers, limit switches)
• Monitoring PLC status flags and operation modes
• Triggering simulation events based on PLC conditions
• Implementing safety interlocks and emergency stop signals

Interface Integration: PLCInputBool seamlessly integrates with multiple industrial communication protocols including:

• OPC UA: Maps to OPC UA boolean nodes for standardized communication
• S7 TCP/IP: Direct integration with Siemens S7 PLCs via TCP/IP
• Modbus TCP/RTU: Maps to Modbus coil or discrete input registers
• TwinCAT ADS: Connects to Beckhoff TwinCAT boolean variables
• MQTT: Subscribes to MQTT topics for IoT integration
• Shared Memory: High-speed local communication for virtual commissioning

Update Mechanism: The signal value is updated in FixedUpdate() to ensure consistent timing with Unity's physics system. Value changes trigger the EventSignalChanged event, allowing other components to react immediately. Edge detection (ChangedToTrue/ChangedToFalse) provides single-frame flags for transition handling, essential for implementing one-shot logic and state machines in automation sequences.

Member Function Documentation

GetByteSize()

override int realvirtual.PLCInputBool.GetByteSize ( )

virtual

Reimplemented from realvirtual.Signal.

GetByteValue()

override byte[] realvirtual.PLCInputBool.GetByteValue ( )

virtual

Reimplemented from realvirtual.Signal.

GetStatusConnected()

override bool realvirtual.PLCInputBool.GetStatusConnected ( )

virtual

Gets the status connected.

Reimplemented from realvirtual.Signal.

GetValue()

override object realvirtual.PLCInputBool.GetValue ( )

virtual

Gets the value of the signal.

Reimplemented from realvirtual.Signal.

GetVisuText()

override string realvirtual.PLCInputBool.GetVisuText ( )

virtual

Gets the text for displaying it in the hierarchy view.

Reimplemented from realvirtual.Signal.

IsInput()

override bool realvirtual.PLCInputBool.IsInput ( )

virtual

True if signal is input.

Reimplemented from realvirtual.Signal.

OnToggleHierarchy()

override void realvirtual.PLCInputBool.OnToggleHierarchy ( )

virtual

Virtual for toogle in hierarhy view.

Reimplemented from realvirtual.Signal.

SetStatusConnected()

override void realvirtual.PLCInputBool.SetStatusConnected ( bool  status )

virtual

Sets the Status connected.

Reimplemented from realvirtual.Signal.

SetValue() [1/4]

void realvirtual.PLCInputBool.SetValue

(

bool

value

)

Sets the Value as a bool.

SetValue() [2/4]

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

virtual

Reimplemented from realvirtual.Signal.

SetValue() [3/4]

override void realvirtual.PLCInputBool.SetValue ( object  value )

virtual

Sets the value of the signal.

Reimplemented from realvirtual.Signal.

SetValue() [4/4]

override void realvirtual.PLCInputBool.SetValue ( string  value )

virtual

Sets the Value as a string.

Reimplemented from realvirtual.Signal.

Member Data Documentation

Status

StatusBool realvirtual.PLCInputBool.Status

Status struct of the bool.

Property Documentation

Value

bool realvirtual.PLCInputBool.Value

getset

Sets and gets the value.