Class Spinnaker::GenApi::FloatNode¶

ClassList > GenApi > FloatNode

Interface for string properties.

#include <FloatNode.h>

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

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

Public Functions¶

Type	Name
	FloatNode ()
	FloatNode (std::shared_ptr< Node::NodeImpl > pFloat)
virtual EDisplayNotation	GetDisplayNotation () const
virtual int64_t	GetDisplayPrecision () const
IEnumeration *	GetEnumAlias ()
virtual double	GetInc ()
virtual EIncMode	GetIncMode ()
IInteger *	GetIntAlias ()
virtual double_autovector_t	GetListOfValidValues (bool bounded=true)
virtual double	GetMax ()
virtual double	GetMin ()
virtual ERepresentation	GetRepresentation ()
virtual GenICam::gcstring	GetUnit () const
virtual double	GetValue (bool Verify=false, bool IgnoreCache=false)
virtual bool	HasInc ()
virtual void	ImposeMax (double Value)
virtual void	ImposeMin (double Value)
virtual bool	IsValueUpdated ()
virtual void	SetReference (INode * pBase)
virtual void	SetValue (double Value, bool Verify=true)
virtual double	operator() ()
virtual double	operator* ()
virtual IFloat &	operator= (double Value)
virtual	~FloatNode ()

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 FloatNode [1/2]¶

GenApi::FloatNode::FloatNode ()

function FloatNode [2/2]¶

GenApi::FloatNode::FloatNode (
    std::shared_ptr< Node::NodeImpl > pFloat
)

function GetDisplayNotation¶

virtual EDisplayNotation GenApi::FloatNode::GetDisplayNotation () const

Get the way the float should be converted to a string

function GetDisplayPrecision¶

virtual int64_t GenApi::FloatNode::GetDisplayPrecision () const

Get the precision to be used when converting the float to a string

function GetEnumAlias¶

IEnumeration * GenApi::FloatNode::GetEnumAlias ()

gets the interface of an alias node.

function GetInc¶

virtual double GenApi::FloatNode::GetInc ()

Get the constant increment if there is any

function GetIncMode¶

virtual EIncMode GenApi::FloatNode::GetIncMode ()

Get increment mode

function GetIntAlias¶

IInteger * GenApi::FloatNode::GetIntAlias ()

gets the interface of an alias node.

function GetListOfValidValues¶

virtual double_autovector_t GenApi::FloatNode::GetListOfValidValues (
    bool bounded=true
)

Get list of valid value

function GetMax¶

virtual double GenApi::FloatNode::GetMax ()

Get maximum value allowed

function GetMin¶

virtual double GenApi::FloatNode::GetMin ()

Get minimum value allowed

function GetRepresentation¶

virtual ERepresentation GenApi::FloatNode::GetRepresentation ()

Get recommended representation

function GetUnit¶

virtual GenICam::gcstring GenApi::FloatNode::GetUnit () const

Get the physical unit name

function GetValue¶

virtual double GenApi::FloatNode::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 HasInc¶

virtual bool GenApi::FloatNode::HasInc ()

True if the float has a constant increment

function ImposeMax¶

virtual void GenApi::FloatNode::ImposeMax (
    double Value
)

Restrict maximum value

function ImposeMin¶

virtual void GenApi::FloatNode::ImposeMin (
    double Value
)

Restrict minimum value

function IsValueUpdated¶

virtual bool GenApi::FloatNode::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::FloatNode::SetReference (
    INode * pBase
)

overload SetReference for Float

Implements Spinnaker::GenApi::ValueNode::SetReference

function SetValue¶

virtual void GenApi::FloatNode::SetValue (
    double Value,
    bool Verify=true
)

Set node value

Parameters:

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

function operator()¶

virtual double GenApi::FloatNode::operator() ()

Get node value

function operator*¶

virtual double GenApi::FloatNode::operator* ()

Get node value

function operator=¶

virtual IFloat & GenApi::FloatNode::operator= (
    double Value
)

Set node value

function ~FloatNode¶

virtual GenApi::FloatNode::~FloatNode ()

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