NetworkConfiguration

Camera network configuration (IPv4 mode and address).

class NetworkConfiguration

Network configuration of a camera.

Public Functions

NetworkConfiguration()

Default constructor.

explicit NetworkConfiguration(const std::string &fileName)

Construct NetworkConfiguration by loading from file.

std::string serialize() const

Serialize to a string.

See also fromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using save.

template<typename ...Args>
inline explicit NetworkConfiguration(Args&&... args)

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing NetworkConfiguration then invoking set(args).

The provided arguments must be descendants of NetworkConfiguration. These types can be provided:

template<typename ...Args>
inline void set(Args&&... args)

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of NetworkConfiguration. These types can be provided:

template<typename ...Args>
inline NetworkConfiguration copyWith(Args&&... args) const

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this NetworkConfiguration object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of NetworkConfiguration. These types can be provided:

inline const IPV4 &ipv4() const

Get IPV4.

inline IPV4 &ipv4()

Get IPV4.

inline NetworkConfiguration &set(const IPV4 &value)

Set IPV4.

inline NetworkConfiguration &set(const IPV4::Address &value)

Set IPV4::Address.

inline NetworkConfiguration &set(const IPV4::Mode &value)

Set IPV4::Mode.

inline NetworkConfiguration &set(const IPV4::SubnetMask &value)

Set IPV4::SubnetMask.

template<typename F>
inline void forEach(const F &f) const

Run the given function on each direct member with the value of the member as parameter.

template<typename F>
inline void forEach(const F &f)

Run the given function on each direct member with the value of the member as parameter.

bool operator==(const NetworkConfiguration &other) const

Equality operator.

bool operator!=(const NetworkConfiguration &other) const

Inequality operator.

std::string toString() const

Get the value as string.

void save(const std::string &fileName) const

Save to the given file.

void load(const std::string &fileName)

Load from the given file.

Public Static Functions

static NetworkConfiguration fromSerialized(const std::string &value)

Construct a new NetworkConfiguration instance from a previously serialized string.

See also serialize.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group

The type of this node.

static constexpr const char *path = {""}

The full path for this value.

static constexpr const char *name = {"NetworkConfiguration"}

The name of this value.

static constexpr const char * description  { R"description(Network configuration of a camera)description" }

The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const NetworkConfiguration &value)

Operator to send the value as string to a stream.

class IPV4

IPv4 network configuration.

Public Functions

IPV4()

Default constructor.

template<typename ...Args>
inline explicit IPV4(Args&&... args)

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing IPV4 then invoking set(args).

The provided arguments must be descendants of IPV4. These types can be provided:

template<typename ...Args>
inline void set(Args&&... args)

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of IPV4. These types can be provided:

template<typename ...Args>
inline IPV4 copyWith(Args&&... args) const

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this IPV4 object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of IPV4. These types can be provided:

inline const Address &address() const

Get Address.

inline Address &address()

Get Address.

inline IPV4 &set(const Address &value)

Set Address.

inline const Mode &mode() const

Get Mode.

inline Mode &mode()

Get Mode.

inline IPV4 &set(const Mode &value)

Set Mode.

inline const SubnetMask &subnetMask() const

Get SubnetMask.

inline SubnetMask &subnetMask()

Get SubnetMask.

inline IPV4 &set(const SubnetMask &value)

Set SubnetMask.

template<typename F>
inline void forEach(const F &f) const

Run the given function on each direct member with the value of the member as parameter.

template<typename F>
inline void forEach(const F &f)

Run the given function on each direct member with the value of the member as parameter.

bool operator==(const IPV4 &other) const

Equality operator.

bool operator!=(const IPV4 &other) const

Inequality operator.

std::string toString() const

Get the value as string.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group

The type of this node.

static constexpr const char *path = {"IPV4"}

The full path for this value.

static constexpr const char *name = {"IPV4"}

The name of this value.

static constexpr const char * description   = { R"description(IPv4 network configuration)description" }

The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const IPV4 &value)

Operator to send the value as string to a stream.

class Address

The camera’s IPv4 address.

Only used in manual mode.

To be able to connect to the camera, the camera’s IP address must be in the same subnet as the IP address of the computer’s local network interface.

Public Types

using ValueType = std::string

The type of the underlying value.

Public Functions

Address() = default

Default constructor.

inline explicit Address(std::string value)

Constructor.

const std::string &value() const

Get the value.

std::string toString() const

Get the value as string.

inline bool operator==(const Address &other) const

Comparison operator.

inline bool operator!=(const Address &other) const

Comparison operator.

inline bool operator<(const Address &other) const

Comparison operator.

inline bool operator>(const Address &other) const

Comparison operator.

inline bool operator<=(const Address &other) const

Comparison operator.

inline bool operator>=(const Address &other) const

Comparison operator.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue

The type of this node.

static constexpr const char *path = {"IPV4/Address"}

The full path for this value.

static constexpr const char *name = {"Address"}

The name of this value.

static constexpr const char * description  {R"description(The camera's IPv4 address. Only used in manual mode.To be able to connect to the camera, the camera's IPaddress must be in the same subnet as the IP addressof the computer's local network interface.)description"}

The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Address &value)

Operator to serialize the value to a stream.

class Mode

DHCP or manual configuration.

Public Types

enum class ValueType

The type of the underlying value.

Values:

enumerator dhcp
enumerator manual

Public Functions

Mode() = default

Default constructor.

inline explicit constexpr Mode(ValueType value)

Constructor.

ValueType value() const

Get the value.

std::string toString() const

Get the value as string.

inline bool operator==(const Mode &other) const

Comparison operator.

inline bool operator!=(const Mode &other) const

Comparison operator.

Public Static Functions

static inline std::set<ValueType> validValues()

All valid values of Mode.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue

The type of this node.

static constexpr const char *path = {"IPV4/Mode"}

The full path for this value.

static constexpr const char *name = {"Mode"}

The name of this value.

static constexpr const char * description   = { R"description(DHCP or manual configuration)description" }

The description for this value.

static const Mode dhcp

dhcp

static const Mode manual

manual

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Mode::ValueType &value)

Operator to serialize ValueType to a stream.

inline friend std::ostream &operator<<(std::ostream &stream, const Mode &value)

Operator to serialize the value to a stream.

class SubnetMask

The camera’s subnet mask (for example 255.255.255.0).

Only used in manual mode.

To be able to connect to the camera, the camera’s subnet mask must be the same as the subnet mask of the computer’s local network interface.

Public Types

using ValueType = std::string

The type of the underlying value.

Public Functions

SubnetMask() = default

Default constructor.

inline explicit SubnetMask(std::string value)

Constructor.

const std::string &value() const

Get the value.

std::string toString() const

Get the value as string.

inline bool operator==(const SubnetMask &other) const

Comparison operator.

inline bool operator!=(const SubnetMask &other) const

Comparison operator.

inline bool operator<(const SubnetMask &other) const

Comparison operator.

inline bool operator>(const SubnetMask &other) const

Comparison operator.

inline bool operator<=(const SubnetMask &other) const

Comparison operator.

inline bool operator>=(const SubnetMask &other) const

Comparison operator.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue

The type of this node.

static constexpr const char *path = {"IPV4/SubnetMask"}

The full path for this value.

static constexpr const char *name = {"SubnetMask"}

The name of this value.

static constexpr const char * description  {R"description(The camera's subnet mask (for example 255.255.255.0). Only used in manual mode.To be able to connect to the camera, the camera's subnet mask must be the same as the subnet mask of thecomputer's local network interface.)description"}

The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const SubnetMask &value)

Operator to serialize the value to a stream.

struct NetworkConfiguration

Network configuration of a camera.

Public Functions

System::String ^ Serialize ()

Serialize to a string.

See also FromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using Save.

void Save (System::String ^ fileName)

Save to the given file.

void Load (System::String ^ fileName)

Load from the given file.

inline NetworkConfiguration()

Constructor.

NetworkConfiguration ^ CopyWith (CopyWithDelegate ^ delegate)

Create a clone (deep copy) of the current instance and invoke delegate on the clone.

Creates a clone (deep copy) of this object, then invokes the delegate function on the clone, and finally returns the clone. This method can be used to create a clone of an instance and then change one or more properties on the clone in one method call. The current instance is unchanged.

NetworkConfiguration ^ Clone ()

Create a clone (deep copy) of the current instance.

System::String ^ ToString () override

Get string representation of the object.

Public Static Attributes

static NetworkConfiguration(System::String ^ fileName) NetworkConfiguration FromSerialized )(System::String ^ value)

Construct NetworkConfiguration by loading from file.

Construct a new NetworkConfiguration instance from a previously serialized string

See also Serialize.

struct IPV4Group

IPv4 network configuration.

Public Types

enum class ModeOption : std::underlying_type<Zivid::NetworkConfiguration::IPV4::Mode::ValueType>::type

DHCP or manual configuration.

Values:

enumerator Dhcp
enumerator Manual

Public Functions

inline IPV4Group()

Constructor.

IPV4Group ^ CopyWith (CopyWithDelegate ^ delegate)

Create a clone (deep copy) of the current instance and invoke delegate on the clone.

Creates a clone (deep copy) of this object, then invokes the delegate function on the clone, and finally returns the clone. This method can be used to create a clone of an instance and then change one or more properties on the clone in one method call. The current instance is unchanged.

IPV4Group ^ Clone ()

Create a clone (deep copy) of the current instance.

System::String ^ ToString () override

Get string representation of the object.

Properties

System::String^ Address

The camera’s IPv4 address.

Only used in manual mode.

To be able to connect to the camera, the camera’s IP address must be in the same subnet as the IP address of the computer’s local network interface.

ModeOption Mode

DHCP or manual configuration.

System::String^ SubnetMask

The camera’s subnet mask (for example 255.255.255.0).

Only used in manual mode.

To be able to connect to the camera, the camera’s subnet mask must be the same as the subnet mask of the computer’s local network interface.

See zivid.NetworkConfiguration in zivid-python.

See also