Comm port class. More...

#include <fbio.h>

Inheritance diagram for FBCommPort:

[legend]

Public Member Functions
	FBCommPort ()
	Constructor. More...

bool	Read (void lpBuffer, int nNumberOfBytesToRead, int lpNumberOfBytesRead=NULL)
	Read data from comm port (non-blocking). More...

bool	ReadBlocking (void lpBuffer, int nNumberOfBytesToRead, int lpNumberOfBytesRead=NULL, kULong pTimeOut=500)
	Read data from comm port (blocking). More...

bool	Write (void lpBuffer, int nNumberOfBytesToWrite, int lpNumberOfBytesWritten=NULL)
	Write data to comm port (non-blocking). More...

bool	WriteBlocking (void lpBuffer, int nNumberOfBytesToWrite, int lpNumberOfBytesWritten=NULL, kULong pTimeOut=500)
	Write data to comm port (blocking). More...

bool	EmptyBuffer ()
	Empty comm port buffer. More...

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor. More...

virtual	~FBComponent ()
	Destructor. More...

virtual bool	FBCreate ()
	Open Reality Creation function. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual void	FBDelete () override
	Open Reality deletion function. More...

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer. More...

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager. More...

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager. More...

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading. More...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property. More...

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated). More...

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled. More...

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags. More...

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags. More...

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status. More...

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled. More...

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	Get the class name. More...

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not. More...

const char *	GetFullName (void)
	Get the full name. More...

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object. More...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyInt	PortNumber
	Property: Port number. More...

FBPropertyString	OwnerName
	Property: Owner name. More...

FBPropertyInt	BaudRate
	Property: Baud rate. More...

FBPropertyBool	UseHardwareFC
	Property: Use hardware flow control? More...

FBPropertyParity	Parity
	Property: Parity. More...

FBPropertyInt	ByteSize
	Property: Byte size. More...

FBPropertyInt	StopBits
	Property: Stop bits. More...

FBPropertyRSType	RSType
	Property: Communications protocol (RS232 or RS422)? More...

FBPropertyCommPortType	CommPortType
	Property: Comm type (physical, virtual or internal)? More...

FBPropertyBool	Active
	Property: Is comm port active? More...

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyListComponent	Components
	List: List of components. More...

FBPropertyListComponent	Parents
	List: Parents. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

FBPropertyString	Name
	Read Write Property: Unique name of object. More...

FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component. More...

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object. More...

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

int	GetSrcCount ()
	Get source connection count. More...

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

int	GetDstCount ()
	Get destination connection count. More...

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

bool	BeginChange ()
	Begins a change on multiple plugs. More...

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

int	GetOwnedCount ()
	Get the owned plug count. More...

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

Detailed Description

Comm port class.

Definition at line 92 of file fbio.h.

Constructor & Destructor Documentation

◆ FBCommPort()

FBCommPort ( )

Constructor.

Member Function Documentation

◆ EmptyBuffer()

bool EmptyBuffer ( )

Empty comm port buffer.

Returns: true if successful.

◆ Read()

bool Read	(	void *	lpBuffer,
		int	nNumberOfBytesToRead,
		int *	lpNumberOfBytesRead = `NULL`
	)

Read data from comm port (non-blocking).

Return values

lpBuffer Buffer to fill.

Parameters

nNumberOfBytesToRead Number of bytes to read.

Return values

lpNumberOfBytesRead Number of bytes actually read (if not at NULL).

Returns: true if the number of bytes read is equal to the number of bytes to read.

◆ ReadBlocking()

bool ReadBlocking	(	void *	lpBuffer,
		int	nNumberOfBytesToRead,
		int *	lpNumberOfBytesRead = `NULL`,
		kULong	pTimeOut = `500`
	)

Read data from comm port (blocking).

Return values

lpBuffer Buffer to fill.

Parameters

nNumberOfBytesToRead Number of bytes to read.

Return values

lpNumberOfBytesRead Number of bytes actually read (if not at NULL).

Parameters

pTimeOut Timeout for operation.

Returns: true if the number of bytes read is equal to the number of bytes to read.

Warning: This operation is blocking!

◆ Write()

bool Write	(	void *	lpBuffer,
		int	nNumberOfBytesToWrite,
		int *	lpNumberOfBytesWritten = `NULL`
	)

Write data to comm port (non-blocking).

Parameters

lpBuffer	Buffer to write.
nNumberOfBytesToWrite	Number of bytes to write.

Return values

lpNumberOfBytesWritten Number of bytes actually written (if not at NULL).

Returns: true if the number of bytes written is equal to the number of bytes to write.

◆ WriteBlocking()

bool WriteBlocking	(	void *	lpBuffer,
		int	nNumberOfBytesToWrite,
		int *	lpNumberOfBytesWritten = `NULL`,
		kULong	pTimeOut = `500`
	)

Write data to comm port (blocking).

Parameters

lpBuffer	Buffer to write.
nNumberOfBytesToWrite	Number of bytes to write.

Return values

lpNumberOfBytesWritten Number of bytes actually written (if not at NULL).

Parameters

pTimeOut Timeout for operation.

Returns: true if the number of bytes written is equal to the number of bytes to write.

Warning: This operation is blocking!

Member Data Documentation

◆ Active

FBPropertyBool Active

Property: Is comm port active?

Definition at line 151 of file fbio.h.

◆ BaudRate

FBPropertyInt BaudRate

Property: Baud rate.

Definition at line 142 of file fbio.h.

◆ ByteSize

FBPropertyInt ByteSize

Property: Byte size.

Definition at line 146 of file fbio.h.

◆ CommPortType

FBPropertyCommPortType CommPortType

Property: Comm type (physical, virtual or internal)?

Definition at line 149 of file fbio.h.

◆ OwnerName

FBPropertyString OwnerName

Property: Owner name.

Definition at line 141 of file fbio.h.

◆ Parity

FBPropertyParity Parity

Property: Parity.

Definition at line 145 of file fbio.h.

◆ PortNumber

FBPropertyInt PortNumber

Property: Port number.

Definition at line 140 of file fbio.h.

◆ RSType

FBPropertyRSType RSType

Property: Communications protocol (RS232 or RS422)?

Definition at line 148 of file fbio.h.

◆ StopBits

FBPropertyInt StopBits

Property: Stop bits.

Definition at line 147 of file fbio.h.

◆ UseHardwareFC

FBPropertyBool UseHardwareFC

Property: Use hardware flow control?

Definition at line 143 of file fbio.h.

The documentation for this class was generated from the following file:

fbio.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBCommPort()

Member Function Documentation

◆ EmptyBuffer()

◆ Read()

◆ ReadBlocking()

◆ Write()

◆ WriteBlocking()

Member Data Documentation

◆ Active

◆ BaudRate

◆ ByteSize

◆ CommPortType

◆ OwnerName

◆ Parity

◆ PortNumber

◆ RSType

◆ StopBits

◆ UseHardwareFC