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

#include <ChunkPort.h>

Inheritance diagram for GENAPI_NAMESPACE::CChunkPort:

Public Member Functions
void	AttachChunk (uint8_t *pBaseAddress, int64_t ChunkOffset, int64_t Length, bool Cache)
	Attaches the Chunk to the ChunkPort. More...

bool	AttachPort (GENAPI_NAMESPACE::IPort *pPort)
	Attaches the ChunkPort to the Port. More...

	CChunkPort (IPort *pPort=NULL)
	Constructor; can attach to a port. More...

bool	CheckChunkID (uint64_t ChunkID)
	Checks if a ChunkID matches, version using uint64_t ID representation. More...

bool	CheckChunkID (uint8_t *pChunkIDBuffer, int ChunkIDLength)
	Checks if a ChunkID matches. More...

void	ClearCache ()
	Clears the chunk cache. More...

void	DetachChunk ()
	Detaches the Chunk from the ChunkPort. More...

void	DetachPort ()
	Detaches the ChunkPort to the Port. More...

virtual EAccessMode	GetAccessMode () const
	Get the access mode of the node. More...

int	GetChunkIDLength ()
	Gets the ChunkID length. More...

virtual EInterfaceType	GetPrincipalInterfaceType () const
	Get the type of the main interface of a node. More...

virtual EYesNo	GetSwapEndianess ()
	Determines if the port adapter must perform an endianess swap. More...

void	InvalidateNode ()

virtual void	Read (void *pBuffer, int64_t Address, int64_t Length)
	Reads a chunk of bytes from the port. More...

virtual void	SetPortImpl (GENAPI_NAMESPACE::IPort *pPort)
	Called from the port node to give the chunk port a pointer to itself. More...

virtual void	SetPortImpl (GENAPI_NAMESPACE::IPortStacked *pPort)
	Called from the port node to give the chunk port a pointer to itself. More...

void	UpdateBuffer (uint8_t *pBaseAddress)
	Updates the base address of the chunk. More...

virtual void	Write (const void *pBuffer, int64_t Address, int64_t Length)
	Writes a chunk of bytes to the port. More...

virtual	~CChunkPort ()
	Destructor; detaches from the port. More...

Protected Member Functions
CLock &	GetLock () const

Protected Attributes
bool	m_CacheData
	indicates if the data needs to be cached More...

int	m_ChunkIDLength
	Length of the chunk ID buffer. More...

uint64_t	m_ChunkIDNumber
	Chunk ID stored as a number (for more straightforward access) More...

bool	m_ChunkIDNumberValid
	indicates if the m_ChunkIDNumber is valid (could be invalid eg. if the ID does not fit in 64-bit range) More...

int64_t	m_ChunkOffset
	The chunk's offset within the buffer. More...

int64_t	m_Length
	Length of the chunk. More...

int64_t	m_LengthAlloc
	Space allocated for the chunk. More...

uint8_t *	m_pBaseAddress
	Pointer to the begin of the buffer. More...

uint8_t *	m_pChunkData
	cache for the chunk data More...

uint8_t *	m_pChunkIDBuffer
	Binary version of the chunk ID. More...

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

Private Member Functions
	CChunkPort (const CChunkPort &)

CChunkPort &	operator= (const CChunkPort &)

Detailed Description

Port attachable to a chunk in a buffer.

Definition at line 50 of file ChunkPort.h.

Constructor & Destructor Documentation

◆ CChunkPort() [1/2]

GENAPI_NAMESPACE::CChunkPort::CChunkPort ( IPort * pPort = NULL )

Constructor; can attach to a port.

◆ ~CChunkPort()

virtual GENAPI_NAMESPACE::CChunkPort::~CChunkPort ( )

virtual

Destructor; detaches from the port.

◆ CChunkPort() [2/2]

GENAPI_NAMESPACE::CChunkPort::CChunkPort ( const CChunkPort & )

private

Member Function Documentation

◆ AttachChunk()

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

Attaches the Chunk to the ChunkPort.

◆ AttachPort()

bool GENAPI_NAMESPACE::CChunkPort::AttachPort ( GENAPI_NAMESPACE::IPort * pPort )

Attaches the ChunkPort to the Port.

◆ CheckChunkID() [1/2]

bool GENAPI_NAMESPACE::CChunkPort::CheckChunkID ( uint64_t ChunkID )

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

◆ CheckChunkID() [2/2]

bool GENAPI_NAMESPACE::CChunkPort::CheckChunkID	(	uint8_t *	pChunkIDBuffer,
		int	ChunkIDLength
	)

Checks if a ChunkID matches.

◆ ClearCache()

void GENAPI_NAMESPACE::CChunkPort::ClearCache ( )

Clears the chunk cache.

◆ DetachChunk()

void GENAPI_NAMESPACE::CChunkPort::DetachChunk ( )

Detaches the Chunk from the ChunkPort.

◆ DetachPort()

void GENAPI_NAMESPACE::CChunkPort::DetachPort ( )

Detaches the ChunkPort to the Port.

◆ GetAccessMode()

virtual EAccessMode GENAPI_NAMESPACE::CChunkPort::GetAccessMode ( ) const

virtual

Get the access mode of the node.

◆ GetChunkIDLength()

int GENAPI_NAMESPACE::CChunkPort::GetChunkIDLength ( )

inline

Gets the ChunkID length.

Definition at line 116 of file ChunkPort.h.

◆ GetLock()

CLock& GENAPI_NAMESPACE::CChunkPort::GetLock ( ) const

inlineprotected

Definition at line 134 of file ChunkPort.h.

◆ GetPrincipalInterfaceType()

virtual EInterfaceType GENAPI_NAMESPACE::CChunkPort::GetPrincipalInterfaceType ( ) const

virtual

Get the type of the main interface of a node.

◆ GetSwapEndianess()

virtual EYesNo GENAPI_NAMESPACE::CChunkPort::GetSwapEndianess ( )

inlinevirtual

Determines if the port adapter must perform an endianess swap.

Definition at line 87 of file ChunkPort.h.

◆ InvalidateNode()

void GENAPI_NAMESPACE::CChunkPort::InvalidateNode ( )

◆ operator=()

CChunkPort& GENAPI_NAMESPACE::CChunkPort::operator= ( const CChunkPort & )

private

◆ Read()

virtual void GENAPI_NAMESPACE::CChunkPort::Read	(	void *	pBuffer,
		int64_t	Address,
		int64_t	Length
	)

virtual

Reads a chunk of bytes from the port.

◆ SetPortImpl() [1/2]

virtual void GENAPI_NAMESPACE::CChunkPort::SetPortImpl ( GENAPI_NAMESPACE::IPort * pPort )

virtual

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

◆ SetPortImpl() [2/2]

virtual void GENAPI_NAMESPACE::CChunkPort::SetPortImpl ( GENAPI_NAMESPACE::IPortStacked * pPort )

virtual

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

◆ UpdateBuffer()

void GENAPI_NAMESPACE::CChunkPort::UpdateBuffer ( uint8_t * pBaseAddress )

Updates the base address of the chunk.

◆ Write()

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

virtual

Writes a chunk of bytes to the port.

Member Data Documentation

◆ m_CacheData

bool GENAPI_NAMESPACE::CChunkPort::m_CacheData

protected

indicates if the data needs to be cached

Definition at line 171 of file ChunkPort.h.

◆ m_ChunkIDLength

int GENAPI_NAMESPACE::CChunkPort::m_ChunkIDLength

protected

Length of the chunk ID buffer.

Definition at line 165 of file ChunkPort.h.

◆ m_ChunkIDNumber

uint64_t GENAPI_NAMESPACE::CChunkPort::m_ChunkIDNumber

protected

Chunk ID stored as a number (for more straightforward access)

Definition at line 174 of file ChunkPort.h.

◆ m_ChunkIDNumberValid

bool GENAPI_NAMESPACE::CChunkPort::m_ChunkIDNumberValid

protected

indicates if the m_ChunkIDNumber is valid (could be invalid eg. if the ID does not fit in 64-bit range)

Definition at line 177 of file ChunkPort.h.

◆ m_ChunkOffset

int64_t GENAPI_NAMESPACE::CChunkPort::m_ChunkOffset

protected

The chunk's offset within the buffer.

Definition at line 150 of file ChunkPort.h.

◆ m_Length

int64_t GENAPI_NAMESPACE::CChunkPort::m_Length

protected

Length of the chunk.

Definition at line 153 of file ChunkPort.h.

◆ m_LengthAlloc

int64_t GENAPI_NAMESPACE::CChunkPort::m_LengthAlloc

protected

Space allocated for the chunk.

Definition at line 156 of file ChunkPort.h.

◆ m_pBaseAddress

uint8_t* GENAPI_NAMESPACE::CChunkPort::m_pBaseAddress

protected

Pointer to the begin of the buffer.

Definition at line 147 of file ChunkPort.h.

◆ m_pChunkData

uint8_t* GENAPI_NAMESPACE::CChunkPort::m_pChunkData

protected

cache for the chunk data

Definition at line 168 of file ChunkPort.h.

◆ m_pChunkIDBuffer

uint8_t* GENAPI_NAMESPACE::CChunkPort::m_pChunkIDBuffer

protected

Binary version of the chunk ID.

Definition at line 162 of file ChunkPort.h.

◆ m_ptrPort

CNodePtr GENAPI_NAMESPACE::CChunkPort::m_ptrPort

protected

Pointer to the node holding a reference to this implementation.

Definition at line 159 of file ChunkPort.h.

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

ChunkPort.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CChunkPort() [1/2]

◆ ~CChunkPort()

◆ CChunkPort() [2/2]

Member Function Documentation

◆ AttachChunk()

◆ AttachPort()

◆ CheckChunkID() [1/2]

◆ CheckChunkID() [2/2]

◆ ClearCache()

◆ DetachChunk()

◆ DetachPort()

◆ GetAccessMode()

◆ GetChunkIDLength()

◆ GetLock()

◆ GetPrincipalInterfaceType()

◆ GetSwapEndianess()

◆ InvalidateNode()

◆ operator=()

◆ Read()

◆ SetPortImpl() [1/2]

◆ SetPortImpl() [2/2]

◆ UpdateBuffer()

◆ Write()

Member Data Documentation

◆ m_CacheData

◆ m_ChunkIDLength

◆ m_ChunkIDNumber

◆ m_ChunkIDNumberValid

◆ m_ChunkOffset

◆ m_Length

◆ m_LengthAlloc

◆ m_pBaseAddress

◆ m_pChunkData

◆ m_pChunkIDBuffer

◆ m_ptrPort