Class Spinnaker::GenApi::PortNode¶

ClassList > GenApi > PortNode

Interface for value properties.

#include <PortNode.h>

Inherits the following classes: IPortConstruct, IChunkPort, IPortRecorder, Spinnaker::GenApi::Node

Inherited by the following classes: Spinnaker::GenApi::PortReplay

Public Functions¶

Type	Name
virtual EYesNo	CacheChunkData () const
virtual Spinnaker::GenICam::gcstring	GetChunkID () const
std::shared_ptr< Node::NodeImpl >	GetPortHandle ()
virtual EYesNo	GetSwapEndianess ()
	PortNode ()
	PortNode (std::shared_ptr< Node::NodeImpl > pValue)
virtual void	Read (void * pBuffer, int64_t Address, int64_t Length)
virtual void	Replay (IPortWriteList * pPortRecorder, bool Invalidate=true)
void	SetPortImpl (IPort * pPort)
virtual void	SetReference (INode * pBase)
virtual void	SetReference (IPort * pBase)
virtual void	SetReference (IChunkPort * pBase)
virtual void	SetReference (INode * pBase) Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.
virtual void	SetReference (ISelector * pBase)
virtual void	StartRecording (IPortWriteList * pPortRecorder)
virtual void	StopRecording ()
virtual void	Write (const void * pBuffer, int64_t Address, int64_t Length)
	~PortNode ()

Public Functions inherited from Spinnaker::GenApi::Node¶

See Spinnaker::GenApi::Node

Type	Name
virtual bool	DeregisterCallback (CallbackHandleType hCallback)
virtual EAccessMode	GetAccessMode () const Base interface overrides.
virtual INode *	GetAlias () const
virtual ECachingMode	GetCachingMode () const
virtual INode *	GetCastAlias () const
virtual void	GetChildren (GenApi::NodeList_t & Children, ELinkType LinkType=ctReadingChildren) const Get all nodes this node directly depends on.
virtual GenICam::gcstring	GetDescription () const
virtual GenICam::gcstring	GetDeviceName () const
virtual GenICam::gcstring	GetDisplayName () const
virtual GenICam::gcstring	GetDocuURL () const
virtual GenICam::gcstring	GetEventID () const
virtual void	GetLockNodes (GenApi::NodeList_t & LockNodes) const Gets all nodes which can directly lock this node.
virtual GenICam::gcstring	GetName (bool FullQualified=false) const
virtual GenApi::ENameSpace	GetNameSpace () const
std::shared_ptr< Node::NodeImpl >	GetNodeHandle () const
virtual INodeMap *	GetNodeMap () const
virtual void	GetParents (GenApi::NodeList_t & Parents) const Gets all nodes this node is directly depending on.
virtual int64_t	GetPollingTime () const
virtual EInterfaceType	GetPrincipalInterfaceType () const
virtual bool	GetProperty (const GenICam::gcstring & PropertyName, GenICam::gcstring & ValueStr, GenICam::gcstring & AttributeStr)
virtual void	GetPropertyNames (GenICam::gcstring_vector & PropertyNames) const
virtual void	GetSelectedFeatures (FeatureList_t &) const
virtual void	GetSelectingFeatures (FeatureList_t &) const
virtual GenICam::gcstring	GetToolTip () const
virtual EVisibility	GetVisibility () const
virtual void	ImposeAccessMode (EAccessMode ImposedAccessMode)
virtual void	ImposeVisibility (EVisibility ImposedVisibility)
virtual void	InvalidateNode ()
virtual EYesNo	IsAccessModeCacheable () const
virtual bool	IsCachable () const
virtual bool	IsDeprecated () const
virtual bool	IsFeature () const
virtual bool	IsSelector () const Selector interface overrides.
virtual bool	IsStreamable () const
	Node ()
	Node (std::shared_ptr< Node::NodeImpl > pNodeHandle)
virtual CallbackHandleType	RegisterCallback (CNodeCallback * pCallback)
void	SetNodeHandle (std::shared_ptr< Node::NodeImpl > pNodeHandle)
void	SetNodeMap (INodeMap * pNodeMap)
virtual void	SetReference (INode * pBase) Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.
virtual void	SetReference (ISelector * pBase)
virtual bool	operator!= (int nullPtr) const
virtual bool	operator== (int nullPtr) const
	~Node ()

Protected Attributes inherited from Spinnaker::GenApi::Node¶

See Spinnaker::GenApi::Node

Type	Name
std::list< CallbackHandleType_t * >	m_Callbacks
std::shared_ptr< Node::NodeImpl >	m_pNodeData
INodeMap *	m_pNodeMap

Public Functions Documentation¶

function CacheChunkData¶

virtual EYesNo GenApi::PortNode::CacheChunkData () const

Indicates if the chunk a adapter must hold a cached version of the chunk data

function GetChunkID¶

virtual Spinnaker::GenICam::gcstring GenApi::PortNode::GetChunkID () const

Get the Id of the chunk the port should be attached to

function GetPortHandle¶

inline std::shared_ptr< Node::NodeImpl > GenApi::PortNode::GetPortHandle ()

function GetSwapEndianess¶

virtual EYesNo GenApi::PortNode::GetSwapEndianess ()

Determines if the port adapter must perform an endianess swap

function PortNode [1/2]¶

GenApi::PortNode::PortNode ()

Constructor

function PortNode [2/2]¶

GenApi::PortNode::PortNode (
    std::shared_ptr< Node::NodeImpl > pValue
)

constructor with GenICam IValue

function Read¶

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

Reads a chunk of bytes from the port

function Replay¶

virtual void GenApi::PortNode::Replay (
    IPortWriteList * pPortRecorder,
    bool Invalidate=true
)

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.

function SetPortImpl¶

void GenApi::PortNode::SetPortImpl (
    IPort * pPort
)

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

function SetReference [1/5]¶

virtual void GenApi::PortNode::SetReference (
    INode * pBase
)

overload SetReference for Value

Implements Spinnaker::GenApi::Node::SetReference

function SetReference [2/5]¶

virtual void GenApi::PortNode::SetReference (
    IPort * pBase
)

overload SetReference for Value

function SetReference [3/5]¶

virtual void GenApi::PortNode::SetReference (
    IChunkPort * pBase
)

overload SetReference for Value

function SetReference [4/5]¶

Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.

virtual void GenApi::PortNode::SetReference (
    INode * pBase
)

Implements Spinnaker::GenApi::Node::SetReference

function SetReference [5/5]¶

virtual void GenApi::PortNode::SetReference (
    ISelector * pBase
)

Implements Spinnaker::GenApi::Node::SetReference

function StartRecording¶

virtual void GenApi::PortNode::StartRecording (
    IPortWriteList * pPortRecorder
)

Starts logging all WriteRegister commands to a list

function StopRecording¶

virtual void GenApi::PortNode::StopRecording ()

Stops recording

function Write¶

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

Writes a chunk of bytes to the port

function ~PortNode¶

GenApi::PortNode::~PortNode ()

Destructor

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