Detailed Description

Base Device class.

Examples: Tasks/StartDevice.py, Tasks/StopDevice.py

Inheritance diagram for FBDevice:

Public Member Functions
bool	FbxStore (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format.
bool	FbxRetrieve (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
	__init__ (str pName, object pObject=None)
	Constructor.
bool	FBCreate ()
	Open Reality Creation function.
	FBDestroy ()
	Open Reality destruction function.
HFBAnimationNode	AnimationNodeInCreate (int pUserId, str pName, str pDataType, bool pIsPublic=True, float pMin=None, float pMax=None, bool pUserData=False)
	Creation of IN/OUT Animation Nodes.
HFBAnimationNode	AnimationNodeOutCreate (int pUserId, str pName, str pDataType, bool pIsPublic=True, float pMin=None, float pMax=None, bool pUserData=False)
bool	DeviceOperation (kDeviceOperations pOperation)
	Operate device.
	DeviceTransportNotify (kTransportMode pMode, FBTime pTime, FBTime pSystem)
	Real-Time engine thread: Tranport notifications.
	DeviceIONotify (kDeviceIOs pAction, FBDeviceNotifyInfo pDeviceNotifyInfo)
	Real-Time engine thread: Device I/O.
bool	DeviceEvaluationNotify (kTransportMode pMode, HFBEvaluateInfo pEvaluateInfo)
	Real-Time engine thread: Output device evaluation.
bool	ModelTemplateBindNotify (FBModel pModel, int pIndex, HFBModelTemplate pModelTemplate)
	Model Template binding notification callback.
bool	ModelTemplateUnBindNotify (int pIndex, HFBModelTemplate pModelTemplate)
	Model Template unbinding notification callback.
bool	AnimationNodeNotify (HFBAnimationNode pAnimationNode, HFBEvaluateInfo pEvaluateInfo)
	Notification function for animation thread.
str	FbxGetObjectType ()
	Object Type "Device".
	DeviceSendCommand (kDeviceOperations pOperation)
	Send a command to the device.
	IObject_Declare (Implementation)
	AckOneSampleReceived ()
	Acknowlege that one sample was received (for statistical purposes).
	AckOneBadSampleReceived ()
	Acknowlege that one bad sample was received (for statistical purposes).
	AckOneSampleSent ()
	Acknowlege that one sample was sent (for statistical purposes).
	RecordingInitAnimation (HFBAnimationNode pAnimationNode)
	When recording, initialize animation.
	RecordingDoneAnimation (HFBAnimationNode pAnimationNode)
	When recording, finish animation.
Public Attributes
FBPropertyString	IconFilename
	Read Write Property: Icon filename.
FBPropertyString	Status
	Read Write Property: Device information: status.
FBPropertyString	Information
	Read Write Property: Device information: information.
FBPropertyString	HardwareVersionInfo
	Read Write Property: Device information: hardware version.
FBPropertyBase	SamplingPeriod
	Read Write Property: Set this to how many times a device is to be evaluated in one second.
FBPropertyBase	Online
	Read Write Property: Is online?.
FBPropertyEvent	OnStatusChange
	Event: Status of device changed.
FBModelTemplate	ModelTemplate
	Component: Root of model template structure.
FBPropertyDeviceSamplingMode	SamplingMode
	Read Write Property: Mode to use to record device.
FBPropertyBase	CommType
	Read Write Property: Type of communications.
FBPropertyListDeviceInstrument	Instruments
	List: List of instruments.
FBPropertyBase	RecordingStartTime
	Read Only Property: The time at which the recording started.
FBPropertyBase	RecordingStopTime
	Read Only Property: The time at which the recording stopped.

Member Function Documentation

bool FbxStore	(	HFBFbxObject	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

Search for all occurrences

Storage/Retrieval of information into the FBX file format.

Parameters:

pFbxObject	Object to interface with FBX file format.
pStoreWhat	Attributes to store in FBX file.

Returns:: true if successful.

Reimplemented from FBBox.

Reimplemented in FBDeviceOptical.

bool FbxRetrieve	(	HFBFbxObject	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

Search for all occurrences

Reimplemented from FBBox.

Reimplemented in FBDeviceOptical.

__init__	(	str	pName,
		object	pObject = `None`
	)

Search for all occurrences

Constructor.

Parameters:

pName	Name of device.
pObject	For internal use only (default is NULL).

Examples: Tasks/StartDevice.py, Tasks/StopDevice.py

Reimplemented from FBBox.

Reimplemented in FBDeviceOptical.

bool FBCreate ( )

Search for all occurrences

Open Reality Creation function.

Returns:: Outcome of creation (true/false).

Reimplemented from FBComponent.

Reimplemented in FBDeviceOptical.

FBDestroy ( )

Search for all occurrences

Open Reality destruction function.

Reimplemented from FBComponent.

Reimplemented in FBDeviceOptical.

HFBAnimationNode AnimationNodeInCreate	(	int	pUserId,
		str	pName,
		str	pDataType,
		bool	pIsPublic = `True`,
		float	pMin = `None`,
		float	pMax = `None`,
		bool	pUserData = `False`
	)

Search for all occurrences

Creation of IN/OUT Animation Nodes.

Parameters:

pUserId	User-defined reference number.
pName	Name of animation node.
pDataType	Type of data being animated.
pIsPublic	Determine if the animation node is published (default is false).
pMin	Minimum values for data (default is NULL).
pMax	Maximum values for data (default is NULL).
pUserData	Is this user data? (default is false)

Returns:: A handle to the newly created animation node.

Reimplemented from FBBox.

HFBAnimationNode AnimationNodeOutCreate	(	int	pUserId,
		str	pName,
		str	pDataType,
		bool	pIsPublic = `True`,
		float	pMin = `None`,
		float	pMax = `None`,
		bool	pUserData = `False`
	)

Search for all occurrences

Reimplemented from FBBox.

bool DeviceOperation ( kDeviceOperations pOperation )

Search for all occurrences

Operate device.

This is an operation such as Init, Start, Done, Reset, etc.

Parameters:

pOperation Operation to have device perform.

Returns:: Current state : <b true if online.

Reimplemented in FBDeviceOptical.

DeviceTransportNotify	(	kTransportMode	pMode,
		FBTime	pTime,
		FBTime	pSystem
	)

Search for all occurrences

Real-Time engine thread: Tranport notifications.

The device I/O thread calls this function when there is a transport change.

Parameters:

pMode	Transport mode.
pTime	Local time.
pSystem	System time.

DeviceIONotify	(	kDeviceIOs	pAction,
		FBDeviceNotifyInfo	pDeviceNotifyInfo
	)

Search for all occurrences

Real-Time engine thread: Device I/O.

The device I/O thread calls this function (required) which is a highly optimized non-blocking function registering input/output information from/to the device.

Parameters:

pAction	Different reading/writing actions for the device.
pDeviceNotifyInfo	Access to the system and local time.

Reimplemented in FBDeviceOptical.

bool DeviceEvaluationNotify	(	kTransportMode	pMode,
		HFBEvaluateInfo	pEvaluateInfo
	)

Search for all occurrences

Real-Time engine thread: Output device evaluation.

Parameters:

pMode	Transport mode.
pEvaluateInfo	Access to the system and local time.

Returns:: true if successful.

bool ModelTemplateBindNotify	(	FBModel	pModel,
		int	pIndex,
		HFBModelTemplate	pModelTemplate
	)

Search for all occurrences

Model Template binding notification callback.

Parameters:

pModel	Model being bound to model template.
pIndex	Index of model template where binding is occuring.
pModelTemplate	Model being affected with binding.

Returns:: true if successful.

bool ModelTemplateUnBindNotify	(	int	pIndex,
		HFBModelTemplate	pModelTemplate
	)

Search for all occurrences

Model Template unbinding notification callback.

Parameters:

pIndex	Index in pModelTemplate where unbinding has occured.
pModelTemplate	Model template from which binding is removed.

Returns:: true if successful.

bool AnimationNodeNotify	(	HFBAnimationNode	pAnimationNode,
		HFBEvaluateInfo	pEvaluateInfo
	)

Search for all occurrences

Notification function for animation thread.

This function is called by the real-time engine in order to process animation information.

Parameters:

pAnimationNode	Node containing the modified information.
pEvaluateInfo	Information concerning the evaluation of the animation (time, etc.)

Returns:: true if animation node notification is successful.

Reimplemented from FBBox.

Reimplemented in FBDeviceOptical.

str FbxGetObjectType ( )

Search for all occurrences

Object Type "Device".

Reimplemented from FBBox.

DeviceSendCommand ( kDeviceOperations pOperation )

Search for all occurrences

Send a command to the device.

This function will send the Init, Start, etc. commands to the device.

Parameters:

pOperation Operation for device to perform.

IObject_Declare ( Implementation )

Search for all occurrences

Reimplemented from FBBox.

AckOneSampleReceived ( )

Search for all occurrences

Acknowlege that one sample was received (for statistical purposes).

AckOneBadSampleReceived ( )

Search for all occurrences

Acknowlege that one bad sample was received (for statistical purposes).

AckOneSampleSent ( )

Search for all occurrences

Acknowlege that one sample was sent (for statistical purposes).

RecordingInitAnimation ( HFBAnimationNode pAnimationNode )

Search for all occurrences

When recording, initialize animation.

Parameters:

pAnimationNode Animation node to read information from.

Reimplemented in FBDeviceOptical.

RecordingDoneAnimation ( HFBAnimationNode pAnimationNode )

Search for all occurrences

When recording, finish animation.

Parameters:

pAnimationNode Animation node to write information to.

Reimplemented in FBDeviceOptical.

Member Data Documentation

FBPropertyString IconFilename

Search for all occurrences

Read Write Property: Icon filename.

FBPropertyString Status

Search for all occurrences

Read Write Property: Device information: status.

FBPropertyString Information

Search for all occurrences

Read Write Property: Device information: information.

FBPropertyString HardwareVersionInfo

Search for all occurrences

Read Write Property: Device information: hardware version.

FBPropertyBase SamplingPeriod

Search for all occurrences

Read Write Property: Set this to how many times a device is to be evaluated in one second.

There is no theoretical maximum value but practically you should consider scene complexity, system resources, network speed, etc. If set to 0: the device is evaluated on the sync signal. When the sync occurs; the device is scheduled to be evaluated. If you do not set, the sampling period is based on the internal variable from the [Sync] section of the .Application.txt file (NTSC, PAL, CINEMA).

FBPropertyBase Online

Search for all occurrences

Read Write Property: Is online?.

FBPropertyEvent OnStatusChange

Search for all occurrences

Event: Status of device changed.

FBModelTemplate ModelTemplate

Search for all occurrences

Component: Root of model template structure.

FBPropertyDeviceSamplingMode SamplingMode

Search for all occurrences

Read Write Property: Mode to use to record device.