Class Spinnaker::GenApi::IntegerNode¶

ClassList > GenApi > IntegerNode

Interface for string properties.

#include <IntegerNode.h>

Inherits the following classes: IInteger, Spinnaker::GenApi::ValueNode

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

Public Functions¶

Type	Name
virtual IFloat *	GetFloatAlias ()
virtual int64_t	GetInc ()
virtual EIncMode	GetIncMode ()
virtual int64_autovector_t	GetListOfValidValues (bool bounded=true)
virtual int64_t	GetMax ()
virtual int64_t	GetMin ()
virtual ERepresentation	GetRepresentation ()
virtual GenICam::gcstring	GetUnit ()
virtual int64_t	GetValue (bool Verify=false, bool IgnoreCache=false)
virtual void	ImposeMax (int64_t Value)
virtual void	ImposeMin (int64_t Value)
	IntegerNode ()
	IntegerNode (std::shared_ptr< Node::NodeImpl > pInteger)
virtual bool	IsValueUpdated ()
virtual void	SetReference (INode * pBase)
virtual void	SetValue (int64_t Value, bool Verify=true)
virtual int64_t	operator() ()
virtual int64_t	operator* ()
virtual IInteger &	operator= (int64_t Value)
virtual	~IntegerNode ()

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

See Spinnaker::GenApi::ValueNode

Type	Name
virtual void	FromString (const GenICam::gcstring & ValueStr, bool Verify=true)
virtual INode *	GetNode ()
virtual bool	IsValueCacheValid () const
virtual bool	IsValueUpdated ()
virtual void	SetReference (INode * pBase)
virtual GenICam::gcstring	ToString (bool Verify=false, bool IgnoreCache=false)
	ValueNode ()
	ValueNode (std::shared_ptr< Node::NodeImpl > pValue)
	~ValueNode ()

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 GetFloatAlias¶

virtual IFloat * GenApi::IntegerNode::GetFloatAlias ()

gets the interface of an alias node.

function GetInc¶

virtual int64_t GenApi::IntegerNode::GetInc ()

Get increment

function GetIncMode¶

virtual EIncMode GenApi::IntegerNode::GetIncMode ()

Get increment mode

function GetListOfValidValues¶

virtual int64_autovector_t GenApi::IntegerNode::GetListOfValidValues (
    bool bounded=true
)

Get list of valid value

function GetMax¶

virtual int64_t GenApi::IntegerNode::GetMax ()

Get maximum value allowed

function GetMin¶

virtual int64_t GenApi::IntegerNode::GetMin ()

Get minimum value allowed

function GetRepresentation¶

virtual ERepresentation GenApi::IntegerNode::GetRepresentation ()

Get recommended representation

function GetUnit¶

virtual GenICam::gcstring GenApi::IntegerNode::GetUnit ()

Get the physical unit name

function GetValue¶

virtual int64_t GenApi::IntegerNode::GetValue (
    bool Verify=false,
    bool IgnoreCache=false
)

Get node value

Parameters:

Verify Enables Range verification (default = false). The AccessMode is always checked
IgnoreCache If true the value is read ignoring any caches (default = false)

Returns:

The value read

function ImposeMax¶

virtual void GenApi::IntegerNode::ImposeMax (
    int64_t Value
)

Restrict maximum value

function ImposeMin¶

virtual void GenApi::IntegerNode::ImposeMin (
    int64_t Value
)

Restrict minimum value

function IntegerNode [1/2]¶

GenApi::IntegerNode::IntegerNode ()

function IntegerNode [2/2]¶

GenApi::IntegerNode::IntegerNode (
    std::shared_ptr< Node::NodeImpl > pInteger
)

function IsValueUpdated¶

virtual bool GenApi::IntegerNode::IsValueUpdated ()

Checks if the content of the node has changed since the value was last cached by IsValueUpdated() or GetValue().

Returns:

true if the node value has changed, false otherwise.

Implements Spinnaker::GenApi::ValueNode::IsValueUpdated

function SetReference¶

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

overload SetReference for Integer

Implements Spinnaker::GenApi::ValueNode::SetReference

function SetValue¶

virtual void GenApi::IntegerNode::SetValue (
    int64_t Value,
    bool Verify=true
)

Set node value

Parameters:

Value The value to set
Verify Enables AccessMode and Range verification (default = true)

function operator()¶

virtual int64_t GenApi::IntegerNode::operator() ()

Get node value

function operator*¶

virtual int64_t GenApi::IntegerNode::operator* ()

Get node value

function operator=¶

virtual IInteger & GenApi::IntegerNode::operator= (
    int64_t Value
)

Set node value

function ~IntegerNode¶

virtual GenApi::IntegerNode::~IntegerNode ()

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