Pylon Logo Basler Logo
Public Member Functions | List of all members
Pylon::IBooleanEx Struct Referenceabstract

Extends the GenApi::IBoolean interface with convenience methods. More...

#include <pylon/BooleanParameter.h>

Inheritance diagram for Pylon::IBooleanEx:
Inheritance graph
[legend]

Public Member Functions

virtual bool TrySetValue (bool value)=0
 Sets the Boolean value of the parameter if the parameter is writable. More...
 
virtual bool GetValueOrDefault (bool defaultValue)=0
 Gets the Boolean value of the parameter if the parameter is readable. More...
 
virtual void SetValue (bool Value, bool Verify=true)=0
 Set node value. More...
 
virtual bool GetValue (bool Verify=false, bool IgnoreCache=false) const =0
 Get node value. More...
 
virtual bool operator() () const
 Get node value.
 
virtual INode * GetNode ()
 Get the INode interface of the node.
 
virtual GenICam::gcstring ToString (bool Verify=false, bool IgnoreCache=false)=0
 Get content of the node as string. More...
 
virtual void FromString (const GenICam::gcstring &ValueStr, bool Verify=true)=0
 Set content of the node as string. More...
 
virtual bool IsValueCacheValid () const =0
 Checks if the value comes from cache or is requested from another node.
 
virtual EAccessMode GetAccessMode () const =0
 Get the access mode of the node.
 
virtual bool IsReadable () const =0
 Indicates whether the parameter is readable. More...
 
virtual bool IsWritable () const =0
 Indicates whether the parameter is writable. More...
 
virtual bool IsValid () const =0
 Indicates whether a node is attached. More...
 
virtual String_t GetInfo (EParameterInfo info)=0
 Gets the parameter information. More...
 
virtual String_t GetInfoOrDefault (EParameterInfo info, const String_t defaultInfo)=0
 Gets the parameter information if the parameter is attached to a node. More...
 
virtual String_t ToStringOrDefault (const String_t &defaultValue)=0
 Gets the parameter value as string if the parameter is readable. More...
 

Detailed Description

Extends the GenApi::IBoolean interface with convenience methods.

Member Function Documentation

virtual void GenApi::IValue::FromString ( const GenICam::gcstring ValueStr,
bool  Verify = true 
)
pure virtualinherited

Set content of the node as string.

Parameters
ValueStrThe value to set
VerifyEnables AccessMode and Range verification (default = true)

Implemented in Pylon::CParameter.

virtual String_t Pylon::IValueEx::GetInfo ( EParameterInfo  info)
pure virtualinherited

Gets the parameter information.

Parameters
[in]infoThe type information to return.
Returns
Returns the parameter information.
Thread Safety:
The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
Error Safety:
Throws an exception if no node is attached. Can throw exceptions if the retrieval of the information fails.

Implemented in Pylon::CParameter.

virtual String_t Pylon::IValueEx::GetInfoOrDefault ( EParameterInfo  info,
const String_t  defaultInfo 
)
pure virtualinherited

Gets the parameter information if the parameter is attached to a node.

See IsValid().

Parameters
[in]infoThe type information to return. Otherwise returns the default information. This method is useful if you want to display parameter information and handle the case that some parameters are not available for a device.
Returns
Returns the parameter information if the parameter is attached to a node. Otherwise returns the default information.
Parameters
[in]defaultInfoThe default information returned if the parameter is not attached to a node.
Thread Safety:
The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
Error Safety:
Can throw exceptions if the retrieval of the information fails.

Implemented in Pylon::CParameter.

virtual bool GenApi::IBoolean::GetValue ( bool  Verify = false,
bool  IgnoreCache = false 
) const
pure virtualinherited

Get node value.

Parameters
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
Returns
The value read

Implemented in Pylon::CBooleanParameter.

virtual bool Pylon::IBooleanEx::GetValueOrDefault ( bool  defaultValue)
pure virtual

Gets the Boolean value of the parameter if the parameter is readable.

Otherwise returns the default value.

Returns
Returns the parameter value if the parameter is readable. Otherwise returns the default value.
Parameters
[in]defaultValueThe default value returned if the parameter is not readable.
Thread Safety:
The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
Error Safety:
Can throw exceptions if reading the value fails.

Implemented in Pylon::CBooleanParameter.

virtual bool Pylon::IValueEx::IsReadable ( ) const
pure virtualinherited

Indicates whether the parameter is readable.

Error Safety:
Does not throw C++ exceptions.
Returns
Returns true if the parameter is readable.

Implemented in Pylon::CParameter.

virtual bool Pylon::IValueEx::IsValid ( ) const
pure virtualinherited

Indicates whether a node is attached.

Returns
Returns true if a node is attached.
Error Safety:
Does not throw C++ exceptions.

Implemented in Pylon::CFloatParameter, Pylon::CIntegerParameter, Pylon::CEnumParameter, Pylon::CParameter, Pylon::CStringParameter, Pylon::CBooleanParameter, Pylon::CCommandParameter, and Pylon::CArrayParameter.

virtual bool Pylon::IValueEx::IsWritable ( ) const
pure virtualinherited

Indicates whether the parameter is writable.

Error Safety:
Does not throw C++ exceptions.
Returns
Returns true if the parameter is writable.

Implemented in Pylon::CParameter.

virtual void GenApi::IBoolean::SetValue ( bool  Value,
bool  Verify = true 
)
pure virtualinherited

Set node value.

Parameters
ValueThe value to set
VerifyEnables AccessMode and Range verification (default = true)

Implemented in Pylon::CBooleanParameter.

virtual GenICam::gcstring GenApi::IValue::ToString ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtualinherited

Get content of the node as string.

Parameters
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
Returns
The value read

Implemented in Pylon::CParameter.

virtual String_t Pylon::IValueEx::ToStringOrDefault ( const String_t defaultValue)
pure virtualinherited

Gets the parameter value as string if the parameter is readable.

Otherwise returns the default value.

Returns
Returns the parameter value if the parameter is readable. Otherwise returns the default value.
Parameters
[in]defaultValueThe default value returned if the parameter is not readable.
Thread Safety:
The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
Error Safety:
Can throw exceptions if reading the value fails.

Implemented in Pylon::CParameter.

virtual bool Pylon::IBooleanEx::TrySetValue ( bool  value)
pure virtual

Sets the Boolean value of the parameter if the parameter is writable.

Returns
Returns false if the parameter is not writable.
Parameters
[in]valueThe Boolean value to set.
Thread Safety:
The method accesses the parameter multiple times. These accesses are not synchronized by a lock.
Error Safety:
Can throw exceptions if the preconditions are not met or if writing the value fails.

Implemented in Pylon::CBooleanParameter.


The documentation for this struct was generated from the following file:

pylon 6.1.0
Copyright (c) 2006-2020 Basler AG (Mon Mar 16 2020 10:57:00)