UOperatingSystemCCTVProgram

#include <OperatingSystemCCTV/Private/Program/OperatingSystemCCTVProgram.h>

class UOperatingSystemCCTVProgram

Defined in OperatingSystemCCTVProgram.h:15

Inherits: UOperatingSystemBaseProgram

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemCCTVProgram["UOperatingSystemCCTVProgram"]
  class UOperatingSystemBaseProgram["UOperatingSystemBaseProgram"]
  UOperatingSystemBaseProgram <|-- UOperatingSystemCCTVProgram

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemCCTVProgram["UOperatingSystemCCTVProgram"]
  class EOperatingSystemCCTV_Layout["EOperatingSystemCCTV_Layout"]
  UOperatingSystemCCTVProgram ..> EOperatingSystemCCTV_Layout
  class EOperatingSystemCCTV_CaptureMethod["EOperatingSystemCCTV_CaptureMethod"]
  UOperatingSystemCCTVProgram ..> EOperatingSystemCCTV_CaptureMethod
  class EOperatingSystemCCTV_CaptureSpeed["EOperatingSystemCCTV_CaptureSpeed"]
  UOperatingSystemCCTVProgram ..> EOperatingSystemCCTV_CaptureSpeed
  class UOperatingSystemBaseProgram["UOperatingSystemBaseProgram"]
  UOperatingSystemCCTVProgram *-- UOperatingSystemBaseProgram
  class UOperatingSystemCCTVProgramData["UOperatingSystemCCTVProgramData"]
  UOperatingSystemCCTVProgram *-- UOperatingSystemCCTVProgramData

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemCCTVProgram {
    +OnLayoutChanged : FOnOperatingSystemCCTVLayoutChanged()
    +UOperatingSystemCCTVProgram()
    +SetLayout(const EOperatingSystemCCTV_Layout NewLayout bool()
    +SetCaptureMethod(const EOperatingSystemCCTV_CaptureMethod Va bool()
    +SetCaptureSpeed(const EOperatingSystemCCTV_CaptureSpeed Val bool()
    +SetSelectedCamera(AOperatingSystemCCTVActor *TargetCCTV) cons void()
    +GetCurrentLayout() const EOperatingSystemCCTV_Layout()
    +GetAllCCTV_Actors(TArray< AOperatingSystemCCTVActor * > &OutC void()
    +CaptureNow() const void()
    +SetCaptureTime(const float &Time) void()
    +GetCaptureTime() const float()
    +GetCaptureMethod() const EOperatingSystemCCTV_CaptureMethod()
    +GetCaptureSpeed() const EOperatingSystemCCTV_CaptureSpeed()
    +OnValidate(FGenericError &OutError) const override void()
    +OnStart(FGenericError &OutError) override void()
    +InitialLayout : EOperatingSystemCCTV_Layout()
    +CaptureMethod : EOperatingSystemCCTV_CaptureMethod()
    +CaptureSpeed : EOperatingSystemCCTV_CaptureSpeed()
    +CaptureTime : float()
    +CCTVData : TWeakObjectPtr()< UOperatingSystemCCTVPr
  }

Public Attributes

Return	Name	Description
`FOnOperatingSystemCCTVLayoutChanged`	`OnLayoutChanged`

OnLayoutChanged

FOnOperatingSystemCCTVLayoutChanged OnLayoutChanged

Defined in OperatingSystemCCTVProgram.h:45

Referenced by

SetLayout

Public Methods

Return	Name	Description
	`UOperatingSystemCCTVProgram`
`bool`	`SetLayout` `const`
`bool`	`SetCaptureMethod` `const`
`bool`	`SetCaptureSpeed` `const`
`void`	`SetSelectedCamera` `const`
`EOperatingSystemCCTV_Layout`	`GetCurrentLayout` `const`
`void`	`GetAllCCTV_Actors` `const`
`void`	`CaptureNow` `const`
`void`	`SetCaptureTime` `inline`
`float`	`GetCaptureTime` `const` `inline`
`EOperatingSystemCCTV_CaptureMethod`	`GetCaptureMethod` `const` `inline`
`EOperatingSystemCCTV_CaptureSpeed`	`GetCaptureSpeed` `const` `inline`

UOperatingSystemCCTVProgram

UOperatingSystemCCTVProgram()

Defined in OperatingSystemCCTVProgram.h:47

References

SetLayout

const

bool SetLayout(constEOperatingSystemCCTV_Layout NewLayout) const

Defined in OperatingSystemCCTVProgram.h:50

Referenced by

OnStart

References

CCTVData
GetSettings
OnLayoutChanged

SetCaptureMethod

const

bool SetCaptureMethod(constEOperatingSystemCCTV_CaptureMethod Value) const

Defined in OperatingSystemCCTVProgram.h:53

References

SetCaptureSpeed

const

bool SetCaptureSpeed(constEOperatingSystemCCTV_CaptureSpeed Value) const

Defined in OperatingSystemCCTVProgram.h:56

References

SetSelectedCamera

const

void SetSelectedCamera(AOperatingSystemCCTVActor * TargetCCTV) const

Defined in OperatingSystemCCTVProgram.h:59

References

GetCurrentLayout

const

EOperatingSystemCCTV_Layout GetCurrentLayout() const

Defined in OperatingSystemCCTVProgram.h:62

References

GetAllCCTV_Actors

const

void GetAllCCTV_Actors(TArray< AOperatingSystemCCTVActor * > & OutCctvActors) const

Defined in OperatingSystemCCTVProgram.h:65

References

CaptureNow

const

void CaptureNow() const

Defined in OperatingSystemCCTVProgram.h:68

References

SetCaptureTime

inline

inline void SetCaptureTime(constfloat & Time)

Defined in OperatingSystemCCTVProgram.h:77

GetCaptureTime

const inline

inline float GetCaptureTime() const

Defined in OperatingSystemCCTVProgram.h:78

GetCaptureMethod

const inline

inline EOperatingSystemCCTV_CaptureMethod GetCaptureMethod() const

Defined in OperatingSystemCCTVProgram.h:80

GetCaptureSpeed

const inline

inline EOperatingSystemCCTV_CaptureSpeed GetCaptureSpeed() const

Defined in OperatingSystemCCTVProgram.h:81

Protected Methods

Return	Name	Description
`void`	`OnValidate` `virtual` `const` `override`	OnValidate method for validating program-specific logic.
`void`	`OnStart` `virtual` `override`	Called when the program starts. It should be overridden in derived classes to provide the necessary functionality for the specific program.

OnValidate

virtual const override

virtual void OnValidate(FGenericError & OutError) const override

Defined in OperatingSystemCCTVProgram.h:72 OnValidate method for validating program-specific logic.

This method is a virtual function that can be overridden by derived classes to perform additional validation specific to the program’s requirements. The method takes an FGenericError& parameter, which can be used to report any validation errors encountered during the validation process.

Parameters

OutError The error object used to report any validation errors.

See also: FGenericError

References

DataClass
GetSettings
MAKE_ERROR

Reimplements

OnValidate

OnStart

virtual override

virtual void OnStart(FGenericError & OutError) override

Defined in OperatingSystemCCTVProgram.h:73 Called when the program starts. It should be overridden in derived classes to provide the necessary functionality for the specific program.

Parameters

OutError A reference to the FGenericError object, used to report any errors that occur during startup.

See also: FGenericError

References

Reimplements

OnStart

Private Attributes

Return	Name	Description
`EOperatingSystemCCTV_Layout`	`InitialLayout`	Starting layout.
`EOperatingSystemCCTV_CaptureMethod`	`CaptureMethod`	Determines the capture method. If manual is selected, you have to manually keep enabling Capture Now in CCTV program data. Time-Based will run based on seconds. Example: If 60, every 60 seconds CCTV will capture. Frame-Based (recommended) will run every given frame. Example: If 30 is selected, every 30 frames CCTV will capture.
`EOperatingSystemCCTV_CaptureSpeed`	`CaptureSpeed`	For frame-based method, target number of frames to capture
`float`	`CaptureTime`	If 0, then capture every frame. If greater than 0 then capture every given seconds.
`TWeakObjectPtr< UOperatingSystemCCTVProgramData >`	`CCTVData`

InitialLayout

EOperatingSystemCCTV_Layout InitialLayout

Defined in OperatingSystemCCTVProgram.h:21 Starting layout.

Referenced by

OnStart

CaptureMethod

EOperatingSystemCCTV_CaptureMethod CaptureMethod

Defined in OperatingSystemCCTVProgram.h:29 Determines the capture method. If manual is selected, you have to manually keep enabling Capture Now in CCTV program data. Time-Based will run based on seconds. Example: If 60, every 60 seconds CCTV will capture. Frame-Based (recommended) will run every given frame. Example: If 30 is selected, every 30 frames CCTV will capture.

CaptureSpeed

EOperatingSystemCCTV_CaptureSpeed CaptureSpeed

Defined in OperatingSystemCCTVProgram.h:33 For frame-based method, target number of frames to capture

CaptureTime

float CaptureTime

Defined in OperatingSystemCCTVProgram.h:37 If 0, then capture every frame. If greater than 0 then capture every given seconds.

CCTVData

TWeakObjectPtr< UOperatingSystemCCTVProgramData > CCTVData

Defined in OperatingSystemCCTVProgram.h:40