Spinnaker C++
2.6.0.0
Public Member Functions | Protected Attributes | List of all members
CPortImpl Class Referenceabstract

Standard implementation for a port. More...

Inheritance diagram for CPortImpl:
CRegisterPortImpl CTestPortStruct< CDataStruct >

Public Member Functions

 CPortImpl ()
 Constructor. More...
 
virtual ~CPortImpl ()
 Destructor. More...
 
virtual EAccessMode GetAccessMode () const =0
 Get the access mode of the node. More...
 
virtual void Read (void *pBuffer, int64_t Address, int64_t Length)=0
 Reads a chunk of bytes from the port. More...
 
virtual void Write (const void *pBuffer, int64_t Address, int64_t Length)=0
 Writes a chunk of bytes to the port. More...
 
virtual void SetPortImpl (IPort *pPort)
 Sets pointer the real port implementation; this function may called only once. More...
 
virtual EYesNo GetSwapEndianess ()
 Determines if the port adapter must perform an endianness swap. More...
 
virtual void Replay (IPortWriteList *pPortRecorder, bool Invalidate=true)
 sends the commands to the camera. More...
 
void InvalidateNode ()
 

Protected Attributes

CNodePtr m_ptrPort
 Pointer to the node holding a reference to this implementation. More...
 

Detailed Description

Standard implementation for a port.

Constructor & Destructor Documentation

CPortImpl ( )
inline

Constructor.

virtual ~CPortImpl ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual EAccessMode GetAccessMode ( ) const
pure virtual

Get the access mode of the node.

Driver closed => NI, Driver open => RW, analyzing a struct, RO

Implemented in CRegisterPortImpl, and CTestPortStruct< CDataStruct >.

virtual EYesNo GetSwapEndianess ( )
inlinevirtual

Determines if the port adapter must perform an endianness swap.

void InvalidateNode ( )
inline
virtual void Read ( void *  pBuffer,
int64_t  Address,
int64_t  Length 
)
pure virtual

Reads a chunk of bytes from the port.

Implemented in CRegisterPortImpl, and CTestPortStruct< CDataStruct >.

virtual void Replay ( IPortWriteList pPortRecorder,
bool  Invalidate = true 
)
inlinevirtual

sends the commands to the camera.

the default implementation just walks the list and issues each command

using the WriteRegister method. Depending on the capabilities of the transport layer the implementation can however use a special command which sends all register write commands as one package.

virtual void SetPortImpl ( IPort pPort)
inlinevirtual

Sets pointer the real port implementation; this function may called only once.

Reimplemented in CRegisterPortImpl.

virtual void Write ( const void *  pBuffer,
int64_t  Address,
int64_t  Length 
)
pure virtual

Writes a chunk of bytes to the port.

Implemented in CRegisterPortImpl, and CTestPortStruct< CDataStruct >.

Member Data Documentation

CNodePtr m_ptrPort
protected

Pointer to the node holding a reference to this implementation.


The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference