Namespace Spinnaker::GenApi

Namespace List > Spinnaker > GenApi

Classes

Type	Name
struct	AttachStatistics_t Delivers information about the attached chunks and nodes.
class	AutoLock
class	AutoPollController Auto polling controller for NodeMap .
class	BooleanNode Interface for string properties.
class	CChunkAdapter Connects a chunked buffer to a node map.
class	CChunkAdapterDcam Connects a chunked DCAM buffer to a node map.
class	CChunkAdapterGEV Connects a chunked DCAM buffer to a node map.
class	CChunkAdapterGeneric
class	CChunkAdapterU3V Connects a chunked U3V buffer to a node map.
class	CChunkPort Port attachable to a chunk in a buffer.
class	CEnumerationTRef <class EnumT> Interface for string properties.
class	CEventAdapter Delivers Events to ports.
class	CEventAdapter1394 Distribute the events to the node map.
class	CEventAdapterGEV Connects a GigE Event to a node map.
class	CEventAdapterGeneric Connects a generic event to a node map.
class	CEventAdapterU3V Connects a U3V Event to a node map.
class	CEventPort Port attachable to an event.
class	CFeatureBag Bag holding streamable features of a nodetree.
class	CFloatPtr
class	CLock A lock class.
class	CLockEx
class	CNodeCallback callback body instance for INode pointers
class	CNodeMapFactory The node map factory is used for creating node maps from camera description files. See the following for some examples. __
class	CPointer <class T, class B> Encapsulates a GenApi pointer dealing with the dynamic_cast automatically.
class	CPortImpl Standard implementation for a port.
class	CPortWriteList
class	CRegisterPortImpl Standard implementation for a port using a register based transport layer.
class	CSelectorSet
class	CTestPortStruct <class CDataStruct>
class	CategoryNode Interface for string properties.
class	CommandNode Interface for string properties.
class	Counter Definition of a simple Counter class.
struct	DCAM_CHECKSUM
struct	DCAM_CHUNK_TRAILER
class	EAccessModeClass Holds conversion methods for the access mode enumeration.
class	ECachingModeClass Holds conversion methods for the caching mode enumeration.
class	EDisplayNotationClass Holds conversion methods for the notation type of floats.
class	EEndianessClass Holds conversion methods for the endianess enumeration.
class	EGenApiSchemaVersionClass helper class converting EGenApiSchemaVersion from and to string
class	EInputDirectionClass Holds conversion methods for the notation type of floats.
class	ENameSpaceClass Holds conversion methods for the namespace enumeration.
class	ERepresentationClass Holds conversion methods for the representation enumeration.
class	ESignClass Holds conversion methods for the sign enumeration.
class	ESlopeClass Holds conversion methods for the converter formulas.
class	EStandardNameSpaceClass Holds conversion methods for the standard namespace enumeration.
class	EVisibilityClass Holds conversion methods for the visibility enumeration.
class	EYesNoClass Holds conversion methods for the standard namespace enumeration.
class	EnumEntryNode Interface for string properties.
class	EnumNode Interface for string properties.
class	FileProtocolAdapter Adapter between the std::iostreambuf and the SFNC Features representing the device file system.
class	FloatNode Interface for string properties.
class	FloatRegNode Interface for string properties.
class	Function_NodeCallback <class Function> Container for a function pointer.
struct	GVCP_CHUNK_TRAILER header of a GVCP request packet
struct	GVCP_EVENTDATA_REQUEST Layout of a GVCP event data request packet (Extended ID flag not set)
struct	GVCP_EVENTDATA_REQUEST_EXTENDED_ID Layout of a GVCP event data request packet (Extended ID flag set)
struct	GVCP_EVENT_ITEM layout of a GVCP event item (Extended ID flag not set)
struct	GVCP_EVENT_ITEM_BASIC layout of a GVCP event item (common to all types)
struct	GVCP_EVENT_ITEM_EXTENDED_ID layout of a GVCP event item (Extended ID flag set)
struct	GVCP_EVENT_REQUEST Layout of a GVCP event request packet (Extended ID flag not set)
struct	GVCP_EVENT_REQUEST_EXTENDED_ID Layout of a GVCP event request packet (Extended ID flag set)
struct	GVCP_REQUEST_HEADER header of a GVCP request packet
class	IDevFileStreamBase <typename CharType, typename Traits>
class	IDevFileStreamBuf <typename CharType, typename Traits>
class	IntRegNode Interface for string properties.
class	IntegerNode Interface for string properties.
class	Member_NodeCallback <class Client, class Member> Container for a member function pointer.
class	Node class common to all nodes
class	NodeMap Smart pointer template for NodeMaps with create function.
class	ODevFileStreamBase <typename CharType, typename Traits>
class	ODevFileStreamBuf <typename CharType, typename Traits>
class	PortNode Interface for value properties.
class	PortRecorder Interface for recording write commands on a port.
class	PortReplay Interface for replaying write commands on a port.
class	RegisterNode Interface for string properties.
struct	SingleChunkDataStr_t
struct	SingleChunkData_t
class	SpinTestCamera
class	StringNode Interface for string properties.
class	StringRegNode Interface for string properties.
struct	U3V_CHUNK_TRAILER header of a GVCP request packet
struct	U3V_COMMAND_HEADER U3V/GenCP command header.
struct	U3V_EVENT_DATA U3V/GenCP EVENT_CMD specific command data.
struct	U3V_EVENT_MESSAGE Entire event data message (without the variable-sized data field)
class	ValueNode Interface for value properties.
class	double_autovector_t Vector of doubles with reference counting.
class	int64_autovector_t Vector of integers with reference counting.

Public Types

Type	Name
typedef struct Spinnaker::GenApi::AttachStatistics_t	AttachStatistics_t Delivers information about the attached chunks and nodes.
typedef struct Spinnaker::GenApi::DCAM_CHECKSUM	DCAM_CHECKSUM
typedef struct Spinnaker::GenApi::DCAM_CHUNK_TRAILER	DCAM_CHUNK_TRAILER
typedef struct Spinnaker::GenApi::GVCP_CHUNK_TRAILER	GVCP_CHUNK_TRAILER header of a GVCP request packet
typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENTDATA_REQUEST	GVCP_EVENTDATA_REQUEST Layout of a GVCP event data request packet (Extended ID flag not set)
typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENTDATA_REQUEST_EXTENDED_ID	GVCP_EVENTDATA_REQUEST_EXTENDED_ID Layout of a GVCP event data request packet (Extended ID flag set)
typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENT_ITEM	GVCP_EVENT_ITEM layout of a GVCP event item (Extended ID flag not set)
typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENT_ITEM_BASIC	GVCP_EVENT_ITEM_BASIC layout of a GVCP event item (common to all types)
typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENT_ITEM_EXTENDED_ID	GVCP_EVENT_ITEM_EXTENDED_ID layout of a GVCP event item (Extended ID flag set)
typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENT_REQUEST	GVCP_EVENT_REQUEST Layout of a GVCP event request packet (Extended ID flag not set)
typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENT_REQUEST_EXTENDED_ID	GVCP_EVENT_REQUEST_EXTENDED_ID Layout of a GVCP event request packet (Extended ID flag set)
enum	GVCP_MESSAGE_TAGS
typedef enum Spinnaker::GenApi::GVCP_MESSAGE_TAGS	GVCP_MESSAGE_TAGS
typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_REQUEST_HEADER	GVCP_REQUEST_HEADER header of a GVCP request packet
typedef IDevFileStreamBase< char, std::char_traits< char > >	IDevFileStream
typedef ODevFileStreamBase< char, std::char_traits< char > >	ODevFileStream
typedef struct Spinnaker::GenApi::SingleChunkDataStr_t	SingleChunkDataStr_t
typedef struct Spinnaker::GenApi::SingleChunkData_t	SingleChunkData_t
typedef struct Spinnaker::GenApi::U3V_CHUNK_TRAILER	U3V_CHUNK_TRAILER header of a GVCP request packet
typedef struct PACK_STRUCT Spinnaker::GenApi::U3V_COMMAND_HEADER	U3V_COMMAND_HEADER U3V/GenCP command header.
typedef struct PACK_STRUCT Spinnaker::GenApi::U3V_EVENT_DATA	U3V_EVENT_DATA U3V/GenCP EVENT_CMD specific command data.
typedef struct PACK_STRUCT Spinnaker::GenApi::U3V_EVENT_MESSAGE	U3V_EVENT_MESSAGE Entire event data message (without the variable-sized data field)

Public Attributes

Type	Name
const uint8_t	COMMAND_MAGIC = 0x42
const size_t	GENCP_COMMAND_HEADER_SIZE = [**sizeof**](group___i_enumeration_t__h.md#variable-ienumerationt)([**U3V\_COMMAND\_HEADER**](struct_spinnaker_1_1_gen_api_1_1_u3_v___c_o_m_m_a_n_d___h_e_a_d_e_r.md))
const size_t	GENCP_EVENT_BASIC_SIZE = [**sizeof**](group___i_enumeration_t__h.md#variable-ienumerationt)([**U3V\_EVENT\_MESSAGE**](struct_spinnaker_1_1_gen_api_1_1_u3_v___e_v_e_n_t___m_e_s_s_a_g_e.md))
const uint16_t	GENCP_EVENT_CMD_ID = 0x0C00
interface SPINNAKER_API_ABSTRACT	IPersistScript = /* multi line expression */ Basic interface to persist values to.
const uint32_t	U3V_EVENT_PREFIX = 0x45563355

Public Functions

Type	Name
virtual void	PersistFeature (IValue & item) = 0
void SPINNAKER_API	SET_GUID (SPIN_GUID & name, uint32_t l, uint16_t w1, uint16_t w2, uint8_t b1, uint8_t b2, uint8_t b3, uint8_t b4, uint8_t b5, uint8_t b6, uint8_t b7, uint8_t b8)

Public Types Documentation

typedef AttachStatistics_t

Delivers information about the attached chunks and nodes.

typedef struct Spinnaker::GenApi::AttachStatistics_t Spinnaker::GenApi::AttachStatistics_t;

---

typedef DCAM_CHECKSUM

typedef struct Spinnaker::GenApi::DCAM_CHECKSUM Spinnaker::GenApi::DCAM_CHECKSUM;

---

typedef DCAM_CHUNK_TRAILER

typedef struct Spinnaker::GenApi::DCAM_CHUNK_TRAILER Spinnaker::GenApi::DCAM_CHUNK_TRAILER;

---

typedef GVCP_CHUNK_TRAILER

header of a GVCP request packet

typedef struct Spinnaker::GenApi::GVCP_CHUNK_TRAILER Spinnaker::GenApi::GVCP_CHUNK_TRAILER;

---

typedef GVCP_EVENTDATA_REQUEST

Layout of a GVCP event data request packet (Extended ID flag not set)

typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENTDATA_REQUEST Spinnaker::GenApi::GVCP_EVENTDATA_REQUEST;

---

typedef GVCP_EVENTDATA_REQUEST_EXTENDED_ID

Layout of a GVCP event data request packet (Extended ID flag set)

typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENTDATA_REQUEST_EXTENDED_ID Spinnaker::GenApi::GVCP_EVENTDATA_REQUEST_EXTENDED_ID;

---

typedef GVCP_EVENT_ITEM

layout of a GVCP event item (Extended ID flag not set)

typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENT_ITEM Spinnaker::GenApi::GVCP_EVENT_ITEM;

---

typedef GVCP_EVENT_ITEM_BASIC

layout of a GVCP event item (common to all types)

typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENT_ITEM_BASIC Spinnaker::GenApi::GVCP_EVENT_ITEM_BASIC;

---

typedef GVCP_EVENT_ITEM_EXTENDED_ID

layout of a GVCP event item (Extended ID flag set)

typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENT_ITEM_EXTENDED_ID Spinnaker::GenApi::GVCP_EVENT_ITEM_EXTENDED_ID;

---

typedef GVCP_EVENT_REQUEST

Layout of a GVCP event request packet (Extended ID flag not set)

typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENT_REQUEST Spinnaker::GenApi::GVCP_EVENT_REQUEST;

---

typedef GVCP_EVENT_REQUEST_EXTENDED_ID

Layout of a GVCP event request packet (Extended ID flag set)

typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_EVENT_REQUEST_EXTENDED_ID Spinnaker::GenApi::GVCP_EVENT_REQUEST_EXTENDED_ID;

---

enum GVCP_MESSAGE_TAGS

enum Spinnaker::GenApi::GVCP_MESSAGE_TAGS {
    TAG_EVENT_CMD = 0xc0,
    TAG_EVENTDATA_CMD = 0xc2
};

---

typedef GVCP_MESSAGE_TAGS

typedef enum Spinnaker::GenApi::GVCP_MESSAGE_TAGS Spinnaker::GenApi::GVCP_MESSAGE_TAGS;

---

typedef GVCP_REQUEST_HEADER

header of a GVCP request packet

typedef struct PACK_STRUCT Spinnaker::GenApi::GVCP_REQUEST_HEADER Spinnaker::GenApi::GVCP_REQUEST_HEADER;

---

typedef IDevFileStream

typedef IDevFileStreamBase<char, std::char_traits<char> > Spinnaker::GenApi::IDevFileStream;

---

typedef ODevFileStream

typedef ODevFileStreamBase<char, std::char_traits<char> > Spinnaker::GenApi::ODevFileStream;

---

typedef SingleChunkDataStr_t

typedef struct Spinnaker::GenApi::SingleChunkDataStr_t Spinnaker::GenApi::SingleChunkDataStr_t;

---

typedef SingleChunkData_t

typedef struct Spinnaker::GenApi::SingleChunkData_t Spinnaker::GenApi::SingleChunkData_t;

---

typedef U3V_CHUNK_TRAILER

header of a GVCP request packet

typedef struct Spinnaker::GenApi::U3V_CHUNK_TRAILER Spinnaker::GenApi::U3V_CHUNK_TRAILER;

---

typedef U3V_COMMAND_HEADER

U3V/GenCP command header.

typedef struct PACK_STRUCT Spinnaker::GenApi::U3V_COMMAND_HEADER Spinnaker::GenApi::U3V_COMMAND_HEADER;

---

typedef U3V_EVENT_DATA

U3V/GenCP EVENT_CMD specific command data.

typedef struct PACK_STRUCT Spinnaker::GenApi::U3V_EVENT_DATA Spinnaker::GenApi::U3V_EVENT_DATA;

---

typedef U3V_EVENT_MESSAGE

Entire event data message (without the variable-sized data field)

typedef struct PACK_STRUCT Spinnaker::GenApi::U3V_EVENT_MESSAGE Spinnaker::GenApi::U3V_EVENT_MESSAGE;

---

Public Attributes Documentation

variable COMMAND_MAGIC

const uint8_t Spinnaker::GenApi::COMMAND_MAGIC;

---

variable GENCP_COMMAND_HEADER_SIZE

const size_t Spinnaker::GenApi::GENCP_COMMAND_HEADER_SIZE;

---

variable GENCP_EVENT_BASIC_SIZE

const size_t Spinnaker::GenApi::GENCP_EVENT_BASIC_SIZE;

---

variable GENCP_EVENT_CMD_ID

const uint16_t Spinnaker::GenApi::GENCP_EVENT_CMD_ID;

---

variable IPersistScript

Basic interface to persist values to.

interface SPINNAKER_API_ABSTRACT Spinnaker::GenApi::IPersistScript;

---

variable U3V_EVENT_PREFIX

const uint32_t Spinnaker::GenApi::U3V_EVENT_PREFIX;

---

Public Functions Documentation

function PersistFeature

virtual void Spinnaker::GenApi::PersistFeature (
    IValue & item
) = 0

Stores a feature

---

function SET_GUID

void  SPINNAKER_API Spinnaker::GenApi::SET_GUID (
    SPIN_GUID & name,
    uint32_t l,
    uint16_t w1,
    uint16_t w2,
    uint8_t b1,
    uint8_t b2,
    uint8_t b3,
    uint8_t b4,
    uint8_t b5,
    uint8_t b6,
    uint8_t b7,
    uint8_t b8
) 

---

---

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