GoPxL SDK

- Home
- Files
- Namespace

Classes | Typedefs | Enumerations | Functions | Variables
GoPxLSdk Namespace Reference

## Classes
struct | CommonAttributes
struct | DiscoveryBroadcastHeader
struct | DiscoveryServerHeader
class | GoChannelError
class | GoCtrlChannel
| Interface for all control channel implementations. More...
class | GoCtrlChannelV1
class | GoDataSet
class | GoDiscoveryClient
class | GoGdpBoundingBox
class | GoGdpClient
class | GoGdpFeatureCircle
class | GoGdpFeatureLine
class | GoGdpFeaturePlane
class | GoGdpFeaturePoint
class | GoGdpImage
class | GoGdpMeasurement
class | GoGdpMesh
class | GoGdpMsg
class | GoGdpNull
class | GoGdpPixelFormat
class | GoGdpProfileBase
class | GoGdpProfilePointCloud
class | GoGdpProfileUniform
class | GoGdpRendering
class | GoGdpSignal
class | GoGdpSpots
class | GoGdpStamp
class | GoGdpSurfaceBase
class | GoGdpSurfacePointCloud
class | GoGdpSurfaceUniform
class | GoGdpTransform
class | GoGraphics
class | GoInstance
class | GoJson
| Simplify working with json data. More...
class | GoJsonError
class | GoJsonIterator
| Represents json iterator. More...
class | GoJsonPointer
| Represents json pointer as described in Section 3 of RFC6901. More...
struct | GoLabel
class | GoNotificationResponse
| Represents a response to change notifications. More...
class | GoNotificationType
struct | GoPlane
struct | GoPosition
struct | GoProfileRegion2d
struct | GoRay
struct | GoRegion
struct | GoRegion3d
class | GoRequest
class | GoRequestError
class | GoRequestMethod
class | GoRequestResponse
| Represents a response to requests such as Read/Update. More...
class | GoResponse
class | GoResponseType
class | GoRestClient
class | GoStreamResponse
| Represents streamed data. More...
struct | GoSurfaceRegion2d
class | GoSystem
| Represents a single Gocator system. More...
class | GoTransaction
class | GoUri
struct | MeshMsgChannel

## Typedefs
using | Byte = kByte
using | ByteArray = std::vector< Byte >
using | GoCtrlChannelErrorHandler = std::function< void(GoCtrlChannelErrorType type, k64u id, const std::exception &e)>
| Function to receive read / write thread errors. More...
using | GoCtrlChannelResponseHandler = std::function< void(const std::shared_ptr< GoResponse > response)>
| Function to receive responses from the server asynchronously. More...
using | GoNotificationHandler = std::function< void(const std::shared_ptr< GoNotificationResponse > &)>
| Notification handler used in GoRestClient::Sub. More...
using | GoStreamHandler = std::function< void(const std::shared_ptr< GoStreamResponse > &)>
| Data handler used in GoRestClient::StartStream. More...
using | ResourcePath = std::string
using | SerialNum = std::string

## Enumerations
enum | Channel_ID { ID_Vertex, ID_Facet, ID_Facet_normal, ID_Vertex_normal, ID_Vertex_texture, ID_Vertex_curvature }
enum | Channel_State { Error, Unallocated, Allocated, Empty, Partial_used, Full }
enum | Channel_Type { Type_Invalid, Type_Vertex, Type_Facet, Type_Facet_normal, Type_Vertex_normal, Type_Vertex_texture, Type_Vertex_curvature }
enum | GoCtrlChannelErrorType : uint8_t { GoCtrlChannelErrorType::Read, GoCtrlChannelErrorType::Write }
enum | MessageType : k16u { MessageType::SIGNAL, MessageType::NULL_TYPE, MessageType::STAMP, MessageType::UNIFORM_PROFILE, MessageType::PROFILE_POINT_CLOUD, MessageType::UNIFORM_SURFACE, MessageType::SURFACE_POINT_CLOUD, MessageType::IMAGE, MessageType::SPOTS, MessageType::MESH, MessageType::MEASUREMENT, MessageType::RENDERING, MessageType::POINT_FEATURE, MessageType::LINE_FEATURE, MessageType::PLANE_FEATURE, MessageType::CIRCLE_FEATURE, MessageType::HEALTH }
| List of enums representing types available to be serialized out through GDP This list is essentially the same as GoCore::MessageType. More...
enum | RegionType : k8u { Profile_Region_2d, Region_3d, Surface_Region_2d }

## Functions
const kChar * | ApiVersion ()
| Returns the SDK REST API version as string. More...
const kChar * | BuildVersion ()
| Returns the SDK build version as a string. More...
kVersion | BuildVersionNumber ()
| Returns the SDK build version as a 32-bit number in the format: MMmmRRBB where: MM = major number mm = minor number RR = release number BB = build number. More...

## Variables
const kSSize | CLIENT_BUFFER_SIZE
const kSSize | CLIENT_SOCKET_SIZE
constexpr k64u | DEFAULT_TRANSACTION_TIMEOUT_MSEC
const k64u | GOPXL_BROADCAST_SIGNATURE
const std::string | GOPXL_DISCOVERY_ADDRESS
const std::string | GOPXL_DISCOVERY_ADDRESS_CONFLICT
const std::string | GOPXL_DISCOVERY_APP_ID
const std::string | GOPXL_DISCOVERY_APP_NAME
const std::string | GOPXL_DISCOVERY_APP_VERSION
const std::string | GOPXL_DISCOVERY_CONTROL_PORT
const std::string | GOPXL_DISCOVERY_DEVICE_MODEL
const std::string | GOPXL_DISCOVERY_DHCP
const std::string | GOPXL_DISCOVERY_GATEWAY
const std::string | GOPXL_DISCOVERY_GDP_PORT
const std::string | GOPXL_DISCOVERY_IS_REMOTE
const std::string | GOPXL_DISCOVERY_MASK
const k64u | GOPXL_DISCOVERY_MESSAGE_ANNOUNCE
const k64u | GOPXL_DISCOVERY_MESSAGE_DISCOVER
const std::string | GOPXL_DISCOVERY_SERIAL_NUMBER
const std::string | GOPXL_DISCOVERY_WEB_PORT
const k32u | GOPXL_RESERVED_PORT_DISCOVERY_PROTOCOL
constexpr k16u | JSON_MESSAGE_TYPE
const kSize | MAX_MESSAGE_SIZE
constexpr k16u | MSGPACK_MESSAGE_TYPE
const k64f | SCALE_FACTOR_MM_TO_NM