Class Spinnaker::GenApi::CChunkPort¶

ClassList > GenApi > CChunkPort

Port attachable to a chunk in a buffer.

#include <ChunkPort.h>

Inherits the following classes: IPortConstruct

Public Functions¶

Type	Name
void	AttachChunk (uint8_t * pBaseAddress, int64_t ChunkOffset, int64_t Length, bool Cache)
bool	AttachPort (::Spinnaker::GenApi::IPort * pPort)
	CChunkPort (IPort * pPort=NULL)
bool	CheckChunkID (uint8_t * pChunkIDBuffer, int ChunkIDLength)
bool	CheckChunkID (uint64_t ChunkID)
void	ClearCache ()
void	DetachChunk ()
void	DetachPort ()
virtual EAccessMode	GetAccessMode () const
int	GetChunkIDLength ()
virtual EInterfaceType	GetPrincipalInterfaceType () const
virtual EYesNo	GetSwapEndianess ()
void	InvalidateNode ()
virtual void	Read (void * pBuffer, int64_t Address, int64_t Length)
virtual void	SetPortImpl (IPort * pPort)
void	UpdateBuffer (uint8_t * pBaseAddress)
virtual void	Write (const void * pBuffer, int64_t Address, int64_t Length)
	~CChunkPort ()

Protected Attributes¶

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

Public Functions Documentation¶

function AttachChunk¶

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

Attaches the Chunk to the ChunkPort.

function AttachPort¶

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

Attaches the ChunkPort to the Port.

function CChunkPort¶

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

Constructor; can attach to a port.

function CheckChunkID [1/2]¶

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

Checks if a ChunkID matches.

function CheckChunkID [2/2]¶

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

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

function ClearCache¶

void GenApi::CChunkPort::ClearCache ()

Clears the chunk cache.

function DetachChunk¶

void GenApi::CChunkPort::DetachChunk ()

Detaches the Chunk from the ChunkPort.

function DetachPort¶

void GenApi::CChunkPort::DetachPort ()

Detaches the ChunkPort to the Port.

function GetAccessMode¶

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

Get the access mode of the node.

function GetChunkIDLength¶

int GenApi::CChunkPort::GetChunkIDLength ()

Gets the ChunkID length.

function GetPrincipalInterfaceType¶

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

Get the type of the main interface of a node.

function GetSwapEndianess¶

inline virtual EYesNo GenApi::CChunkPort::GetSwapEndianess ()

Determines if the port adapter must perform an endianness swap.

function InvalidateNode¶

void GenApi::CChunkPort::InvalidateNode ()

function Read¶

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

Reads a chunk of bytes from the port.

function SetPortImpl¶

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

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

function UpdateBuffer¶

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

Updates the base address of the chunk.

function Write¶

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

Writes a chunk of bytes to the port.

function ~CChunkPort¶

GenApi::CChunkPort::~CChunkPort ()

Destructor; detaches from the port.

Protected Attributes Documentation¶

variable m_pChunkPort¶

void* Spinnaker::GenApi::CChunkPort::m_pChunkPort;

variable m_pPort¶

CNodePtr Spinnaker::GenApi::CChunkPort::m_pPort;

variable m_pPortAdapter¶

std::shared_ptr<PortAdapter> Spinnaker::GenApi::CChunkPort::m_pPortAdapter;

The documentation for this class was generated from the following file /workspace/include/SpinGenApi/ChunkPort.h