Spinnaker C++
2.6.0.0
Public Member Functions | Protected Attributes | List of all members
CChunkPort Class Reference

Port attachable to a chunk in a buffer. More...

Inheritance diagram for CChunkPort:

Public Member Functions

 CChunkPort (IPort *pPort=NULL)
 Constructor; can attach to a port. More...
 
 ~CChunkPort ()
 Destructor; detaches from the port. More...
 
virtual EAccessMode GetAccessMode () const
 Get the access mode of the node. More...
 
virtual EInterfaceType GetPrincipalInterfaceType () const
 Get the type of the main interface of a node. More...
 
virtual void Read (void *pBuffer, int64_t Address, int64_t Length)
 Reads a chunk of bytes from the port. More...
 
virtual void Write (const void *pBuffer, int64_t Address, int64_t Length)
 Writes a chunk of bytes to the port. More...
 
virtual void SetPortImpl (IPort *pPort)
 Called from the port node to give the chunk port a pointer to itself. More...
 
virtual EYesNo GetSwapEndianess ()
 Determines if the port adapter must perform an endianness swap. More...
 
void InvalidateNode ()
 
bool AttachPort (::Spinnaker::GenApi::IPort *pPort)
 Attaches the ChunkPort to the Port. More...
 
void DetachPort ()
 Detaches the ChunkPort to the Port. More...
 
void AttachChunk (uint8_t *pBaseAddress, int64_t ChunkOffset, int64_t Length, bool Cache)
 Attaches the Chunk to the ChunkPort. More...
 
void DetachChunk ()
 Detaches the Chunk from the ChunkPort. More...
 
int GetChunkIDLength ()
 Gets the ChunkID length. More...
 
bool CheckChunkID (uint8_t *pChunkIDBuffer, int ChunkIDLength)
 Checks if a ChunkID matches. More...
 
bool CheckChunkID (uint64_t ChunkID)
 Checks if a ChunkID matches, version using uint64_t ID representation. More...
 
void UpdateBuffer (uint8_t *pBaseAddress)
 Updates the base address of the chunk. More...
 
void ClearCache ()
 Clears the chunk cache. More...
 

Protected Attributes

CNodePtr m_pPort
 
std::shared_ptr< PortAdapter > m_pPortAdapter
 
void * m_pChunkPort
 

Detailed Description

Port attachable to a chunk in a buffer.

Constructor & Destructor Documentation

CChunkPort ( IPort pPort = NULL)

Constructor; can attach to a port.

~CChunkPort ( )

Destructor; detaches from the port.

Member Function Documentation

void AttachChunk ( uint8_t *  pBaseAddress,
int64_t  ChunkOffset,
int64_t  Length,
bool  Cache 
)

Attaches the Chunk to the ChunkPort.

bool AttachPort ( ::Spinnaker::GenApi::IPort pPort)

Attaches the ChunkPort to the Port.

bool CheckChunkID ( uint8_t *  pChunkIDBuffer,
int  ChunkIDLength 
)

Checks if a ChunkID matches.

bool CheckChunkID ( uint64_t  ChunkID)

Checks if a ChunkID matches, version using uint64_t ID representation.

void ClearCache ( )

Clears the chunk cache.

void DetachChunk ( )

Detaches the Chunk from the ChunkPort.

void DetachPort ( )

Detaches the ChunkPort to the Port.

virtual EAccessMode GetAccessMode ( ) const
virtual

Get the access mode of the node.

int GetChunkIDLength ( )

Gets the ChunkID length.

virtual EInterfaceType GetPrincipalInterfaceType ( ) const
virtual

Get the type of the main interface of a node.

virtual EYesNo GetSwapEndianess ( )
inlinevirtual

Determines if the port adapter must perform an endianness swap.

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

Reads a chunk of bytes from the port.

virtual void SetPortImpl ( IPort pPort)
virtual

Called from the port node to give the chunk port a pointer to itself.

void UpdateBuffer ( uint8_t *  pBaseAddress)

Updates the base address of the chunk.

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

Writes a chunk of bytes to the port.

Member Data Documentation

void* m_pChunkPort
protected
CNodePtr m_pPort
protected
std::shared_ptr<PortAdapter> m_pPortAdapter
protected

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