Pylon Logo Basler Logo
Public Member Functions | List of all members
Pylon::CStringParameter Class Referenceabstract

CStringParameter class used to simplify access to GenApi parameters. More...

#include <pylon/StringParameter.h>

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

Public Member Functions

 CStringParameter ()
 Creates an empty CStringParameter object. More...
 
 CStringParameter (GenApi::INode *pNode)
 Creates a CStringParameter object and attaches it to a node, typically retrieved for a nodemap calling GetNode(). More...
 
 CStringParameter (GenApi::IString *pString)
 Creates a CStringParameter object and attaches it to a node of a matching type. More...
 
 CStringParameter (GenApi::INodeMap *pNodeMap, const char *pName)
 Creates a CStringParameter object and attaches it to a node retrieved from the provided node map. More...
 
 CStringParameter (GenApi::INodeMap &nodeMap, const char *pName)
 Creates a CStringParameter object and attaches it to a node retrieved from the provided node map. More...
 
 CStringParameter (const CStringParameter &rhs)
 Copies a CStringParameter object. More...
 
virtual ~CStringParameter ()
 Destroys the CStringParameter object. More...
 
virtual bool Attach (GenApi::INodeMap *pNodeMap, const char *pName)
 Attaches a node retrieved from the provided node map. More...
 
virtual bool Attach (GenApi::INodeMap &nodeMap, const char *pName)
 Attaches a node retrieved from the provided node map. More...
 
virtual bool Attach (GenApi::INode *pNode)
 Attaches a node, typically retrieved for a nodemap calling GetNode(). More...
 
virtual bool Attach (GenApi::IString *pString)
 Assigns a node of the same type to the parameter object. More...
 
CStringParameteroperator= (const CStringParameter &rhs)
 Assigns a CStringParameter object. More...
 
virtual bool Equals (const CStringParameter &rhs) const
 Returns true if the same nodes are attached or both parameters are empty. More...
 
virtual bool Equals (const GenApi::INode *pNode) const
 Returns true if the attached node pointer is equal. More...
 
virtual bool Equals (const GenApi::IString *pString) const
 Returns true if the attached node pointer is equal. More...
 
virtual void Release ()
 Releases the attached node. More...
 
virtual bool IsValid () const
 Indicates whether a node is attached. More...
 
virtual void SetValue (const GenICam::gcstring &value, bool verify=true)
 Set node value. More...
 
virtual GenApi::IStringoperator= (const GenICam::gcstring &value)
 Set node value.
 
virtual GenICam::gcstring GetValue (bool verify=false, bool ignoreCache=false)
 Get node value. More...
 
virtual GenICam::gcstring operator() ()
 Get node value.
 
virtual GenICam::gcstring operator* ()
 Get node value.
 
virtual int64_t GetMaxLength ()
 Retrieves the maximum length of the string in bytes.
 
virtual bool TrySetValue (const String_t &value)
 Sets the value of the parameter if the parameter is writable. More...
 
virtual String_t GetValueOrDefault (const String_t &defaultValue)
 Gets the value of the parameter if the parameter is readable. More...
 
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 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...
 
virtual bool Attach (GenApi::IValue *pValue)
 Assigns a node of the same type to the parameter object. More...
 
virtual bool Equals (const CParameter &rhs) const
 Returns true if the same nodes are attached or both parameters are empty. More...
 
virtual bool Equals (const GenApi::IValue *pValue) const
 Returns true if the attached node pointer is equal. More...
 
virtual GenApi::EAccessMode GetAccessMode () const
 Get the access mode of the node.
 
virtual GenApi::INodeGetNode ()
 Get the INode interface of the node.
 
virtual GenICam::gcstring ToString (bool verify=false, bool ignoreCache=false)
 Get content of the node as string. More...
 
virtual void FromString (const GenICam::gcstring &valueStr, bool verify=true)
 Set content of the node as string. More...
 
virtual bool IsValueCacheValid () const
 Checks if the value comes from cache or is requested from another node.
 
virtual bool IsReadable () const
 Indicates whether the parameter is readable. More...
 
virtual bool IsWritable () const
 Indicates whether the parameter is writable. More...
 
virtual String_t GetInfo (EParameterInfo info)
 Gets the parameter information. More...
 
virtual String_t GetInfoOrDefault (EParameterInfo info, const String_t defaultInfo)
 Gets the parameter information if the parameter is attached to a node. More...
 
virtual String_t ToStringOrDefault (const String_t &defaultValue)
 Gets the parameter value as string if the parameter is readable. More...
 

Detailed Description

CStringParameter class used to simplify access to GenApi parameters.

Constructor & Destructor Documentation

Pylon::CStringParameter::CStringParameter ( )

Creates an empty CStringParameter object.

Error Safety:
Does not throw C++ exceptions.
Pylon::CStringParameter::CStringParameter ( GenApi::INode pNode)
explicit

Creates a CStringParameter object and attaches it to a node, typically retrieved for a nodemap calling GetNode().

Parameters
[in]pNodeThe node to attach.
Postcondition
  • If the passed node does not match the parameter type, the parameter will be empty, see IsValid().
  • If the passed node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
  • The parameter object must not be used to access the node's functionality if the source of the attached pNode has been destroyed. In this case, call Release() or attach a new node.
Error Safety:
Does not throw C++ exceptions.
Pylon::CStringParameter::CStringParameter ( GenApi::IString pString)
explicit

Creates a CStringParameter object and attaches it to a node of a matching type.

Parameters
[in]pStringThe node to attach.
Postcondition
The parameter object must not be used to access the node's functionality if the source of the attached pString has been destroyed. In this case, call Release() or attach a new node.
Error Safety:
Does not throw C++ exceptions.
Pylon::CStringParameter::CStringParameter ( GenApi::INodeMap pNodeMap,
const char *  pName 
)

Creates a CStringParameter object and attaches it to a node retrieved from the provided node map.

Parameters
[in]pNodeMapThe node map. The source of the parameter.
[in]pNameThe name of the parameter to attach.
Postcondition
  • If pNodeMap or name is NULL, the parameter will be empty, see IsValid().
  • If the node does not match the parameter type, the parameter will be empty, see IsValid().
  • If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
  • The parameter object must not be used to access the node's functionality if the provided node map has been destroyed. In this case, call Release() or attach a new node.
Error Safety:
The call to GenApi::INodeMap::GetNode can throw C++ exceptions.
Pylon::CStringParameter::CStringParameter ( GenApi::INodeMap nodeMap,
const char *  pName 
)

Creates a CStringParameter object and attaches it to a node retrieved from the provided node map.

Parameters
[in]nodeMapThe node map. The source of the parameter.
[in]pNameThe name of the parameter to attach.
Postcondition
  • If name is NULL, the parameter will be empty, see IsValid().
  • If the node does not match the parameter type, the parameter will be empty, see IsValid().
  • If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
  • The parameter object must not be used to access the node's functionality if the provided node map has been destroyed. In this case, call Release() or attach a new node.
Error Safety:
The call to GenApi::INodeMap::GetNode can throw C++ exceptions.
Pylon::CStringParameter::CStringParameter ( const CStringParameter rhs)

Copies a CStringParameter object.

Parameters
[in]rhsThe object to copy.
Error Safety:
Does not throw C++ exceptions.
virtual Pylon::CStringParameter::~CStringParameter ( )
virtual

Destroys the CStringParameter object.

Does not access the attached node.

Error Safety:
Does not throw C++ exceptions.

Member Function Documentation

virtual bool Pylon::CStringParameter::Attach ( GenApi::INodeMap pNodeMap,
const char *  pName 
)
virtual

Attaches a node retrieved from the provided node map.

Parameters
[in]pNodeMapThe node map. The source of the parameter.
[in]pNameThe name of the parameter to attach.
Returns
Returns true if the node has been attached.
Postcondition
  • If pNodeMap or name is NULL, the parameter will be empty, see IsValid().
  • If the node does not match the parameter type, the parameter will be empty, see IsValid().
  • If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
  • The parameter object must not be used to access the node's functionality if the provided node map has been destroyed. In this case, call Release() or attach a new node.
Error Safety:
The call to GenApi::INodeMap::GetNode can throw C++ exceptions.

Reimplemented from Pylon::CParameter.

virtual bool Pylon::CStringParameter::Attach ( GenApi::INodeMap nodeMap,
const char *  pName 
)
virtual

Attaches a node retrieved from the provided node map.

Parameters
[in]nodeMapThe node map. The source of the parameter.
[in]pNameThe name of the parameter to attach.
Returns
Returns true if the node has been attached.
Postcondition
  • If name is NULL the parameter will be empty, see IsValid().
  • If the node does not match the parameter type, the parameter will be empty, see IsValid().
  • If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
  • The parameter object must not be used to access the node's functionality if the provided node map has been destroyed. In this case, call Release() or attach a new node.
Error Safety:
The call to GenApi::INodeMap::GetNode can throw C++ exceptions.

Reimplemented from Pylon::CParameter.

virtual bool Pylon::CStringParameter::Attach ( GenApi::INode pNode)
virtual

Attaches a node, typically retrieved for a nodemap calling GetNode().

Parameters
[in]pNodeThe node to assign.
Returns
Returns true if the node has been attached.
Postcondition
  • If the node does not match the parameter type, the parameter will be empty, see IsValid().
  • If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
  • The parameter object must not be used to access the node's functionality if the source of the attached pNode has been destroyed. In this case, call Release() or attach a new node.
Error Safety:
Does not throw C++ exceptions.

Reimplemented from Pylon::CParameter.

virtual bool Pylon::CStringParameter::Attach ( GenApi::IString pString)
virtual

Assigns a node of the same type to the parameter object.

Parameters
[in]pStringThe node to assign.
Returns
Returns true if the node has been attached.
Error Safety:
Does not throw C++ exceptions.
virtual bool Pylon::CParameter::Attach ( GenApi::IValue pValue)
virtualinherited

Assigns a node of the same type to the parameter object.

Parameters
[in]pValueThe node to assign.
Returns
Returns true if the node has been attached.
Error Safety:
Does not throw C++ exceptions.
virtual bool Pylon::CStringParameter::Equals ( const CStringParameter rhs) const
virtual

Returns true if the same nodes are attached or both parameters are empty.

Parameters
[in]rhsThe object to compare to.
Returns
Returns true if the same nodes are attached or both parameters are empty.
Error Safety:
Does not throw C++ exceptions.
virtual bool Pylon::CStringParameter::Equals ( const GenApi::INode pNode) const
virtual

Returns true if the attached node pointer is equal.

Parameters
[in]pNodeThe node to compare to.
Returns
Returns true if the attached node pointer is equal.
Error Safety:
Does not throw C++ exceptions.

Reimplemented from Pylon::CParameter.

virtual bool Pylon::CStringParameter::Equals ( const GenApi::IString pString) const
virtual

Returns true if the attached node pointer is equal.

Parameters
[in]pStringThe node to compare to.
Returns
Returns true if the attached node pointer is equal.
Error Safety:
Does not throw C++ exceptions.
virtual bool Pylon::CParameter::Equals ( const CParameter rhs) const
virtualinherited

Returns true if the same nodes are attached or both parameters are empty.

Parameters
[in]rhsThe object to compare to.
Returns
Returns true if the same nodes are attached or both parameters are empty.
Error Safety:
Does not throw C++ exceptions.
virtual bool Pylon::CParameter::Equals ( const GenApi::IValue pValue) const
virtualinherited

Returns true if the attached node pointer is equal.

Parameters
[in]pValueThe node to compare to.
Returns
Returns true if the attached node pointer is equal.
Error Safety:
Does not throw C++ exceptions.
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 void Pylon::CParameter::FromString ( const GenICam::gcstring ValueStr,
bool  Verify = true 
)
virtualinherited

Set content of the node as string.

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

Implements GenApi::IValue.

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::CParameter::GetInfo ( EParameterInfo  info)
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.

Implements Pylon::IValueEx.

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 String_t Pylon::CParameter::GetInfoOrDefault ( EParameterInfo  info,
const String_t  defaultInfo 
)
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.

Implements Pylon::IValueEx.

virtual GenICam::gcstring Pylon::CStringParameter::GetValue ( bool  Verify = false,
bool  IgnoreCache = false 
)
virtual

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

Implements GenApi::IString.

virtual String_t Pylon::CStringParameter::GetValueOrDefault ( const String_t defaultValue)
virtual

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

Otherwise returns the default value.

Returns
Returns the value of the parameter 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.

Implements Pylon::IStringEx.

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::CParameter::IsReadable ( ) const
virtualinherited

Indicates whether the parameter is readable.

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

Implements Pylon::IValueEx.

virtual bool Pylon::CStringParameter::IsValid ( ) const
virtual

Indicates whether a node is attached.

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

Reimplemented from Pylon::CParameter.

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 bool Pylon::CParameter::IsWritable ( ) const
virtualinherited

Indicates whether the parameter is writable.

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

Implements Pylon::IValueEx.

CStringParameter& Pylon::CStringParameter::operator= ( const CStringParameter rhs)

Assigns a CStringParameter object.

Parameters
[in]rhsThe object to assign.
Error Safety:
Does not throw C++ exceptions.
virtual void Pylon::CStringParameter::Release ( )
virtual

Releases the attached node.

Error Safety:
Does not throw C++ exceptions.

Reimplemented from Pylon::CParameter.

virtual void Pylon::CStringParameter::SetValue ( const GenICam::gcstring Value,
bool  Verify = true 
)
virtual

Set node value.

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

Implements GenApi::IString.

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 GenICam::gcstring Pylon::CParameter::ToString ( bool  Verify = false,
bool  IgnoreCache = false 
)
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

Implements GenApi::IValue.

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 String_t Pylon::CParameter::ToStringOrDefault ( const String_t defaultValue)
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.

Implements Pylon::IValueEx.

virtual bool Pylon::CStringParameter::TrySetValue ( const String_t value)
virtual

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

Returns
Returns false if the parameter is not writable.
Parameters
[in]valueThe string value to set.
Precondition
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.

Implements Pylon::IStringEx.


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

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