FBDeviceInstrument Class Reference

Instrument abstraction layer. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBDeviceInstrument:

Public Member Functions
	FBDeviceInstrument (FBDevice pDevice)
	Constructor.
	InstrumentRecordFrame (FBTime pRecordTime, FBDeviceNotifyInfo pNotifyInfo)
	Record the data to the function curves for the instrument.
bool	InstrumentWriteData (FBEvaluateInfo pEvaluateInfo)
	Write data to instrument's connectors.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
bool	Active
	Read Write Property: Is instrument active?
FBDevice	Device
	Read Write Property: Handle to owner device.
FBModelTemplate	ModelTemplate
	Read Write Property: Model template to build instruments' structure.
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

Instrument abstraction layer.

Constructor & Destructor Documentation

FBDeviceInstrument()

FBDeviceInstrument

(

FBDevice

pDevice

)

Constructor.

Parameters

pDevice

Parent device.

Member Function Documentation

InstrumentRecordFrame()

InstrumentRecordFrame	(	FBTime	pRecordTime,
		FBDeviceNotifyInfo	pNotifyInfo
	)

Record the data to the function curves for the instrument.

Parameters

pRecordTime	Time to record data at.
pNotifyInfo	Device notification information structure.

InstrumentWriteData()

bool InstrumentWriteData

(

FBEvaluateInfo

pEvaluateInfo

)

Write data to instrument's connectors.

In the evaluation engine callback, this will take the data in the instrument's temporary data holders and write it to the connectors.

Parameters

pEvaluateInfo

Evaluation information structure.

Returns

true if successful.

Member Data Documentation

Active

bool Active

Read Write Property: Is instrument active?

Device

FBDevice Device

Read Write Property: Handle to owner device.

ModelTemplate

FBModelTemplate ModelTemplate

Read Write Property: Model template to build instruments' structure.