CChunkPort Class Reference

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

#include <ChunkPort.h>

Inheritance diagram for CChunkPort:

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

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()

CChunkPort

(

IPort *

pPort = NULL

)

Constructor; can attach to a port.

~CChunkPort()

~CChunkPort

(

)

Destructor; detaches from the port.

Member Function Documentation

AttachChunk()

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

Attaches the Chunk to the ChunkPort.

AttachPort()

bool AttachPort

(

::Spinnaker::GenApi::IPort *

pPort

)

Attaches the ChunkPort to the Port.

CheckChunkID() [1/2]

bool CheckChunkID

(

uint64_t

ChunkID

)

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

CheckChunkID() [2/2]

bool CheckChunkID	(	uint8_t *	pChunkIDBuffer,
		int	ChunkIDLength
	)

Checks if a ChunkID matches.

ClearCache()

void ClearCache

(

)

Clears the chunk cache.

DetachChunk()

void DetachChunk

(

)

Detaches the Chunk from the ChunkPort.

DetachPort()

void DetachPort

(

)

Detaches the ChunkPort to the Port.

GetAccessMode()

virtual EAccessMode GetAccessMode ( ) const

virtual

Get the access mode of the node.

GetChunkIDLength()

int GetChunkIDLength

(

)

Gets the ChunkID length.

GetPrincipalInterfaceType()

virtual EInterfaceType GetPrincipalInterfaceType ( ) const

virtual

Get the type of the main interface of a node.

GetSwapEndianess()

virtual EYesNo GetSwapEndianess ( )

inlinevirtual

Determines if the port adapter must perform an endianness swap.

InvalidateNode()

void InvalidateNode

(

)

Read()

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

virtual

Reads a chunk of bytes from the port.

SetPortImpl()

virtual void SetPortImpl ( IPort *  pPort )

virtual

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

UpdateBuffer()

void UpdateBuffer

(

uint8_t *

pBaseAddress

)

Updates the base address of the chunk.

Write()

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

virtual

Writes a chunk of bytes to the port.

Member Data Documentation

m_pChunkPort

void* m_pChunkPort

protected

m_pPort

CNodePtr m_pPort

protected

m_pPortAdapter

std::shared_ptr<PortAdapter> m_pPortAdapter

protected

---

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

• include/SpinGenApi/ChunkPort.h