FBDevice Class Reference

FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice FBDevice
Inheritance diagram for FBDevice:
Inheritance graph
[legend]

List of all members.


Detailed Description

Base Device class.

See samples: StartDevice.py, StopDevice.py.


Public Member Functions

  FBDevice (str pName)
  Constructor.
  AckOneBadSampleReceived ()
  Acknowlege that one bad sample was received (for statistical purposes).
  AckOneSampleReceived ()
  Acknowlege that one sample was received (for statistical purposes).
  AckOneSampleSent ()
  Acknowlege that one sample was sent (for statistical purposes).
bool  AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
  Notification function for animation thread.
bool  FBCreate ()
  Open Reality Creation function.
  FBDestroy ()
  Open Reality destruction function.
  RecordingDoneAnimation (FBAnimationNode pAnimationNode)
  When recording, finish animation.
  RecordingInitAnimation (FBAnimationNode pAnimationNode)
  When recording, initialize animation.

Public Attributes

int  CommType
  Read Write Property: Type of communications.
str  HardwareVersionInfo
  Read Write Property: Device information: hardware version.
str  IconFilename
  Read Write Property: Icon filename.
str  Information
  Read Write Property: Device information: information.
FBModelTemplate  ModelTemplate
  Component: Root of model template structure.
bool  Online
  Read Write Property: Is online?
FBTime  RecordingStartTime
  Read Only Property: The time at which the recording started.
FBTime  RecordingStopTime
  Read Only Property: The time at which the recording stopped.
FBDeviceSamplingMode  SamplingMode
  Read Write Property: Mode to use to record device.
FBTime  SamplingPeriod
  Read Write Property: How often a device is evaluated in 1 second. If not set, the Period is based on the internal variable from the [Sync] section of the .Application.txt file (NTSC, PAL, CINEMA). If set to 0: the device is evaluated on the Sync signal. When the sync occurs; the device is schedule to be evaluated. There is no theoretical maximum value but practically you should consider Scene complexity, system resources, network speed, etc.
str  Status
  Read Write Property: Device information: status.

Constructor & Destructor Documentation

FBDevice ( str  pName  ) 

Constructor.

Parameters:
pName  Name of device.

Member Function Documentation

AckOneBadSampleReceived (  ) 

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

AckOneSampleReceived (  ) 

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

AckOneSampleSent (  ) 

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

bool AnimationNodeNotify ( FBAnimationNode  pAnimationNode,
FBEvaluateInfo  pEvaluateInfo  
)

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.

bool FBCreate (  ) 

Open Reality Creation function.

Returns:
Outcome of creation (true/false).

Reimplemented from FBComponent.

FBDestroy (  ) 

Open Reality destruction function.

Reimplemented from FBComponent.

RecordingDoneAnimation ( FBAnimationNode  pAnimationNode  ) 

When recording, finish animation.

Parameters:
pAnimationNode  Animation node to write information to.

RecordingInitAnimation ( FBAnimationNode  pAnimationNode  ) 

When recording, initialize animation.

Parameters:
pAnimationNode  Animation node to read information from.

Member Data Documentation

int CommType

Read Write Property: Type of communications.

str HardwareVersionInfo

Read Write Property: Device information: hardware version.

str IconFilename

Read Write Property: Icon filename.

str Information

Read Write Property: Device information: information.

FBModelTemplate ModelTemplate

Component: Root of model template structure.

bool Online

Read Write Property: Is online?

FBTime RecordingStartTime

Read Only Property: The time at which the recording started.

FBTime RecordingStopTime

Read Only Property: The time at which the recording stopped.

FBDeviceSamplingMode SamplingMode

Read Write Property: Mode to use to record device.

FBTime SamplingPeriod

Read Write Property: How often a device is evaluated in 1 second. If not set, the Period is based on the internal variable from the [Sync] section of the .Application.txt file (NTSC, PAL, CINEMA). If set to 0: the device is evaluated on the Sync signal. When the sync occurs; the device is schedule to be evaluated. There is no theoretical maximum value but practically you should consider Scene complexity, system resources, network speed, etc.

str Status

Read Write Property: Device information: status.


Generated on Tue Feb 9 19:34:16 2010 for Python Reference Guide by  doxygen 1.5.3