Class Spinnaker::GenApi::StringNode¶

ClassList > GenApi > StringNode

Interface for string properties.

#include <StringNode.h>

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

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

Public Functions¶

Type	Name
virtual int64_t	GetMaxLength ()
virtual GenICam::gcstring	GetValue (bool Verify=false, bool IgnoreCache=false)
virtual bool	IsValueUpdated ()
virtual void	SetReference (INode * pBase)
virtual void	SetValue (const GenICam::gcstring & Value, bool Verify=true)
	StringNode ()
	StringNode (std::shared_ptr< Node::NodeImpl > pString)
virtual GenICam::gcstring	operator() ()
virtual GenICam::gcstring	operator* ()
virtual IString &	operator= (const GenICam::gcstring & Value)
virtual	~StringNode ()

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

virtual int64_t GenApi::StringNode::GetMaxLength ()

Retrieves the maximum length of the string in bytes

function GetValue¶

virtual GenICam::gcstring GenApi::StringNode::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 IsValueUpdated¶

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

overload SetReference for Value

Implements Spinnaker::GenApi::ValueNode::SetReference

function SetValue¶

virtual void GenApi::StringNode::SetValue (
    const  GenICam::gcstring & Value,
    bool Verify=true
)

Set node value

Parameters:

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

function StringNode [1/2]¶

GenApi::StringNode::StringNode ()

function StringNode [2/2]¶

GenApi::StringNode::StringNode (
    std::shared_ptr< Node::NodeImpl > pString
)

function operator()¶

virtual GenICam::gcstring GenApi::StringNode::operator() ()

Get node value

function operator*¶

virtual GenICam::gcstring GenApi::StringNode::operator* ()

Get node value

function operator=¶

virtual IString & GenApi::StringNode::operator= (
    const  GenICam::gcstring & Value
)

Set node value

function ~StringNode¶

virtual GenApi::StringNode::~StringNode ()

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