realvirtual.SignalTestGenerator Class Reference

Generates test signal values for the PLCInput signal on this GameObject. More...

Inheritance diagram for realvirtual.SignalTestGenerator:

Public Member Functions
void	RefreshSignal ()
	Discovers the PLCInput signal on this GameObject.
Public Member Functions inherited from realvirtual.BehaviorInterface
new List< BehaviorInterfaceConnection >	GetConnections ()
	Returns a list of behavior interface connections for this component.
new List< Signal >	GetSignals ()
	Returns a list of connected signals for this component.
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
bool	EnableTesting
	Enable or disable test signal generation.
float	UpdateInterval
	Time in seconds between signal updates.
float	SineAmplitude
	Amplitude of the sine wave for float signals in signal units.
float	SineOffset
	Center offset of the sine wave for float signals.
float	SineFrequency
	Frequency of the sine wave in Hz.
float	ToggleInterval
	Time in seconds between bool toggles.
int	IntIncrement
	Increment value per update cycle for int signals.
int	IntMax
	Maximum value before int counter resets to zero.
int	CycleCount
	Number of update cycles completed.
string	DetectedSignalType
	Type of signal detected on this GameObject.
Public Attributes inherited from realvirtual.BehaviorInterface
List< BehaviorInterfaceConnection >	ConnectionInfo
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.

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.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 ()
Properties inherited from realvirtual.ISignalInterface
GameObject	gameObject [get]

Detailed Description

Generates test signal values for the PLCInput signal on this GameObject.

Place this component on a signal GameObject (PLCInputBool, PLCInputFloat, PLCInputInt) to generate cyclic test patterns without a PLC connection. Float signals follow a sine wave, Bool signals toggle on/off, and Int signals increment.

For detailed documentation see: https://doc.realvirtual.io/components-and-scripts/interfaces/signal-test-generator

Member Function Documentation

RefreshSignal()

void realvirtual.SignalTestGenerator.RefreshSignal

(

)

Discovers the PLCInput signal on this GameObject.

Member Data Documentation

CycleCount

int realvirtual.SignalTestGenerator.CycleCount

Number of update cycles completed.

DetectedSignalType

string realvirtual.SignalTestGenerator.DetectedSignalType

Type of signal detected on this GameObject.

EnableTesting

bool realvirtual.SignalTestGenerator.EnableTesting

Enable or disable test signal generation.

IntIncrement

int realvirtual.SignalTestGenerator.IntIncrement

Increment value per update cycle for int signals.

IntMax

int realvirtual.SignalTestGenerator.IntMax

Maximum value before int counter resets to zero.

SineAmplitude

float realvirtual.SignalTestGenerator.SineAmplitude

Amplitude of the sine wave for float signals in signal units.

SineFrequency

float realvirtual.SignalTestGenerator.SineFrequency

Frequency of the sine wave in Hz.

SineOffset

float realvirtual.SignalTestGenerator.SineOffset

Center offset of the sine wave for float signals.

ToggleInterval

float realvirtual.SignalTestGenerator.ToggleInterval

Time in seconds between bool toggles.

UpdateInterval

float realvirtual.SignalTestGenerator.UpdateInterval

Time in seconds between signal updates.